migrating doc draft #169
migrating doc draft #169
Conversation
Instead use OTel's OTEL_SERVICE_NAME
MIGRATING.md
Outdated
| ## Known limitations as compared to SignalFx Tracing Library | ||
|
|
||
| - Lowest supported version of NodeJS is `v8.5`, [see more information here](https://github.com/open-telemetry/opentelemetry-js#node-support) | ||
| - No auto-instrumentation for: | ||
| - `AdonisJS` | ||
| - `amqp10` | ||
| - `mongodb-core` ([because it's deprecated](https://github.com/mongodb-js/mongodb-core)) | ||
| - `sails` | ||
| - Limited instrumentation for: | ||
| - `nest` - only manual insturmentation helpers, provided by community | ||
| - other notes on instrumentation: | ||
| - `express` instrumentation requires `http`/`https` instrumentation | ||
| - `bluebird` - context propagation only (via `async_hooks`) | ||
| - `q` - context propagation only (via `async_hooks`) | ||
| - `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>) |
There was a problem hiding this comment.
Not sure if we should talk of limitations. We want people to migrate, not to stick to the old stuff.
Can we change this section so that it states what the Splunk OTel dist for NodeJS is compatible with?
There was a problem hiding this comment.
Obviously we'll do our best to help the customers migrate, but let's make it clear what the pitfalls are.
MIGRATING.md
Outdated
| 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 |
There was a problem hiding this comment.
| ## Equivalent configurations | |
| ## Configurations you can migrate |
| With the exception of [explicitly listed limitations](#known-limitations) we aim to support all libraries supported by | ||
| signalfx-nodejs-tracing. To find an equivalent auto-instrumentation open <https://opentelemetry.io/registry/> and for |
There was a problem hiding this comment.
Ditto. Consider removing mention of limitations.
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]>
jtmalinowski
force-pushed
the
chore/migrating-doc
branch
from
554758e to
622344d
Compare
| [from `signalfx-nodejs-tracing`'s README](https://github.com/signalfx/signalfx-nodejs-tracing/#requirements-and-supported-software) | ||
| search by the name of the library in the registry. | ||
|
|
||
| For example, if you'd like to migrate instrumentation for `mysql`, go to |
There was a problem hiding this comment.
It's OK to keep it like that then
MIGRATING.md
Outdated
| - No auto-instrumentation for: | ||
| - `AdonisJS` | ||
| - `amqp10` | ||
| - `mongodb-core` ([because it's deprecated](https://github.com/mongodb-js/mongodb-core)) |
There was a problem hiding this comment.
I would stress that MongoDB driver auto instrumentation is still supported. They just reogranized the client lib.
MIGRATING.md
Outdated
| - Limited instrumentation for: | ||
| - `nest` - only manual insturmentation helpers, provided by community | ||
| - other notes on instrumentation: | ||
| - `express` instrumentation requires `http`/`https` instrumentation |
There was a problem hiding this comment.
Same applies for koa and hapi for now.
There was a problem hiding this comment.
Oh... and it's duplicated few lines below.
MIGRATING.md
Outdated
|
|
||
| Because the SignalFx Tracing Library for NodeJS uses OpenTracing and the Splunk Distribution | ||
| of OpenTelemetry for NodeJS uses OpenTelemetry, the semantic | ||
| conventions for span tag names change when you migrate. For more information, |
There was a problem hiding this comment.
.. and the span names as well! There are different guidelines for that in OTel.
Codecov Report
@@ Coverage Diff @@
## main #169 +/- ##
==========================================
- Coverage 87.06% 84.51% -2.56%
==========================================
Files 13 14 +1
Lines 286 297 +11
Branches 67 69 +2
==========================================
+ Hits 249 251 +2
- Misses 37 46 +9
Continue to review full report at Codecov.
|
* Include TS types and esm in release
Description
Replace this with a description of the PR. Explain the problem it solves and the proposed solution.
Fixes #168
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Checklist: