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

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

Status

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

Installation

npm install --save @opentelemetry/instrumentation-hapi

Supported 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 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

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

Attribute Short Description
http.method HTTP method
http.route 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

1,054,952

Version

0.39.0

License

Apache-2.0

Unpacked Size

85.7 kB

Total Files

21

Last publish

Collaborators

  • pichlermarc
  • bogdandrutu
  • dyladan