Skip to content

Commit

Permalink
Merge f72ccc5 into b2d7a91
Browse files Browse the repository at this point in the history
  • Loading branch information
@rauno56
rauno56 authored Oct 25, 2021
2 parents b2d7a91 + f72ccc5 commit 0673943
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 23 deletions.
9 changes: 4 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,11 @@ This Splunk distribution comes with the following defaults:
- Unlimited default limits for [configuration options](#trace-configuration) to
support full-fidelity traces.

If you're currently using the SignalFx Tracing Library for Node and want to
migrate to the Splunk Distribution of OpenTelemetry Node, see [Migrate from
the SignalFx Tracing Library for JS](./MIGRATING.md).
If you're currently using the SignalFx Tracing Library for Node and want to migrate to the Splunk Distribution of OpenTelemetry Node, see [Migrate from the SignalFx Tracing Library for JS](./MIGRATING.md).

## Get started

The following instructions assume that you're sending data to Splunk Observability Cloud using the [OpenTelemetry Collector](https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html) running on localhost. If you're running a
different setup, refer to the [configuration options](./docs/advanced-config.md) to customize your settings.
The following instructions assume that you're sending data to Splunk Observability Cloud using the [OpenTelemetry Collector](https://docs.splunk.com/Observability/gdi/opentelemetry/opentelemetry.html) running on localhost. If you're running a different setup, refer to the [configuration options](./docs/advanced-config.md) to customize your settings.

1. Install the `@splunk/otel` package:

Expand Down Expand Up @@ -150,6 +147,8 @@ The following logging library instrumentations are supported:

You can find more instrumentation packages over at the [OpenTelemetry Registry](https://opentelemetry.io/registry/?language=js) and enable them manually as described above.

**Note that many of the instrumentation libraries offered by OpenTelemetry are still experimental.**

## Troubleshooting

For troubleshooting issues with the Splunk Distribution of OpenTelemetry JS, see [Troubleshooting](./docs/troubleshooting.md).
Expand Down
41 changes: 23 additions & 18 deletions docs/advanced-config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,29 @@ To configure the Splunk Distribution of OpenTelemetry JS, you can use a combinat
## List of settings

This distribution supports all the configuration options supported by the components it uses with the defaults specified by the [OTel Specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md) with few exceptions:

| Environment variable | Overwritten default value | Description
| --- | --- |
| OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT | `12000` | Maximum allowed attribute value size. Empty value is treated as infinity. Longer values are truncated.
| OTEL_SPAN_LINK_COUNT_LIMIT | `1000` | Maximum allowed span link count.

The following table contain the configuration options supported by this distribution.

| Environment variable | Arguments to ``startTracing()`` | Default value | Notes
| ----------------------------- | ------------------------------- | ------------------------------------- | ----
| OTEL_EXPORTER_OTLP_ENDPOINT | endpoint | `localhost:4317` | The OTLP endpoint to export to. Only OTLP over gRPC is supported.
| OTEL_TRACES_EXPORTER | tracesExporter | `otlp` | Chooses the exporter. Shortcut for setting `spanExporterFactory`. One of [`otlp`, `jaeger-thrift-http`, `jaeger-thrift-splunk`]. See [`TracesExporter`](../src/options.ts).
| OTEL_PROPAGATORS | propagators | `tracecontext,baggage` | Comma-delimited list of propagators to use. Valid keys: `baggage`, `tracecontext`, `b3multi`, `b3`.
| OTEL_SERVICE_NAME | serviceName | `unnamed-node-service` | The service name of this Node service.
| SPLUNK_ACCESS_TOKEN | accessToken | | The optional access token for exporting signal data directly to SignalFx API.
| SPLUNK_TRACE_RESPONSE_HEADER_ENABLED | serverTimingEnabled | `true` | Enable injection of `Server-Timing` header to HTTP responses.
| OTEL_RESOURCE_ATTRIBUTES | | | Comma-separated list of resource attributes added to every reported span. <details><summary>Example</summary>`key1=val1,key2=val2`</details>
This distribution supports all the configuration options supported by the components it uses with the defaults specified by the [OTel Specification](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md):

| Environment variable<br>``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<br>`http://localhost:9080/v1/trace`<br>if `jaeger-thrift-splunk` is used as exporter | Stable | HTTP endpoint for Jaeger traces
| `OTEL_EXPORTER_OTLP_ENDPOINT`<br>`endpoint` | `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`<br>`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. <details><summary>Example</summary>`key1=val1,key2=val2`</details>
| `OTEL_SERVICE_NAME`<br>`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`<br>`tracesExporter` | `otlp` | Stable | Chooses the exporter. Shortcut for setting `spanExporterFactory`. One of [`otlp`, `jaeger-thrift-http`, `jaeger-thrift-splunk`]. See [`TracesExporter`](../src/options.ts).
| `OTEL_TRACES_SAMPLER` | `parentbased_always_on` | Stable | Sampler to be used for traces. See [Sampling](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/sdk.md#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`<br>`accessToken` | | Stable | The optional access token for exporting signal data directly to SignalFx API.
| `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED`<br>`serverTimingEnabled` | `true` | Stable | Enable injection of `Server-Timing` header to HTTP responses.

\*: Overwritten default value

## Additional config options

Expand Down

0 comments on commit 0673943

Please sign in to comment.