Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@opentelemetry/instrumentation-generic-pool

open-telemetry8mApache-2.00.43.0TypeScript support: included

OpenTelemetry instrumentation for generic-pool resource pool for managing expensive resources

generic-pool, instrumentation, nodejs, opentelemetry, tracing

readme

OpenTelemetry Generic Pool Instrumentation for Node.js

NPM Published Version Apache License

This module provides automatic instrumentation for the generic-pool module, creating a span for every acquire call, 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+.

Installation

npm install --save @opentelemetry/instrumentation-generic-pool

Supported Versions

Usage

const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const { GenericPoolInstrumentation } = require('@opentelemetry/instrumentation-generic-pool');

const provider = new NodeTracerProvider();

provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();

registerInstrumentations({
  instrumentations: [new GenericPoolInstrumentation()],
  tracerProvider: provider,
});

Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

License

Apache 2.0 - See LICENSE for more information.

changelog

CHANGELOG

As of v0.25.1 (2022-01-24) changelog content has moved to separate CHANGELOG.md files for each package. Use this search for a list of all CHANGELOG.md files in this repo.

Unreleased

0.25.0

:bug: Bug Fix

  • #619 fix: GraphQL throws TypeError: Cannot read property 'startToken' of undefined (@obecny)
  • #643 fix(user-interaction): event listeners have wrong this when listening for bubbled events (@t2t2)
  • #562 fix(mysql): bind get connection callback to active context (@sstone1)
  • #589 fix(hapi-instrumentation): close spans on errors in instrumented functions (@CptSchnitz)
  • #580 fix: redis instrumentation loses context when using callbacks (@aspectom)

:rocket: Enhancement

  • Other
  • opentelemetry-test-utils
    • #593 feat: move aws/gcp detectors from opentelemetry-js repo (@legendecas)

:house: Internal

  • opentelemetry-test-utils
    • #641 chore(mysql2): adding TAV script (@YanivD)
    • #639 build(test-utils): marking test-utils as non private so it can be published (@blumamir)
    • #596 docs(test-utils): add README.md for @opentelemetry/test-utils (@Rauno56)
  • Other

:memo: Documentation

  • opentelemetry-browser-extension-autoinjection

Committers: 16

0.24.0

:bug: Bug Fix

:rocket: Enhancement

  • opentelemetry-browser-extension-autoinjection, opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • opentelemetry-host-metrics
  • Other
    • #571 fix(instrumentation-hapi): change root span name to route name (@CptSchnitz)
    • #566 feat(aws-lambda): added eventContextExtractor config option (@prsnca)

:house: Internal

  • #592 chore(deps): upgrade @types/pino to be compatible with latest sonic-stream types (@legendecas)
  • #583 style: use single quotes everywhere and add a rule to eslint (@CptSchnitz)
  • #549 chore: enable typescript 4.3 option noImplicitOverride (@Flarna)

Committers: 8

0.23.0

:bug: Bug Fix

  • #557 chore: aligning target for esm build with core repo (@obecny)

:rocket: Enhancement

  • opentelemetry-browser-extension-autoinjection
  • opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • Other
    • #533 feat(mongo instrumentation): added response hook option (@prsnca)
    • #546 feat(aws-lambda): disableAwsContextPropagation config option (@nirsky)
    • #528 feat: postgresql responseHook support (@nata7che)
  • opentelemetry-test-utils

:house: Internal

  • #554 chore: remove unneeded ts-node dev-dependency (@Flarna)

Committers: 9

0.22.0

:bug: Bug Fix

  • #537 fix(instrumentation-user-interaction): support clicks in React apps (@kkruk-sumo)

:rocket: Enhancement

  • opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils

Committers: 2

0.21.0

:bug: Bug Fix

:rocket: Enhancement

  • opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • Other

Committers: 6

0.20.0

:bug: Bug Fix

  • #488 fix: dns plugin remove hostname attribute (@svrnm)
  • #468 moving dev dependency for types to main dependency (@obecny)

:rocket: Enhancement

  • Other
    • #517 feat: use rpcMetadata to update http span name #464 (@vmarchaud)
    • #441 feat(instrumentation-document-load): documentLoad attributes enhancement (@kkruk-sumo)
  • opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • opentelemetry-test-utils
    • #470 chore: removing usage of timed event from api (@obecny)

:house: Internal

  • Other
  • opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
    • #455 Update gts, eslint, typescript and hapi dependencies (@Flarna)

:memo: Documentation

  • #472 docs: Explicitly state that express instrumentation does not export spans without http instrumentation (@svrnm)
  • #450 chore: prefer use of global TracerProvider/MeterProvider (@Flarna)

Committers: 16

0.16.0

:boom: Breaking Change

  • opentelemetry-host-metrics

:bug: Bug Fix

  • #403 chore: fixing context propagation on mongo callback (@obecny)

:rocket: Enhancement

  • opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • opentelemetry-id-generator-aws-xray
  • Other

:house: Internal

  • opentelemetry-host-metrics, opentelemetry-test-utils
  • Other
    • #434 chore: clean up images from restify example (@Rauno56)

:memo: Documentation

Committers: 9

0.15.0

:rocket: Enhancement

  • Other
  • auto-instrumentation-web
  • auto-instrumentation-node
    • #379 chore: creating meta package for default auto instrumentations for node (@obecny)
  • opentelemetry-instrumentation-hapi
  • opentelemetry-instrumentation-koa
  • opentelemetry-instrumentation-mysql
  • opentelemetry-instrumentation-net
  • opentelemetry-host-metrics
    • #395 chore: fixing broken links, updating to correct base url, replacing gitter with github discussions (@obecny)

:house: Internal

  • opentelemetry-host-metrics, opentelemetry-test-utils
    • #408 chore: bump otel dependencies to latest patch (@dyladan)
  • Other

:memo: Documentation

  • opentelemetry-host-metrics

Committers: 9

0.14.0

:bug: Bug Fix

:rocket: Enhancement

  • #354 refactor: migrate mongodb to instrumentation #250 (@vmarchaud)
  • #381 chore: fixing the graphql example and allowing support version of graph from ver 14 (@obecny)
  • #372 feat(instrumentation-ioredis): add requireParentSpan option to config (@blumamir)

:house: Internal

Committers: 5

0.13.1

:rocket: Enhancement

:house: Internal

Committers: 4

0.13.0

:bug: Bug Fix

  • opentelemetry-test-utils
    • #239 fix(plugin-ioredis): end span on response from the server and set span status according to response (@blumamir)
  • Other

:rocket: Enhancement

  • Other
  • opentelemetry-host-metrics, opentelemetry-test-utils

:memo: Documentation

  • opentelemetry-host-metrics

Committers: 7

0.12.1

:bug: Bug Fix

:rocket: Enhancement

  • #273 feat: enable root span route instrumentation without any express layer spans (@shyimo)
  • #298 Add CodeQL Security Scans (@amanbrar1999)

Committers: 7

0.12.0

:bug: Bug Fix

  • #241 fix(ioredis): set net.peer.name attribute according to spec (@blumamir)

:rocket: Enhancement

  • Other
  • opentelemetry-host-metrics
    • #266 chore: refactoring host metrics, aligning with semantic conventions (@obecny)

:house: Internal

  • opentelemetry-host-metrics, opentelemetry-test-utils
  • Other
    • #259 fix(plugin-document-load): check if getEntriesByType is available before using it (@mhennoch)
    • #257 docs(readme): add @opentelemetry/instrumentation-graphql (@Hongbo-Miao)

Committers: 7

0.11.0

:bug: Bug Fix

  • #221 fix: wrapper function for hapi route & plugins (@jk1z)
  • #225 pg spans disconnected from parent (@obecny)
  • #208 [mysql] fix: ensure span name is a string to avoid [object Object] as span name (@naseemkullah)
  • #175 fix: accept EventListener callbacks (@johnbley)
  • #188 fix(express): listen for finish event on response for async express layer #107 (@vmarchaud)

:rocket: Enhancement

Committers: 9

0.10.0

:bug: Bug Fix

:tada: New Plugins

:rocket: Enhancement

:house: Internal

Committers: 9

0.9.0

:rocket: (Enhancement)

:bug: (Bug Fix)

  • #158 fix: patch removeEventListener to properly remove patched callbacks (@johnbley)

Committers: 10

0.8.0 (@opentelemetry/propagator-grpc-census-binary)

:rocket: (Enhancement)

Committers: 1

0.8.0

Released 2020-05-29

:rocket: (Enhancement)

  • #30 Support OpenTelemetry SDK 0.8.x (@dyladan)
  • opentelemetry-plugin-mongodb
  • opentelemetry-plugin-ioredis
    • #33 feat(opentelemetry-plugin-ioredis): provide a custom serializer fn for db.statement (@marcoreni)

Committers: 3

0.7.0

Released 2020-04-27

:bug: (Bug Fix)

  • opentelemetry-plugin-express
  • opentelemetry-plugin-mongodb
    • #5 fix(mongodb): avoid double patching when enable is called twice (@vmarchaud)
  • opentelemetry-plugin-mongodb
    • #3 Prevent double wrapping pg pool query (@dyladan)

:rocket: (Enhancement)

  • opentelemetry-plugin-express

Committers: 3

0.6.1

Released 2020-04-08

For details about this release and all previous releases, see https://github.com/open-telemetry/opentelemetry-js/blob/main/CHANGELOG.md