Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 10.9 KB

advanced-config.md

File metadata and controls

114 lines (82 loc) · 10.9 KB

The official Splunk documentation for this page is Configure the Splunk Distribution of OTel JS. For instructions on how to contribute to the docs, see CONTRIBUTING.md.

Advanced Configuration

To configure the Splunk Distribution of OpenTelemetry JS, you can use a combination of environment variables and arguments passed to the startTracing() function:

  • Environment variables

    For example: export OTEL_SERVICE_NAME='test-service'

  • Arguments passed to the startTracing() function

    For example: startTracing({ serviceName: 'my-node-service', });

startTracing() arguments take precedence over the corresponding environment variables.

List of settings

This distribution supports all the configuration options supported by the components it uses with the defaults specified by the OTel Specification.

Tracing

Environment variable
startTracing() argument		 Default value Support Notes
OTEL_ATTRIBUTE_COUNT_LIMIT Stable Maximum allowed span attribute count
OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT 12000* Stable Maximum allowed attribute value size
OTEL_EXPORTER_JAEGER_ENDPOINT http://localhost:14268/v1/traces or
http://localhost:9080/v1/trace
if jaeger-thrift-splunk is used as exporter		 Stable HTTP endpoint for Jaeger traces
OTEL_EXPORTER_OTLP_ENDPOINT
endpoint		 http://localhost:4317 Stable The OTLP endpoint to export to. Only OTLP over gRPC is supported.
OTEL_LOG_LEVEL Stable Log level to use in diagnostics logging. Does not set the logger.
OTEL_PROPAGATORS
propagators		 tracecontext,baggage Stable Comma-delimited list of propagators to use. Valid keys: baggage, tracecontext, b3multi, b3.
OTEL_RESOURCE_ATTRIBUTES Stable Comma-separated list of resource attributes added to every reported span.
Examplekey1=val1,key2=val2
OTEL_SERVICE_NAME
serviceName		 unnamed-node-service Stable The service name of this Node service.
OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT 128 Stable Maximum allowed span attribute count
OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT Stable Maximum allowed attribute value size. Empty value is treated as infinity
OTEL_SPAN_EVENT_COUNT_LIMIT 128 Stable
OTEL_SPAN_LINK_COUNT_LIMIT 1000* Stable
OTEL_TRACES_EXPORTER
tracesExporter		 otlp Stable Chooses the exporter. Shortcut for setting spanExporterFactory. One of [otlp, jaeger-thrift-http, jaeger-thrift-splunk, console-splunk]. See SpanExporterMap.
OTEL_TRACES_SAMPLER parentbased_always_on Stable Sampler to be used for traces. See Sampling
OTEL_TRACES_SAMPLER_ARG Stable String value to be used as the sampler argument. Only be used if OTEL_TRACES_SAMPLER is set.
SPLUNK_ACCESS_TOKEN
accessToken		 Stable The optional access token for exporting signal data directly to SignalFx API.
SPLUNK_REALM
realm		 Stable The name of your organization's realm, for example, us0. When you set the realm, telemetry is sent directly to the ingest endpoint of Splunk Observability Cloud, bypassing the Splunk OpenTelemetry Collector.
SPLUNK_TRACE_RESPONSE_HEADER_ENABLED
serverTimingEnabled		 true Stable Enable injection of Server-Timing header to HTTP responses.
SPLUNK_REDIS_INCLUDE_COMMAND_ARGS false Stable Will include the full redis query in db.statement span attribute when using redis instrumentation.

*: Overwritten default value

Additional startTracing config options

The following config options can be set by passing them as arguments to startTracing().

  • tracerConfig: A JS object that is merged into the default tracer config replacing any existing keys. It's passed to the tracer provider during initialization. This can be used to customize the tracer provider or tracer. Must satisfy TracerConfig interface

  • spanExporterFactory: A function that accepts the options passed to the startTracing function. Returns a new instance of SpanExporter. When set, this function is used to create a new exporter and the returned exporter will be used in the pipeline.

  • spanProcessorFactory: Returns a SpanProcessor instance or an array of SpanProcessor instances. When set, this function is be used to create one or more span processors. The returned processors are added to the global tracer provider and configured to process all spans generated by any tracer provider by the global provider. The function creates a new span exporter and uses it with each processor it creates. It may call options.spanExporterFactory(options) to create a new exporter as configured by the user.

  • propagatorFactory: A function that returns a new instance of a TextMapPropagator. Defaults to a composite propagator comprised of W3C Trace Context and Baggage propagators.

  • instrumentations: Can be used to enable additional instrumentation packages.

  • captureHttpRequestUriParams: Either a list of keys (case-sensitive) of HTTP query parameters to capture or a function that gets invoked with the current span and query parameters to set a custom span attribute. When using the former, parameters are set as span attributes as http.request.param.${key}. Attribute keys are normalized at capture time, meaning . is replaced with _ to avoid any attribute namespacing issues.

Metrics

Configuration examples can be seen here.

Environment variable
startMetrics() argument		 Default value Support Notes
OTEL_SERVICE_NAME
serviceName		 unnamed-node-service Stable The service name of this Node service.
OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
endpoint		 http://localhost:4317 Stable The OTLP endpoint to export to.
OTEL_METRIC_EXPORT_INTERVAL
exportIntervalMillis		 30000 Stable The interval, in milliseconds, of metrics collection and exporting.
OTEL_RESOURCE_ATTRIBUTES Stable The resource attributes to metric data.
Environment variable examplekey1=val1,key2=val2
SPLUNK_METRICS_ENABLED
n/a (enabled by calling startMetrics)		 false Experimental Sets up the metrics pipeline (global meter provider, exporters).
n/a
resourceFactory		 Experimental Callback which allows to filter the default resource or provide a custom one. The function takes one argument of type Resource which is the resource pre-filled by the SDK containing the service.name, environment, host and process attributes.
SPLUNK_RUNTIME_METRICS_ENABLED
runtimeMetricsEnabled		 false Experimental Enable collecting and exporting of runtime metrics. See metrics documentation for more information.
SPLUNK_RUNTIME_METRICS_COLLECTION_INTERVAL
runtimeMetricsCollectionIntervalMillis		 5000 Experimental The interval, in milliseconds, during which GC and event loop statistics are collected. After the collection is done, the values become available to the metric exporter.

Profiling

Environment variable
startProfiling() argument		 Default value Support Notes
SPLUNK_PROFILER_ENABLED false Experimental Enable continuous profiling. See profiling documentation for more information.
SPLUNK_PROFILER_MEMORY_ENABLED
memoryProfilingEnabled		 false Experimental Enable continuous memory profiling.
SPLUNK_PROFILER_LOGS_ENDPOINT
endpoint		 http://localhost:4317 Experimental The OTLP logs receiver endpoint used for profiling data.
OTEL_SERVICE_NAME
serviceName		 unnamed-node-service Stable Service name of the application.
OTEL_RESOURCE_ATTRIBUTES Stable Comma-separated list of resource attributes.
Exampledeployment.environment=demo,key2=val2

Start all

To control all signals with one call start() API can be used:

const { start } = require('@splunk/otel');

start({
  // accessToken,
  // endpoint,
  // serviceName,
  tracing: {
    // tracing-specific options here.
  },
  // profiling: true, // enable experimental profiling signal
  /*
  metrics: { // enable experimental metrics signal with specific configuration
    // exportInterval,
  },
  */
});

By default start() API enables all stable signals, which means the list will change over time. Shared configuration(accessToken, endpoint, serviceName) can be provided on the root level of the configuration object.

Signal specific options must be provided under specific properties: tracing, profiling, metrics. true can be provided for default configuration.