@opentelemetry/instrumentation-mongoose v0.38.1
OpenTelemetry mongoose Instrumentation for Node.js
This module provides automatic instrumentation for the mongoose
module, which may be loaded using the @opentelemetry/sdk-trace-node
package and is included in the @opentelemetry/auto-instrumentations-node
bundle.
If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node
bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.
Compatible with OpenTelemetry JS API and SDK 1.0+
.
Installation
npm install --save @opentelemetry/instrumentation-mongoose
Supported Versions
>=5.9.7 <7
Usage
To load a specific plugin, specify it in the registerInstrumentations's configuration:
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { MongooseInstrumentation } = require('@opentelemetry/instrumentation-mongoose');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new MongooseInstrumentation(),
],
})
Migration From opentelemetry-instrumentation-mongoose
This instrumentation was originally published and maintained under the name "opentelemetry-instrumentation-mongoose"
in this repo.
Few breaking changes were made during porting to the contrib repo to align with conventions:
Hook Info
The instrumentation's config responseHook
functions signature changed, so the second function parameter is info object, containing the relevant hook data.
moduleVersionAttributeName
config option
The moduleVersionAttributeName
config option is removed. To add the mongoose package version to spans, use the moduleVersion
attribute in hook info for responseHook
function.
Semantic Conventions
This package uses @opentelemetry/semantic-conventions
version 1.22+
, which implements Semantic Convention Version 1.7.0
Attributes collected:
Attribute | Short Description |
---|---|
db.mongodb.collection | The collection being accessed within the database stated in db.name . |
db.name | This attribute is used to report the name of the database being accessed. |
db.operation | The name of the operation being executed, or the SQL keyword. |
db.statement | The database statement being executed. |
db.system | An identifier for the database management system (DBMS) product being used. |
db.user | Username for accessing the database. |
net.peer.name | Remote hostname or similar. |
net.peer.port | Remote port number. |
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 in GitHub Discussions
License
Apache 2.0 - See LICENSE for more information.
4 days ago
11 days ago
1 month ago
2 months ago
3 months ago
4 months ago
6 months ago
6 months ago
7 months ago
9 months ago
10 months ago
11 months ago
12 months ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago