# @opentelemetry/plugin-dns

> OpenTelemetry dns automatic instrumentation package.

Latest version **0.15.0** (published 2021-04-05) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @opentelemetry/plugin-dns
pnpm add @opentelemetry/plugin-dns
yarn add @opentelemetry/plugin-dns
bun add @opentelemetry/plugin-dns
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.15.0 |
| Published | 2021-04-05 |
| First published | 2019-11-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 4 |
| Unpacked size | 37 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | OpenTelemetry Authors |
| Maintainers | mayurkale22, bogdandrutu, dyladan, obecny |
| Keywords | opentelemetry, dns, nodejs, tracing, profiling, plugin |

## Links

- npm: https://www.npmjs.com/package/@opentelemetry/plugin-dns
- Repository: https://github.com/open-telemetry/opentelemetry-js-contrib
- Homepage: https://github.com/open-telemetry/opentelemetry-js-contrib#readme
- Issues: https://github.com/open-telemetry/opentelemetry-js-contrib/issues
- npm.io page: https://npm.io/package/@opentelemetry/plugin-dns

## Dependencies (4)

- [semver](https://npm.io/package/semver.md) ^7.3.2
- [shimmer](https://npm.io/package/shimmer.md) ^1.2.1
- [@opentelemetry/api](https://npm.io/package/@opentelemetry/api.md) ^0.18.0
- [@opentelemetry/core](https://npm.io/package/@opentelemetry/core.md) ^0.18.0

## Recent versions

- 0.15.0 (latest) — 2021-04-05
- 0.14.0 — 2021-03-05
- 0.13.1 — 2021-02-10
- 0.13.0 — 2021-02-01
- 0.12.1 — 2021-01-15
- 0.12.0 — 2020-12-21
- 0.11.0 — 2020-10-31
- 0.10.0 — 2020-09-09
- 0.9.0 — 2020-08-03
- 0.8.0 — 2020-05-29
- 0.7.0 — 2020-04-28
- 0.6.1 — 2020-04-08
- 0.6.0 — 2020-04-02
- 0.5.2 — 2020-03-27
- 0.5.1 — 2020-03-20
- … 7 more at https://npm.io/package/@opentelemetry/plugin-dns/versions

## README

# OpenTelemetry DNS Instrumentation for Node.js

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-image]

This module provides automatic instrumentation for [`dns`](http://nodejs.org/dist/latest/docs/api/dns.html).

For automatic instrumentation see the
[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

## Installation

```bash
npm install --save @opentelemetry/plugin-dns
```

## Usage

```js
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 :

```js
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`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-dns/src/types.ts#L98) | `IgnoreMatcher[]` | Dns plugin will not trace all requests that match hostnames |

## 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][discussions-url]

## License

Apache 2.0 - See [LICENSE][license-url] for more information.

[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-plugin-dns
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-plugin-dns
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-plugin-dns&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-plugin-dns&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/plugin-dns
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fplugin-dns.svg

---
_Source: https://npm.io/package/@opentelemetry/plugin-dns · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._