https://github.com/imqueue/opentelemetry-instrumentation-imqueue
Integration package with Google Cloud Trace for @imqueue
https://github.com/imqueue/opentelemetry-instrumentation-imqueue
Last synced: 9 months ago
JSON representation
Integration package with Google Cloud Trace for @imqueue
- Host: GitHub
- URL: https://github.com/imqueue/opentelemetry-instrumentation-imqueue
- Owner: imqueue
- License: isc
- Created: 2022-01-04T15:44:01.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T19:09:44.000Z (about 1 year ago)
- Last Synced: 2025-04-22T13:19:00.616Z (9 months ago)
- Language: TypeScript
- Size: 990 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@imqueue/opentelemetry-instrumentation-imqueue
This module provides automatic opentelemetry instrumentation for the @imqueue
## What Is This?
This library provides a clean way to integrate
[@imqueue/rpc](https://github.com/imqueue/rpc) with
[OpenTelemetry](https://github.com/open-telemetry).
## Install
~~~bash
npm i --save @imqueue/opentelemtry-instrumentation-imqueue
~~~
## Usage & API
OpenTelemetry Imqueue Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.
```js
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const {
ImqueueInstrumentation,
} = require('@imqueue/opentelemetry-instrumentation-imqueue');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new ImqueueInstrumentation(),
],
});
```
## Contributing
Any contributions are greatly appreciated. Feel free to fork, propose PRs, open
issues, do whatever you think may be helpful to this project. PRs which passes
all tests and do not brake tslint rules are first-class candidates to be
accepted!
## License
[ISC](https://github.com/imqueue/opentelemetry-instrumentation-imqueue/blob/master/LICENSE)
Happy Coding!