@opentelemetry/plugin-dns

OpenTelemetry dns automatic instrumentation package.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@opentelemetry/plugin-dns
359920.15.02 years ago3 years agoMinified + gzip package size for @opentelemetry/plugin-dns in KB

Readme

OpenTelemetry DNS Instrumentation for Node.js
!NPM Published Versionnpm-imgnpm-url !dependenciesdependencies-imagedependencies-url !devDependenciesdevDependencies-imagedevDependencies-url !Apache Licenselicense-imagelicense-image
This module provides automatic instrumentation for dns.
For automatic instrumentation see the @opentelemetry/node package.

Installation

npm install --save @opentelemetry/plugin-dns

Usage

const { NodeTracerProvider } = require('@opentelemetry/node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    {
      plugins: {
        dns: {
          enabled: true,
          // You may use a package name or absolute path to the file.
          path: '@opentelemetry/plugin-dns',
          // dns plugin options
        }
      }
    },
  ],
  tracerProvider: provider,
});

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 provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
  instrumentations: [
    {
      plugins: {
        dns: {
          enabled: true,
          // You may use a package name or absolute path to the file.
          path: '@opentelemetry/plugin-dns',
          ignoreHostnames: ['localhost']
        }
      }
    },
  ],
  tracerProvider: provider,
});

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 |

Useful links

  • For more information on OpenTelemetry, visit:
  • For more about OpenTelemetry JavaScript:
  • For help or feedback on this project, join us in GitHub Discussionsdiscussions-url

License

Apache 2.0 - See LICENSElicense-url for more information.