@medipass/hapi-instrumentation

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.

Changelog

0.10.0

:bug: Bug Fix

• #186 [size/XS] fix: fixes broken readme links (@michaelgoin)

:tada: New Plugins

• #171 feat: Hapi auto-instrumentation (@carolinee21)
• #144 feat: adding Koa instrumentation (@carolinee21)

:rocket: Enhancement

• Other
  • #183 [mysql] implement semantic conventions (@naseemkullah)
  • #196 fix: new version with TextMapPropagator interface (@jufab)
  • #184 chore: moved plugins-node-all into contrib repo from opentelemetry-js (@michaelgoin)
  • #187 [mongodb] implement semantic db conventions (@naseemkullah)
  • #172 [Plugin User Interaction]: Improve causality of spans from bubbled events (@johnbley)
  • #164 feat: Add React Plugin (@thgao)
  • #170 fix: various compilation errors (@naseemkullah)
• opentelemetry-test-utils
  • #167 ioredis and redis DB semantic conventions (@naseemkullah)

:house: Internal

• #194 Ioredis cleanup (@naseemkullah)
• #195 redis cleanup (@naseemkullah)
• #192 Handful of document-load fixes (@johnbley)
• #191 Zone.js fixed failing build (@obecny)
• #174 feat(opentelemetry-plugin-pg): omit pg.values by default (@sergioregueira)

Committers: 9

• Bartlomiej Obecny (@obecny)
• John Bley (@johnbley)
• Julien Fabre (@jufab)
• Michael Goin (@michaelgoin)
• Naseem (@naseemkullah)
• Sergio Regueira (@sergioregueira)
• Shivkanya Andhare (@shivkanya9146)
• Tina Gao (@thgao)
• @carolinee21