OpenTelemetry Hapi Instrumentation for Node.js

This module provides automatic instrumentation for the Hapi Framework(@hapi/hapi)package.

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+.

Status

| Maturity | Component Owner | Compatibility | |----------------------------------------------------|-------------------------------------------------------|-----------------------| | Unmaintained | N/A | API 1.0+SDK 1.0+ |

Installation

npm install --save @opentelemetry/instrumentation-hapi

Supported Versions

• @hapi/hapi versions >=17.0.0 <22

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 enable a specific instrumentation, pass it to registerInstrumentations(). This is commonly done via NodeSDK for fully setting up all OpenTelemetry SDK components:

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { HapiInstrumentation } = require('@opentelemetry/instrumentation-hapi');

const sdk = new NodeSDK({
  instrumentations: [
    new HapiInstrumentation(),
  ],
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });

Hapi Instrumentation Support

This package provides automatic tracing for hapi server routes and request lifecycle extensions defined either directly or via a Hapi plugin.

Semantic Conventions

This instrumentation creates spans that include HTTP-related data as span attributes.

The instrumentation-hapi versions 0.66.0 and later emit the stable v1.23.0+ semantic conventions.

Attributes collected

The following semconv attributes are collected on hapi route spans:

| v1.23.0 semconv | Notes | |-----------------------|---------------------------------------------| | http.request.method | HTTP request method | | http.route | Route assigned to handler. Ex: /users/:id |

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.