Skip to content

Commit

Permalink
docs: add usage for mongodb-core plugin open-telemetry#543 (open-tele…
Browse files Browse the repository at this point in the history
…metry#564)

* docs: add usage for mongodb-core plugin open-telemetry#543

* Update packages/opentelemetry-plugin-mongodb-core/README.md

Co-Authored-By: Mayur Kale <[email protected]>
  • Loading branch information
vmarchaud and mayurkale22 committed Nov 28, 2019
1 parent b3332e3 commit d703b31
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions packages/opentelemetry-plugin-mongodb-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,32 @@ npm install --save @opentelemetry/plugin-mongodb-core

## 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 opentelemetry = require('@opentelemetry/plugin-mongodb-core');
const { NodeTracer } = require('@opentelemetry/node');

const tracer = new NodeTracer({
plugins: {
'mongodb-core': {
enabled: true,
// You may use a package name or absolute path to the file.
path: '@opentelemetry/plugin-mongodb-core',
}
}
});
```

// TODO: DEMONSTRATE API
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 { NodeTracer } = require('@opentelemetry/node');

const tracer = new NodeTracer();
```

See [examples/mongodb](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples/mongodb-core) 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>
Expand Down

0 comments on commit d703b31

Please sign in to comment.