diff --git a/docs/advanced-config.md b/docs/advanced-config.md index f2c55d6d8..f95d10e8e 100644 --- a/docs/advanced-config.md +++ b/docs/advanced-config.md @@ -13,12 +13,12 @@ Below you will find all the configuration options supported by this distribution ## Splunk configuration -| System property | Environment variable | Default value | Support | Description | -|-----------------------------------------|-----------------------------------------|-------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `splunk.access.token` | `SPLUNK_ACCESS_TOKEN` | unset | Stable | (Optional) Auth token allowing exporters to communicate directly with the Splunk cloud, passed as `X-SF-TOKEN` header. | -| `splunk.realm` | `SPLUNK_REALM` | `none` | Stable | The Splunk Observability Cloud realm where the telemetry should be sent to. For example, `us0` or `us1`. Defaults to `none`, which means that data goes to a Splunk OpenTelemetry Collector deployed on `localhost`. | -| `splunk.metrics.force_full_commandline` | `SPLUNK_METRICS_FORCE_FULL_COMMANDLINE` | `false` | Experimental | Adds the full command line as a resource attribute for all metrics. If false, commands longer than 255 characters are truncated. | -| `splunk.trace-response-header.enabled` | `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED` | `true` | Stable | Enables adding server trace information to HTTP response headers. See [this document](server-trace-info.md) for more information. | +| System property | Environment variable | Default value | Support | Description | +|-----------------------------------------|-----------------------------------------|-------------------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `splunk.access.token` | `SPLUNK_ACCESS_TOKEN` | unset | Stable | (Optional) Auth token allowing exporters to communicate directly with the Splunk cloud, passed as `X-SF-TOKEN` header. | +| `splunk.realm` | `SPLUNK_REALM` | `none` | Stable | The Splunk Observability Cloud realm where the telemetry should be sent to. For example, `us0` or `us1`. Defaults to `none`, which means that data goes to a Splunk OpenTelemetry Collector deployed on `localhost`. | +| `splunk.metrics.force_full_commandline` | `SPLUNK_METRICS_FORCE_FULL_COMMANDLINE` | `false` | Experimental | Adds the full command line as a resource attribute for all metrics. If false, commands longer than 255 characters are truncated. | +| `splunk.trace-response-header.enabled` | `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED` | `true` | Stable | Enables adding server trace information to HTTP response headers. See [this document](https://docs.splunk.com/observability/en/gdi/get-data-in/application/java/configuration/advanced-java-otel-configuration.html#server-trace-information) for more information. | ## Trace exporters diff --git a/metadata-generator/src/main/java/com/splunk/opentelemetry/tools/MetadataGenerator.java b/metadata-generator/src/main/java/com/splunk/opentelemetry/tools/MetadataGenerator.java index fd0d3afb3..610a84e7a 100644 --- a/metadata-generator/src/main/java/com/splunk/opentelemetry/tools/MetadataGenerator.java +++ b/metadata-generator/src/main/java/com/splunk/opentelemetry/tools/MetadataGenerator.java @@ -1256,7 +1256,7 @@ Some instrumentations (e.g. Spring Web MVC instrumentation) produce SpanKind.Int settings.add( setting( "splunk.trace-response-header.enabled", - "Enables adding server trace information to HTTP response headers. See this document for more information.", + "Enables adding server trace information to HTTP response headers. [See this document](https://docs.splunk.com/observability/en/gdi/get-data-in/application/java/configuration/advanced-java-otel-configuration.html#server-trace-information) for more information.", "true", SettingType.BOOLEAN, SettingCategory.GENERAL));