@opentelemetry/instrumentation-dns

OpenTelemetry DNS Instrumentation for Node.js

This module provides automatic instrumentation for the dns module.

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

Supported Versions

• Node.js >=14

Usage

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

const sdk = new NodeSDK({
  instrumentations: [
    new DnsInstrumentation({
      // see under for available configuration
    }),
  ],
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });

DNS Instrumentation Options

DNS instrumentation has currently one option. You can set the following:

Options	Type	Description
ignoreHostnames	IgnoreMatcher | IgnoreMatcher[]	DNS instrumentation will not trace all requests that match hostnames

Semantic Conventions

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

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.