Skip to content

HDDS-7869. Log configuration on component startup. #4271

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.

Sign up for GitHub

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

Merged
errose28 merged 8 commits into from
Mar 1, 2023
Merged

HDDS-7869. Log configuration on component startup. #4271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
58d7db2
HDDS-7869. Log configuration on component startup.
Feb 13, 2023
286734e
HDDS-7869. Printing all configs. Added utility function to process an…
Feb 16, 2023
d362e5d
HDDS-7869. Fixed checkstyle. Removed unused import.
Feb 16, 2023
ab57e03
HDDS-7869. Fixed variable name and whitespace checkstyle errors.
Feb 16, 2023
96167b6
HDDS-7869. Fixed checkstyle errors. Removed redundant import and fixe…
Feb 17, 2023
e2b0e6c
HDDS-7869. Filtered Ozone configs only.
Feb 28, 2023
316c812
Fix findbugs
adoroszlai Feb 28, 2023
f5accde
Trim config values
adoroszlai Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/HddsUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,16 @@
import java.util.Map;
import java.util.Optional;
import java.util.OptionalInt;
import java.util.TreeMap;

import org.apache.hadoop.conf.ConfigRedactor;
import org.apache.hadoop.fs.CommonConfigurationKeysPublic;
import org.apache.hadoop.hdds.annotation.InterfaceAudience;
import org.apache.hadoop.hdds.annotation.InterfaceStability;
import org.apache.hadoop.hdds.client.BlockID;
import org.apache.hadoop.hdds.conf.ConfigurationException;
import org.apache.hadoop.hdds.conf.ConfigurationSource;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos;
import org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos.ContainerCommandRequestProtoOrBuilder;
import org.apache.hadoop.hdds.protocol.datanode.proto.ContainerProtos.ContainerDataProto.State;
Expand Down Expand Up @@ -776,4 +779,25 @@ public static ContainerProtos.ContainerCommandResponseProto processForDebug(

return msg;
}

/**
* Redacts sensitive configuration.
* Sorts all properties by key name
*
* @param conf OzoneConfiguration object to be printed.
* @return Sorted Map of properties
*/
public static Map<String, String> processForLogging(OzoneConfiguration conf) {
Map<String, String> ozoneProps = conf.getOzoneProperties();
ConfigRedactor redactor = new ConfigRedactor(conf);
Map<String, String> sortedOzoneProps = new TreeMap<>();
for (Map.Entry<String, String> entry : ozoneProps.entrySet()) {
String value = redactor.redact(entry.getKey(), entry.getValue());
if (value != null) {
value = value.trim();
}
sortedOzoneProps.put(entry.getKey(), value);
}
return sortedOzoneProps;
}
}
13 changes: 9 additions & 4 deletions hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/StringUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,11 @@
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;

import com.google.common.base.Preconditions;
import org.apache.commons.lang3.SystemUtils;
import org.apache.hadoop.hdds.conf.OzoneConfiguration;
import org.apache.hadoop.hdds.utils.SignalLogger;
import org.apache.hadoop.hdds.utils.VersionInfo;
import org.apache.hadoop.net.NetUtils;
Expand Down Expand Up @@ -105,12 +107,13 @@ public static String toStartupShutdownString(String prefix, String... msg) {
}

public static void startupShutdownMessage(VersionInfo versionInfo,
Class<?> clazz, String[] args, Logger log) {
Class<?> clazz, String[] args, Logger log, OzoneConfiguration conf) {
final String hostname = NetUtils.getHostname();
final String className = clazz.getSimpleName();

if (log.isInfoEnabled()) {
log.info(createStartupShutdownMessage(versionInfo, className, hostname,
args));
args, HddsUtils.processForLogging(conf)));
}

if (SystemUtils.IS_OS_UNIX) {
Expand All @@ -135,7 +138,8 @@ public static void startupShutdownMessage(VersionInfo versionInfo,
* @return a string to log.
*/
public static String createStartupShutdownMessage(VersionInfo versionInfo,
String className, String hostname, String[] args) {
String className, String hostname, String[] args,
Map<String, String> conf) {
return toStartupShutdownString("STARTUP_MSG: ",
"Starting " + className,
" host = " + hostname,
Expand All @@ -146,7 +150,8 @@ public static String createStartupShutdownMessage(VersionInfo versionInfo,
+ versionInfo.getRevision()
+ " ; compiled by '" + versionInfo.getUser()
+ "' on " + versionInfo.getDate(),
" java = " + System.getProperty("java.version"));
" java = " + System.getProperty("java.version"),
" conf = " + conf);
}

public static String appendIfNotPresent(String str, char c) {
Expand Down
5 changes: 5 additions & 0 deletions hadoop-hdds/common/src/main/java/org/apache/hadoop/hdds/conf/OzoneConfiguration.java
View file
Open in desktop
Copy link

@pertel-chen pertel-chen Dec 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this ozoneregex not contains "dfs.datanode.use.datanode.hostname",so "dfs.datanode.use.datanode.hostname" init only once and not modifiy

Copy link
Contributor

@errose28 errose28 Jan 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These dfs configs are supposed to be deprecated, but it looks like Ozone is still using some of them instead of migrating them to its own config keys. We migrated most of them, but missed the ones in DFSConfigKeysLegacy. I filed HDDS-12026 to fix this. Would you like to work on it?

Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,11 @@ public Properties getAllPropertiesByTag(String tag) {
return props;
}

public Map<String, String> getOzoneProperties() {
String ozoneRegex = ".*(ozone|hdds|ratis|container|scm|recon)\\..*";
return getValByRegex(ozoneRegex);
}

@Override
public Collection<String> getConfigKeys() {
return getProps().keySet()
Expand Down
27 changes: 27 additions & 0 deletions hadoop-hdds/common/src/test/java/org/apache/hadoop/hdds/TestHddsUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@
import org.apache.hadoop.hdds.scm.ScmConfigKeys;
import org.apache.hadoop.ozone.ha.ConfUtils;
import org.apache.ozone.test.LambdaTestUtils;
import org.apache.hadoop.fs.CommonConfigurationKeysPublic;

import static org.apache.hadoop.hdds.HddsUtils.getSCMAddressForDatanodes;
import static org.apache.hadoop.hdds.HddsUtils.processForLogging;
import static org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_ADDRESS_KEY;
import static org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_DATANODE_PORT_DEFAULT;
import static org.apache.hadoop.hdds.scm.ScmConfigKeys.OZONE_SCM_DATANODE_PORT_KEY;
Expand All @@ -50,6 +52,11 @@
*/
public class TestHddsUtils {

private static final String REDACTED_TEXT = "<redacted>";
private static final String ORIGINAL_VALUE = "Hello, World!";
private static final String SENSITIVE_CONFIG_KEYS =
CommonConfigurationKeysPublic.HADOOP_SECURITY_SENSITIVE_CONFIG_KEYS;

@Test
public void testGetHostName() {
assertEquals(Optional.of("localhost"),
Expand Down Expand Up @@ -248,4 +255,24 @@ public void testGetNumberFromConfigKeys() {
serviceId, nodeId),
OZONE_SCM_PIPELINE_OWNER_CONTAINER_COUNT).orElse(0));
}

@Test
public void testRedactSensitivePropsForLogging() {
OzoneConfiguration conf = new OzoneConfiguration();
conf.set(SENSITIVE_CONFIG_KEYS, String.join("\n",
"password$",
"key$"));
/* Sensitive properties */
conf.set("ozone.test.password", ORIGINAL_VALUE);
conf.set("hdds.test.secret.key", ORIGINAL_VALUE);
/* Non-Sensitive properties */
conf.set("ozone.normal.config", ORIGINAL_VALUE);
Map<String, String> processedConf = processForLogging(conf);

/* Verify that sensitive properties are redacted */
assertEquals(processedConf.get("ozone.test.password"), REDACTED_TEXT);
assertEquals(processedConf.get("hdds.test.secret.key"), REDACTED_TEXT);
/* Verify that non-sensitive properties retain their value */
assertEquals(processedConf.get("ozone.normal.config"), ORIGINAL_VALUE);
}
}
5 changes: 3 additions & 2 deletions hadoop-hdds/container-service/src/main/java/org/apache/hadoop/ozone/HddsDatanodeService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,12 @@ public static Logger getLogger() {

@Override
public Void call() throws Exception {
OzoneConfiguration configuration = createOzoneConfiguration();
if (printBanner) {
StringUtils.startupShutdownMessage(HddsVersionInfo.HDDS_VERSION_INFO,
HddsDatanodeService.class, args, LOG);
HddsDatanodeService.class, args, LOG, configuration);
}
start(createOzoneConfiguration());
start(configuration);
ShutdownHookManager.get().addShutdownHook(() -> {
try {
stop();
Expand Down
2 changes: 1 addition & 1 deletion ...r-scm/src/main/java/org/apache/hadoop/hdds/scm/server/StorageContainerManagerStarter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ private void commonInit() {
String[] originalArgs = getCmd().getParseResult().originalArgs()
.toArray(new String[0]);
StringUtils.startupShutdownMessage(HddsVersionInfo.HDDS_VERSION_INFO,
StorageContainerManager.class, originalArgs, LOG);
StorageContainerManager.class, originalArgs, LOG, conf);
}

/**
Expand Down
6 changes: 4 additions & 2 deletions hadoop-ozone/csi/src/main/java/org/apache/hadoop/ozone/csi/CsiServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ public class CsiServer extends GenericCli implements Callable<Void> {

@Override
public Void call() throws Exception {
String[] originalArgs = getCmd().getParseResult().originalArgs()
.toArray(new String[0]);
OzoneConfiguration ozoneConfiguration = createOzoneConfiguration();
StringUtils.startupShutdownMessage(OzoneVersionInfo.OZONE_VERSION_INFO,
CsiServer.class, originalArgs, LOG, ozoneConfiguration);
CsiConfig csiConfig = ozoneConfiguration.getObject(CsiConfig.class);

OzoneClient rpcClient = OzoneClientFactory.getRpcClient(ozoneConfiguration);
Expand Down Expand Up @@ -85,8 +89,6 @@ public Void call() throws Exception {
}

public static void main(String[] args) {
StringUtils.startupShutdownMessage(OzoneVersionInfo.OZONE_VERSION_INFO,
CsiServer.class, args, LOG);
new CsiServer().run(args);
}

Expand Down
2 changes: 1 addition & 1 deletion hadoop-ozone/ozone-manager/src/main/java/org/apache/hadoop/ozone/om/OzoneManagerStarter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ private void commonInit() {
String[] originalArgs = getCmd().getParseResult().originalArgs()
.toArray(new String[0]);
StringUtils.startupShutdownMessage(OzoneVersionInfo.OZONE_VERSION_INFO,
OzoneManager.class, originalArgs, LOG);
OzoneManager.class, originalArgs, LOG, conf);
}

/**
Expand Down
4 changes: 2 additions & 2 deletions hadoop-ozone/recon/src/main/java/org/apache/hadoop/ozone/recon/ReconServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ public static void main(String[] args) {
public Void call() throws Exception {
String[] originalArgs = getCmd().getParseResult().originalArgs()
.toArray(new String[0]);
StringUtils.startupShutdownMessage(OzoneVersionInfo.OZONE_VERSION_INFO,
ReconServer.class, originalArgs, LOG);

configuration = createOzoneConfiguration();
StringUtils.startupShutdownMessage(OzoneVersionInfo.OZONE_VERSION_INFO,
ReconServer.class, originalArgs, LOG, configuration);
ConfigurationProvider.setConfiguration(configuration);

injector = Guice.createInjector(new ReconControllerModule(),
Expand Down
2 changes: 1 addition & 1 deletion hadoop-ozone/s3gateway/src/main/java/org/apache/hadoop/ozone/s3/Gateway.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public void start() throws IOException {
String[] originalArgs = getCmd().getParseResult().originalArgs()
.toArray(new String[0]);
StringUtils.startupShutdownMessage(OzoneVersionInfo.OZONE_VERSION_INFO,
Gateway.class, originalArgs, LOG);
Gateway.class, originalArgs, LOG, ozoneConfiguration);

LOG.info("Starting Ozone S3 gateway");
HddsServerUtil.initializeMetrics(ozoneConfiguration, "S3Gateway");
Expand Down