@eventstore/opentelemetry
v0.1.0
Published
[![license][license-badge]][license-badge-url] [![Github action CI workflow][ci-badge]][ci-badge-url]
Downloads
622
Readme
@eventstore/opentelemetry
This module provides automatic tracing instrumentation for EventStore-Client-NodeJS.
Compatible with OpenTelemetry JS API and SDK 1.0+
.
Installation
npm install --save @eventstore/opentelemetry
Supported Versions
[6.x]
It's likely that the instrumentation would support earlier versions of EventStoreDB, but this has not been tested.
Usage
OpenTelemetry EventStoreDB Instrumentation allows the user to automatically collect trace data from append and subscription operations and export them to the backend of choice.
To load the instrumentation, specify it in the instrumentations list to registerInstrumentations
. There is currently no configuration option.
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { EventStoreDBInstrumentation } = require('@eventstore/opentelemetry');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new EventStoreDBInstrumentation(),
],
});
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, open an issue or submit a PR
Support
Information on support can be found on our website: Event Store Support
Communities
Contributing
Refer to our contribution guidelines.