Skip to content

Remove sensitive information from debug log #1346

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

Closed
jpbempel wants to merge 3 commits into from
Closed

Remove sensitive information from debug log #1346

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96757f0
Remove sensitive information from debug log
jpbempel Apr 2, 2020
4d15d5a
Sensor information instead of excluding the fields
jpbempel Apr 2, 2020
58ea15e
if not populated returns null for toString
jpbempel Apr 2, 2020
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
12 changes: 12 additions & 0 deletions dd-trace-api/src/main/java/datadog/trace/api/Config.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,18 @@ public enum PropagationStyle {
/** A tag intended for internal use only, hence not added to the public api DDTags class. */
private static final String INTERNAL_HOST_NAME = "_dd.hostname";

/** Used for masking sensitive information when doing toString */
@ToString.Include(name = "profilingApiKey")
private String profilingApiKeyMasker() {
return profilingApiKey != null ? "****" : null;
}

/** Used for masking sensitive information when doing toString */
@ToString.Include(name = "profilingProxyPassword")
private String profilingProxyPasswordMasker() {
return profilingProxyPassword != null ? "****" : null;
}

/**
* this is a random UUID that gets generated on JVM start up and is attached to every root span
* and every JMX metric that is sent out.
Expand Down
18 changes: 18 additions & 0 deletions dd-trace-api/src/test/groovy/datadog/trace/api/ConfigTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ class ConfigTest extends DDSpecification {
private static final DD_PROFILING_API_KEY_ENV = "DD_PROFILING_API_KEY"
private static final DD_PROFILING_API_KEY_OLD_ENV = "DD_PROFILING_APIKEY"
private static final DD_PROFILING_TAGS_ENV = "DD_PROFILING_TAGS"
private static final DD_PROFILING_PROXY_PASSWORD_ENV = "DD_PROFILING_PROXY_PASSWORD"

def "verify defaults"() {
when:
Expand Down Expand Up @@ -406,6 +407,23 @@ class ConfigTest extends DDSpecification {
config.profilingApiKey == "test-api-key"
}

def "sensitive information removed for toString/debug log"() {
setup:
environmentVariables.set(DD_PROFILING_API_KEY_ENV, "test-secret-api-key")
environmentVariables.set(DD_PROFILING_PROXY_PASSWORD_ENV, "test-secret-proxy-password")

when:
def config = new Config()

then:
config.toString().contains("profilingApiKey=****");
!config.toString().contains("test-secret-api-key")
config.toString().contains("profilingProxyPassword=****");
!config.toString().contains("test-secret-proxy-password")
config.getProfilingApiKey() == "test-secret-api-key"
config.getProfilingProxyPassword() == "test-secret-proxy-password"
}

def "sys props override env vars"() {
setup:
environmentVariables.set(DD_SERVICE_NAME_ENV, "still something else")
Expand Down