opentelemetry-js/packages/opentelemetry-plugin-dns/README.md

2.9 KiB

OpenTelemetry DNS Instrumentation for Node.js

Gitter chat dependencies devDependencies Apache License

This module provides automatic instrumentation for dns.

For automatic instrumentation see the @opentelemetry/node package.

Installation

npm install --save @opentelemetry/plugin-dns

Usage

const { NodeTracerRegistry } = require('@opentelemetry/node');

const registry = new NodeTracerRegistry({
  plugins: {
    dns: {
      enabled: true,
      // You may use a package name or absolute path to the file.
      path: '@opentelemetry/plugin-dns',
      // dns plugin options
    }
  }
});

Zipkin

If you use Zipkin, you must use ignoreHostnames in order to not trace those calls. If the server is local. You can set :

const registry = new NodeTracerRegistry({
  plugins: {
    dns: {
      enabled: true,
      // You may use a package name or absolute path to the file.
      path: '@opentelemetry/plugin-dns',
      ignoreHostnames: ['localhost']
    }
  }
});

Dns Plugin Options

Dns plugin has currently one option. You can set the following:

Options Type Description
ignoreHostnames IgnoreMatcher[] Dns plugin will not trace all requests that match hostnames

License

Apache 2.0 - See LICENSE for more information.