Skip to content

Commit

Permalink
fix: various fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jtmalinowski committed Jul 22, 2021
1 parent 1f8b1f2 commit 622344d
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions MIGRATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Splunk Distribution of OpenTelemetry for NodeJS replaces the SignalFx Tracing
Library for NodeJS. If you’re using the SignalFx Tracing Library, migrate to
the Splunk Distribution of OpenTelemetry for NodeJS to use OpenTelemetry’s
the Splunk Distribution of OpenTelemetry for NodeJS to use OpenTelemetry
instrumentation to send traces to Splunk APM. The Splunk Distribution of
OpenTelemetry for NodeJS uses OpenTelemetry to instrument applications, which is
an open-source API to gather telemetry data, and has a smaller footprint.
Expand All @@ -12,6 +12,11 @@ of OpenTelemetry for NodeJS uses OpenTelemetry, the semantic
conventions for span tag names change when you migrate. For more information,
see [Migrate from OpenTracing to OpenTelemetry](https://docs.signalfx.com/en/latest/apm/apm-getting-started/apm-opentelemetry-collector.html#apm-opentelemetry-migration).

## Getting help

If you experience any issues following the guide below, or something is unclear, or missing, please don't hesitate to
open an issue in Github. Any and all ideas for improvements are also welcome.

<a name="known-limitations"></a>
## Known limitations as compared to SignalFx Tracing Library

Expand All @@ -30,16 +35,18 @@ see [Migrate from OpenTracing to OpenTelemetry](https://docs.signalfx.com/en/lat
- `when` - context propagation only (via `async_hooks`)
- `socket.io` - provided by community (<https://github.com/aspecto-io/opentelemetry-ext-js/tree/master/packages/instrumentation-socket.io>)

## Changes to defaults

- Default flush interval, which defines how frequently captured telemetry data is sent to the backend, is now 30s instead of 2s

## Requirements

This Splunk Distribution of OpenTelemetry requires Node.js 8.5 or later.
If you're still using an earlier version of Node.js, continue using the SignalFx Tracing Library for Node.js.

## Equivalent configurations

### Changes to defaults
Current effective required Node.js version is: ![node-current](https://img.shields.io/node/v/@splunk/otel?style=flat-square)

- Default flush interval, which defines how frequently captured telemetry data is sent to the backend, is now 30s instead of 2s
## Migration steps

### Instrumented libraries

Expand Down Expand Up @@ -80,6 +87,8 @@ Rename environment variables:

### Programmatic configuration

Update these programmatic configuration options:

| Old property | New property | Notes |
| ------------------------ | ----------------------- | ----- |
| `service` | `serviceName` | |
Expand All @@ -95,7 +104,7 @@ Rename environment variables:
| `recordedValueMaxLength` | `maxAttrLength` | |
| `enableServerTiming` | `serverTimingEnabled` | |

### Invocation
### Instrumentation entry point

```javascript
const tracer = require('signalfx-tracing').init({
Expand Down Expand Up @@ -123,7 +132,7 @@ variables only.
### Instrumentation logs

There isn't a one-to-one mapping for `SIGNALFX_TRACING_DEBUG`. The closest equivalent is `OTEL_LOG_LEVEL`, however the logged
information might be different.
information might be different.

> Note that this section is about the logs produced by instrumentation, and not
about the logs produced by the application.
Expand Down

0 comments on commit 622344d

Please sign in to comment.