From d703b31fff9c2a63bdf222aa7a8eb3d2e000171d Mon Sep 17 00:00:00 2001 From: Valentin Marchaud Date: Thu, 28 Nov 2019 05:45:17 +0100 Subject: [PATCH] docs: add usage for mongodb-core plugin #543 (#564) * docs: add usage for mongodb-core plugin #543 * Update packages/opentelemetry-plugin-mongodb-core/README.md Co-Authored-By: Mayur Kale --- .../README.md | 24 +++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/packages/opentelemetry-plugin-mongodb-core/README.md b/packages/opentelemetry-plugin-mongodb-core/README.md index 1c6ed4aac6..d4da15c5d4 100644 --- a/packages/opentelemetry-plugin-mongodb-core/README.md +++ b/packages/opentelemetry-plugin-mongodb-core/README.md @@ -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: - For more about OpenTelemetry JavaScript: