@aspecto/opentelemetry-instrumentation-mongodb

OpenTelemetry mongodb Instrumentation for Node.js

This is a fork of the instrumentation, to add features required by aspecto until they are merged into the main repo and published.

This module provides automatic instrumentation for mongodb.

For automatic instrumentation see the @opentelemetry/sdk-trace-node package.

Installation

npm install --save @opentelemetry/instrumentation-mongodb

Supported Versions

• '>=3.3 <4

Usage

OpenTelemetry Mongodb Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.

To load a specific instrumentation (mongodb in this case), specify it in the Node Tracer's configuration.

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { MongoDBInstrumentation } = require('@opentelemetry/instrumentation-mongodb');

const provider = new NodeTracerProvider();
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();

const mongodbInstrumentation = new MongoDBInstrumentation({
  // see under for available configuration
});

Mongo instrumentation Options

Mongodb instrumentation has few options available to choose from. You can set the following:

Options	Type	Description
dbStatementSerializer	DbStatementSerializer	Mongodb instrumentation will serialize db.statement using the specified function.
responseHook	MongoDbResponseCustomAttributesFunction	Hook called before response is returned, which allows to add custom attributes to span.
moduleVersionAttributeName	string	If passed, a span attribute will be added to all spans with key of the provided moduleVersionAttributeName and value of the patched module version.
requireParentSpan	boolean	Require parent to create mongodb span, default when unset is true
ignoreIsMasterCommand	boolean	If true, a span for periodical isMaster command will not be generated, default when unset is false. The mongodb client library periodically re-run the isMaster command to detect the replica set configuration changes.
aggregateGetMoreOperations	boolean	If true, a span for a getMore command will not be generated, default when unset is false.
aggregateGetMoreResponseHook	MongoDbGetMoreResponseAggregateFunction	Hook for aggregate a response payload of a GetMore operation, allows to add custom attributes to span.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.2.0

Released 2019-11-04

:rocket: (Enhancement)

• opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-types
  • #449 fix: allow recording links only at Span creation time
• opentelemetry-core, opentelemetry-node, opentelemetry-tracing, opentelemetry-types
  • #454 fix(span): rename span recording flag
• opentelemetry-metrics
  • #475 add shutdown method on MetricExporter interface
• opentelemetry-plugin-document-load
  • #469 chore: fixing problem with load event and performance for loadend
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-web
  • #466 chore: fixing coverage for karma using istanbul

:bug: (Bug Fix)

• opentelemetry-tracing
  • #444 fix: batchSpanProcessor test failing intermittently
• opentelemetry-core
  • #472 fix(core): add missing semver dependency

:books: (Refine Doc)

• #462 chore: update README
• #460 chore: move members list out of community repo
• #445 chore: update CONTRIBUTING.md
• #459 chore: update API docs

:sparkles: (Feature)

• opentelemetry-metrics, opentelemetry-types
  • #437 feat(metrics): add registerMetric and getMetrics
• opentelemetry-metrics
  • #468 feat: validate metric names
• opentelemetry-plugin-postgres
  • #417 feature(plugin): implement postgres plugin
• opentelemetry-core, opentelemetry-types
  • #451 feat: add IsRemote field to SpanContext, set by propagators
• opentelemetry-core, opentelemetry-plugin-document-load, opentelemetry-tracing, opentelemetry-types, opentelemetry-web
  • #433 feat(plugin-document-load): new plugin for document load for web tracer