elastic/apm-agent-nodejs-opentracing

An OpenTracing bridge for the Elastic APM Node.js Agent

Elastic APM Node.js OpenTracing Bridge

Note: This OpenTracing Bridge is deprecated in favor of the Elastic APM Node.js OpenTelemetry Bridge

An OpenTracing bridge for the Elastic APM Node.js Agent.

Prerequisites

This module have elastic-apm-node as a peer dependency.

Version 2.10.0 or higher of the Elastic APM Agent is required in order to use this module.

Installation

npm install elastic-apm-node-opentracing --save

Usage

// Start the Elastic APM agent at the VERY top of the first file loaded
// in your app
const agent = require('elastic-apm-node').start()
const Tracer = require('elastic-apm-node-opentracing')

// Pass the Elastic APM agent as an argument to the OpenTracing tracer
const tracer = new Tracer(agent)

const span = tracer.startSpan('my-first-span')
// ... do some work ...
span.finish()

API

tracer = new Tracer(agent)

This module exposes a Tracer class which is OpenTracing compatible.

When instantiating the Tracer object, an instance of the Elastic APM Node.js Agent must be provided as its only argument.

For details about the tracer API, see the opentracing-javascript API docs.

License

Apache-2.0

apm-agent-nodejs-opentracing's Issues

[email protected]" has unmet peer dependency "elastic-apm-node@^2.10.0".

The elastic-apm-node latest version is 3.26.0, can you please upgrade it?
I tried to upgrade by myself but there are some breaking changes that break 30 tests.

Thanks.

Support for Service Maps and OpenRracing

While elastic-apm-node-opentracing can support distributing tracing, it looks like we do not support service maps. Quoting @JiaLiPassion

And I checked the source code of elastic-apm-node apm-agent-nodejs/http-shared.js at master · elastic/apm-agent-nodejs · GitHub , to display the link of the Service Map correctly, the destionationContext and the httpContext need to be set to the Span (There is no documentation about this part, so I am not sure how to set this destination context correctly to do my own instrument). And this destination context can be only set to the Span object, and a Span need to have an active transaction, so I need to create a Transaction and a Span to display the link. So I am using some hacking way to make the link being displayed.

The linked thread has some information on manually hacking in a transaction (or moving to OpenTelemetry) but if anyone from the community has a more elegant "span only" solution we'd welcome a discussion or PR/PRs on what it would take to make this happen

types.d.ts is not a module

Hi, using v2.0.1 in typescript (v4.4.3) project and getting .../node_modules/elastic-apm-node-opentracing/types.d.ts' is not a module error.

Our tsconfig file:

{
    "compilerOptions": {
      "allowJs": false,
      "allowSyntheticDefaultImports": true,
      "emitDecoratorMetadata": true,
      "esModuleInterop": true,
      "forceConsistentCasingInFileNames": true,
      "inlineSourceMap": true,
      "inlineSources": true,
      "isolatedModules": true,
      "module": "commonjs",
      "moduleResolution": "node",
      "noUncheckedIndexedAccess": true,
      "outDir": "./build",
      "resolveJsonModule": true,
      "rootDir": ".",
      "skipLibCheck": true,
      "strict": true,
      "target": "es2019",
      "experimentalDecorators": true
    },
    "exclude": ["node_modules", "tests"],
    "ts-node": {
      "files": true
    }
  }

Not compatible with typescript

I'm currently looking at using this but I'm unable to due to the lack of types for use with typescript

Share un-sampled span instance for same transaction

We might be able to improve performance by only creating a single no-op span for each un-sampled transaction span.