From 3bf1e5199c4630f0be993892446f92e4615e9e96 Mon Sep 17 00:00:00 2001 From: Mateusz Rzeszutek Date: Wed, 31 Mar 2021 17:51:54 +0200 Subject: [PATCH 1/4] Fix Java system property description In Java it actually works the other way than it was described: we convert system property names to environment variable names. Dashes (kebab case) are allowed. See https://github.com/open-telemetry/opentelemetry-java-instrumentation/issues/1414#issuecomment-733181398 --- docs/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 4e7fde0..e4c6d73 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -88,6 +88,6 @@ In addition to environment variables, other ways of defining configuration also - [Java System Properties](https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html): - These properties MUST match the environment variables converting to lower - case and replacing underscores with periods. For example: - `splunk.access.token`. + These properties converted to lower case with dashes and dots replaced by underscores + MUST match the environment variables. For example: + `splunk.context.server-timing.enabled`. From 66f6267f62306da9d4039db706200d3bc6d06bb8 Mon Sep 17 00:00:00 2001 From: Mateusz Rzeszutek Date: Wed, 31 Mar 2021 19:56:58 +0200 Subject: [PATCH 2/4] A little more explicit example --- docs/configuration.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index e4c6d73..4e00b7c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -88,6 +88,7 @@ In addition to environment variables, other ways of defining configuration also - [Java System Properties](https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html): - These properties converted to lower case with dashes and dots replaced by underscores + These properties converted to lower case with hyphens and dots replaced by underscores MUST match the environment variables. For example: - `splunk.context.server-timing.enabled`. + system property `splunk.context.server-timing.enabled` is equivalent to environment + variable `SPLUNK_CONTEXT_SERVER_TIMING_ENABLED`. From 82ba1d2971a267e4afd5b9756a4e7c37ba7d637e Mon Sep 17 00:00:00 2001 From: Mateusz Rzeszutek Date: Wed, 31 Mar 2021 19:58:24 +0200 Subject: [PATCH 3/4] Update configuration.md --- docs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 4e00b7c..03eae37 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -88,7 +88,7 @@ In addition to environment variables, other ways of defining configuration also - [Java System Properties](https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html): - These properties converted to lower case with hyphens and dots replaced by underscores - MUST match the environment variables. For example: + These properties converted to lower case with hyphens and periods replaced by + underscores MUST match the environment variables. For example: system property `splunk.context.server-timing.enabled` is equivalent to environment variable `SPLUNK_CONTEXT_SERVER_TIMING_ENABLED`. From 5f0ed43bc070a85f15e472930cc70a3ce7c52645 Mon Sep 17 00:00:00 2001 From: Mateusz Rzeszutek Date: Thu, 1 Apr 2021 08:31:13 +0200 Subject: [PATCH 4/4] Update docs/configuration.md Co-authored-by: Tyler Yahn --- docs/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 03eae37..884aa84 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -88,7 +88,7 @@ In addition to environment variables, other ways of defining configuration also - [Java System Properties](https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html): - These properties converted to lower case with hyphens and periods replaced by - underscores MUST match the environment variables. For example: + These properties MUST match the environment variables converting to lower + case and replacing underscores with hyphens or periods. For example: system property `splunk.context.server-timing.enabled` is equivalent to environment variable `SPLUNK_CONTEXT_SERVER_TIMING_ENABLED`.