@opentelemetry/instrumentation-hapi
TypeScript icon, indicating that this package has built-in type declarations

0.49.0 • Public • Published

OpenTelemetry Hapi Instrumentation for Node.js

NPM Published Version Apache License

This module provides automatic instrumentation for the Hapi Framework(@hapi/hapi)package, 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+.

Status

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

Installation

npm install --save @opentelemetry/instrumentation-hapi

Supported Versions

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 registerInstrumentations' configuration.

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

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new HapiInstrumentation(),
  ],
});

If instead you would just want to load a specific instrumentation only (hapi in this case);

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { HapiInstrumentation } = require('@opentelemetry/instrumentation-hapi');
const provider = new NodeTracerProvider();
provider.register();

const hapiInstrumentation = new HapiInstrumentation();
hapiInstrumentation.setTracerProvider(provider);

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.

Semantic Conventions

Prior to version 0.48.0, this instrumentation created spans targeting an experimental semantic convention Version 1.7.0.

HTTP semantic conventions (semconv) were stabilized in v1.23.0, and a migration process was defined. instrumentation-hapi versions 0.48.0 and later include support for migrating to stable HTTP semantic conventions, as described below. The intent is to provide an approximate 6 month time window for users of this instrumentation to migrate to the new HTTP semconv, after which a new minor version will use the new semconv by default and drop support for the old semconv. See the HTTP semconv migration plan for OpenTelemetry JS instrumentations.

To select which semconv version(s) is emitted from this instrumentation, use the OTEL_SEMCONV_STABILITY_OPT_IN environment variable.

  • http: emit the new (stable) v1.23.0+ semantics
  • http/dup: emit both the old v1.7.0 and the new (stable) v1.23.0+ semantics
  • By default, if OTEL_SEMCONV_STABILITY_OPT_IN includes neither of the above tokens, the old v1.7.0 semconv is used.

Attributes collected

The following semconv attributes are collected on hapi route spans:

v1.7.0 semconv v1.23.0 semconv Notes
http.method http.request.method HTTP request method
http.route http.route (same) Route assigned to handler. Ex: /users/:id

Useful links

License

Apache 2.0 - See LICENSE for more information.

Package Sidebar

Install

npm i @opentelemetry/instrumentation-hapi

Weekly Downloads

4,815,963

Version

0.49.0

License

Apache-2.0

Unpacked Size

92 kB

Total Files

24

Last publish

Collaborators

  • bogdandrutu
  • dyladan
  • pichlermarc