Skip to content

Commit

Permalink
Update default value for splunk.profiler.logs-endpoint in doc (#1925)
Browse files Browse the repository at this point in the history
  • Loading branch information
@laurit
laurit authored Jul 3, 2024
1 parent 3498ceb commit 5ced103
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
26 changes: 13 additions & 13 deletions docs/advanced-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,19 +101,19 @@ If `OTEL_TRACES_SAMPLER_ARG` is not provided or has en empty value, no `drop` ru

## Profiler settings

| Setting | Default | Description |
|-------------------------------------------|--------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `splunk.profiler.enabled` | false | set to `true` to enable the profiler |
| `splunk.profiler.directory` | system temp directory | location of JFR files, defaults to `System.getProperty("java.io.tmpdir")` |
| `splunk.profiler.recording.duration` | 20s | recording unit duration |
| `splunk.profiler.keep-files` | false | leave JFR files on disk if `true` |
| `splunk.profiler.logs-endpoint` | `otel.exporter.otlp.endpoint` or http://localhost:4317 | where to send OTLP logs |
| `splunk.profiler.call.stack.interval` | 10000ms | how often to sample call stacks |
| `splunk.profiler.memory.enabled` | false | set to `true` to enable all other memory profiling options unless explicitly disabled. Setting to `true` enables metrics. |
| `splunk.profiler.memory.event.rate` | 150/s | allocation event rate |
| `splunk.profiler.include.internal.stacks` | false | set to `true` to include stack traces of agent internal threads and stack traces with only JDK internal frames |
| `splunk.profiler.tracing.stacks.only` | false | set to `true` to include only stack traces that are linked to a span context |
| `splunk.profiler.otlp.protocol` | `http/protobuf` | The transport protocol to use on profiling OTLP log requests. Options include `grpc` and `http/protobuf`. |
| Setting | Default | Description |
|-------------------------------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `splunk.profiler.enabled` | false | set to `true` to enable the profiler |
| `splunk.profiler.directory` | system temp directory | location of JFR files, defaults to `System.getProperty("java.io.tmpdir")` |
| `splunk.profiler.recording.duration` | 20s | recording unit duration |
| `splunk.profiler.keep-files` | false | leave JFR files on disk if `true` |
| `splunk.profiler.logs-endpoint` | http://localhost:4318/v1/logs | where to send OTLP logs, defaults to `otel.exporter.otlp.endpoint` |
| `splunk.profiler.call.stack.interval` | 10000ms | how often to sample call stacks |
| `splunk.profiler.memory.enabled` | false | set to `true` to enable all other memory profiling options unless explicitly disabled. Setting to `true` enables metrics. |
| `splunk.profiler.memory.event.rate` | 150/s | allocation event rate |
| `splunk.profiler.include.internal.stacks` | false | set to `true` to include stack traces of agent internal threads and stack traces with only JDK internal frames |
| `splunk.profiler.tracing.stacks.only` | false | set to `true` to include only stack traces that are linked to a span context |
| `splunk.profiler.otlp.protocol` | `http/protobuf` | The transport protocol to use on profiling OTLP log requests. Options include `grpc` and `http/protobuf`. |

If the `splunk.profiler.enabled` option is not enabled, all profiling features are disabled. For
example, setting `splunk.profiler.memory.enabled` to `true` has no effect if
Expand Down
26 changes: 13 additions & 13 deletions metadata-generator/src/main/java/com/splunk/opentelemetry/tools/MetadataGenerator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1293,17 +1293,17 @@ Some instrumentations (e.g. Spring Web MVC instrumentation) produce SpanKind.Int
// https://github.com/signalfx/splunk-otel-java/blob/main/docs/advanced-config.md#profiler-settings

/*
| `splunk.profiler.enabled` | false | set to `true` to enable the profiler |
| `splunk.profiler.directory` | system temp directory | location of JFR files, defaults to `System.getProperty("java.io.tmpdir")` |
| `splunk.profiler.recording.duration` | 20s | recording unit duration |
| `splunk.profiler.keep-files` | false | leave JFR files on disk if `true` |
| `splunk.profiler.logs-endpoint` | `otel.exporter.otlp.endpoint` or http://localhost:4317 | where to send OTLP logs |
| `splunk.profiler.call.stack.interval` | 10000ms | how often to sample call stacks |
| `splunk.profiler.memory.enabled` | false | set to `true` to enable all other memory profiling options unless explicitly disabled. Setting to `true` enables metrics. |
| `splunk.profiler.memory.event.rate` | 150/s | allocation event rate |
| `splunk.profiler.include.internal.stacks` | false | set to `true` to include stack traces of agent internal threads and stack traces with only JDK internal frames |
| `splunk.profiler.tracing.stacks.only` | false | set to `true` to include only stack traces that are linked to a span context |
| `splunk.profiler.otlp.protocol` | `http/protobuf` | The transport protocol to use on profiling OTLP log requests. Options include grpc and http/protobuf. |
| `splunk.profiler.enabled` | false | set to `true` to enable the profiler |
| `splunk.profiler.directory` | system temp directory | location of JFR files, defaults to `System.getProperty("java.io.tmpdir")` |
| `splunk.profiler.recording.duration` | 20s | recording unit duration |
| `splunk.profiler.keep-files` | false | leave JFR files on disk if `true` |
| `splunk.profiler.logs-endpoint` | http://localhost:4318/v1/logs | where to send OTLP logs, defaults to `otel.exporter.otlp.endpoint` |
| `splunk.profiler.call.stack.interval` | 10000ms | how often to sample call stacks |
| `splunk.profiler.memory.enabled` | false | set to `true` to enable all other memory profiling options unless explicitly disabled. Setting to `true` enables metrics. |
| `splunk.profiler.memory.event.rate` | 150/s | allocation event rate |
| `splunk.profiler.include.internal.stacks` | false | set to `true` to include stack traces of agent internal threads and stack traces with only JDK internal frames |
| `splunk.profiler.tracing.stacks.only` | false | set to `true` to include only stack traces that are linked to a span context |
| `splunk.profiler.otlp.protocol` | `http/protobuf` | The transport protocol to use on profiling OTLP log requests. Options include `grpc` and `http/protobuf`. |
*/

settings.add(
Expand Down Expand Up @@ -1337,8 +1337,8 @@ Some instrumentations (e.g. Spring Web MVC instrumentation) produce SpanKind.Int
settings.add(
setting(
"splunk.profiler.logs-endpoint",
"Where to send OTLP logs.",
"otel.exporter.otlp.endpoint or http://localhost:4317",
"Where to send OTLP logs, defaults to `otel.exporter.otlp.endpoint.",
"http://localhost:4318/v1/logs",
SettingType.STRING,
SettingCategory.PROFILER));
settings.add(
Expand Down

0 comments on commit 5ced103

Please sign in to comment.