-
Notifications
You must be signed in to change notification settings - Fork 15.4k
MINOR: improve QuorumController logging #13540
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
cmccabe
wants to merge
3
commits into
apache:trunk
from
cmccabe:cmccabe_2023-04-11_improve_controller_logging
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 63 additions & 0 deletions
63
metadata/src/main/java/org/apache/kafka/metadata/util/RecordRedactor.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.kafka.metadata.util; | ||
|
|
||
| import org.apache.kafka.common.metadata.ConfigRecord; | ||
| import org.apache.kafka.common.metadata.MetadataRecordType; | ||
| import org.apache.kafka.common.metadata.UserScramCredentialRecord; | ||
| import org.apache.kafka.common.protocol.ApiMessage; | ||
| import org.apache.kafka.metadata.KafkaConfigSchema; | ||
|
|
||
|
|
||
| /** | ||
| * Converts a metadata record to a string suitable for logging to slf4j. | ||
| * This means that passwords and key material are omitted from the output. | ||
| */ | ||
| public final class RecordRedactor { | ||
| private final KafkaConfigSchema configSchema; | ||
|
|
||
| public RecordRedactor(KafkaConfigSchema configSchema) { | ||
| this.configSchema = configSchema; | ||
| } | ||
|
|
||
| public String toLoggableString(ApiMessage message) { | ||
| MetadataRecordType type = MetadataRecordType.fromId(message.apiKey()); | ||
| switch (type) { | ||
| case CONFIG_RECORD: { | ||
| if (!configSchema.isSensitive((ConfigRecord) message)) { | ||
| return message.toString(); | ||
| } | ||
| ConfigRecord duplicate = ((ConfigRecord) message).duplicate(); | ||
| duplicate.setValue("(redacted)"); | ||
| return duplicate.toString(); | ||
| } | ||
| case USER_SCRAM_CREDENTIAL_RECORD: { | ||
| UserScramCredentialRecord record = (UserScramCredentialRecord) message; | ||
| return "UserScramCredentialRecord(" | ||
| + "name=" + record.name() | ||
| + ", mechanism=" + record.mechanism() | ||
| + ", salt=(redacted)" | ||
| + ", saltedPassword=(redacted)" | ||
| + ", iterations=" + record.iterations() | ||
| + ")"; | ||
| } | ||
| default: | ||
| return message.toString(); | ||
| } | ||
| } | ||
| } | ||
60 changes: 0 additions & 60 deletions
60
metadata/src/main/java/org/apache/kafka/metadata/util/SnapshotReason.java
This file was deleted.
Oops, something went wrong.
92 changes: 92 additions & 0 deletions
92
metadata/src/test/java/org/apache/kafka/metadata/util/RecordRedactorTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.kafka.metadata.util; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.apache.kafka.common.Uuid; | ||
| import org.apache.kafka.common.config.ConfigDef; | ||
| import org.apache.kafka.common.config.ConfigResource; | ||
| import org.apache.kafka.common.metadata.ConfigRecord; | ||
| import org.apache.kafka.common.metadata.TopicRecord; | ||
| import org.apache.kafka.common.metadata.UserScramCredentialRecord; | ||
| import org.apache.kafka.metadata.KafkaConfigSchema; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.apache.kafka.common.config.ConfigResource.Type.BROKER; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
|
|
||
| final public class RecordRedactorTest { | ||
| public static final Map<ConfigResource.Type, ConfigDef> CONFIGS = new HashMap<>(); | ||
|
|
||
| static { | ||
| CONFIGS.put(BROKER, new ConfigDef(). | ||
| define("foobar", ConfigDef.Type.LIST, "1", ConfigDef.Importance.HIGH, "foo bar doc"). | ||
| define("quux", ConfigDef.Type.PASSWORD, ConfigDef.Importance.HIGH, "quuux2 doc")); | ||
| } | ||
|
|
||
| private static final KafkaConfigSchema SCHEMA = new KafkaConfigSchema(CONFIGS, Collections.emptyMap()); | ||
|
|
||
| private static final RecordRedactor REDACTOR = new RecordRedactor(SCHEMA); | ||
|
|
||
| @Test | ||
| public void testTopicRecordToString() { | ||
| assertEquals("TopicRecord(name='foo', topicId=UOovKkohSU6AGdYW33ZUNg)", | ||
| REDACTOR.toLoggableString(new TopicRecord(). | ||
| setTopicId(Uuid.fromString("UOovKkohSU6AGdYW33ZUNg")). | ||
| setName("foo"))); | ||
| } | ||
|
|
||
| @Test | ||
| public void testUserScramCredentialRecordToString() { | ||
| assertEquals("UserScramCredentialRecord(name=bob, mechanism=0, " + | ||
| "salt=(redacted), serverKey=(redacted), storedKey=(redacted), iterations=128)", | ||
| REDACTOR.toLoggableString(new UserScramCredentialRecord(). | ||
| setName("bob"). | ||
| setMechanism((byte) 0). | ||
| setSalt(new byte[512]). | ||
| setServerKey(new byte[128]). | ||
| setStoredKey(new byte[128]). | ||
| setIterations(128))); | ||
| } | ||
|
|
||
| @Test | ||
| public void testSensitiveConfigRecordToString() { | ||
| assertEquals("ConfigRecord(resourceType=4, resourceName='0', name='quux', " + | ||
| "value='(redacted)')", | ||
| REDACTOR.toLoggableString(new ConfigRecord(). | ||
| setResourceType(BROKER.id()). | ||
| setResourceName("0"). | ||
| setName("quux"). | ||
| setValue("mysecret"))); | ||
| } | ||
|
|
||
| @Test | ||
| public void testNonSensitiveConfigRecordToString() { | ||
| assertEquals("ConfigRecord(resourceType=4, resourceName='0', name='foobar', " + | ||
| "value='item1,item2')", | ||
| REDACTOR.toLoggableString(new ConfigRecord(). | ||
| setResourceType(BROKER.id()). | ||
| setResourceName("0"). | ||
| setName("foobar"). | ||
| setValue("item1,item2"))); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice. We can make use of this in KRaftMigrationDriver when we log the migrated records (in a separate PR)