@medipass/hapi-instrumentation
v0.10.0
Published
OpenTelemetry Hapi automatic instrumentation package.
Downloads
20
Readme
OpenTelemetry Hapi Instrumentation for Node.js
This module provides automatic instrumentation for Hapi
.
For automatic instrumentation see the @opentelemetry/node package.
Installation
npm install --save @opentelemetry/hapi-instrumentation
Supported Versions
- @hapi/hapi
^17.0.0
Usage
OpenTelemetry Hapi 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 instrumentation (Hapi in this case), specify it in the Node Tracer's configuration.
const { NodeTracerProvider } = require('@opentelemetry/node');
const provider = new NodeTracerProvider({
plugins: {
'@hapi/hapi': {
enabled: true,
// You may use a package name or absolute path to the file.
path: '@opentelemetry/hapi-instrumentation',
}
}
});
To load all of the supported instrumentations, use below approach. Each instrumentation is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing instrumentations for unused modules.
const { NodeTracerProvider } = require('@opentelemetry/node');
const provider = new NodeTracerProvider();
See examples/hapi for a short example using Hapi
Hapi Instrumentation Support
This package provides automatic tracing for hapi server routes and request lifecycle extensions defined either directly or via a Hapi plugin.
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 on gitter
License
Apache 2.0 - See LICENSE for more information.