Skip to content
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

Fix broken link in docs #1968

Merged
merged 2 commits into from
Jul 30, 2024
Merged

Fix broken link in docs #1968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0225752
fix broken link
breedx-splk Jul 29, 2024
e51238c
add missing link
breedx-splk Jul 29, 2024
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: 6 additions & 6 deletions docs/advanced-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion metadata-generator/src/main/java/com/splunk/opentelemetry/tools/MetadataGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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));
Expand Down
Loading