65 lines
2.9 KiB
Markdown
65 lines
2.9 KiB
Markdown
# OpenTelemetry mongodb Instrumentation for Node.js
|
|
[![Gitter chat][gitter-image]][gitter-url]
|
|
[![dependencies][dependencies-image]][dependencies-url]
|
|
[![devDependencies][devDependencies-image]][devDependencies-url]
|
|
[![Apache License][license-image]][license-image]
|
|
|
|
This module provides automatic instrumentation for [`mongodb`](https://github.com/mongodb/node-mongodb-native).
|
|
|
|
For automatic instrumentation see the
|
|
[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node) package.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install --save @opentelemetry/plugin-mongodb
|
|
```
|
|
### Supported Versions
|
|
- `'>=2.0.0 <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 plugin (mongodb in this case), specify it in the Node Tracer's configuration.
|
|
```js
|
|
const { NodeTracerRegistry } = require('@opentelemetry/node');
|
|
|
|
const registry = new NodeTracerRegistry({
|
|
plugins: {
|
|
mongodb: {
|
|
enabled: true,
|
|
// You may use a package name or absolute path to the file.
|
|
path: '@opentelemetry/plugin-mongodb',
|
|
}
|
|
}
|
|
});
|
|
```
|
|
|
|
To load all the [supported plugins](https://github.com/open-telemetry/opentelemetry-js#plugins), use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules.
|
|
```js
|
|
const { NodeTracerRegistry } = require('@opentelemetry/node');
|
|
|
|
const registry = new NodeTracerRegistry();
|
|
```
|
|
|
|
See [examples/mongodb](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples/mongodb) for a short example.
|
|
|
|
## 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][gitter-url]
|
|
|
|
## License
|
|
|
|
Apache 2.0 - See [LICENSE][license-url] for more information.
|
|
|
|
[gitter-image]: https://badges.gitter.im/open-telemetry/opentelemetry-js.svg
|
|
[gitter-url]: https://gitter.im/open-telemetry/opentelemetry-node?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
|
|
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/master/LICENSE
|
|
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
|
|
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/status.svg?path=packages/opentelemetry-plugin-mongodb
|
|
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-mongodb
|
|
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-plugin-mongodb
|
|
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-mongodb&type=dev
|