From 5ced103d2d9004dbbd066ac12ec102ad03d7220d Mon Sep 17 00:00:00 2001 From: Lauri Tulmin Date: Wed, 3 Jul 2024 14:24:06 +0300 Subject: [PATCH] Update default value for splunk.profiler.logs-endpoint in doc (#1925) --- docs/advanced-config.md | 26 +++++++++---------- .../tools/MetadataGenerator.java | 26 +++++++++---------- 2 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/advanced-config.md b/docs/advanced-config.md index 0f92e7bcc..f2c55d6d8 100644 --- a/docs/advanced-config.md +++ b/docs/advanced-config.md @@ -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 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 d96124bd5..105550c23 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 @@ -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( @@ -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(