Package Exports

@opentelemetry/instrumentation-net
@opentelemetry/instrumentation-net/build/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@opentelemetry/instrumentation-net) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OpenTelemetry Net module Instrumentation for Node.js

This module provides automatic instrumentation for the net module, 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+.

Supports both TCP and IPC connections.

Installation

npm install --save @opentelemetry/instrumentation-net

Supported Versions

Node.js >=14

Usage

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { NetInstrumentation } = require('@opentelemetry/instrumentation-net');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

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

registerInstrumentations({
  instrumentations: [
    new NetInstrumentation(),
    // other instrumentations
  ],
});

Semantic Conventions

This instrumentation implements Semantic Conventions (semconv) v1.7.0. Since then, many networking-related semantic conventions (in semconv v1.21.0 and v1.23.1) were stabilized. As of @opentelemetry/instrumentation-net@0.53.0 support has been added for migrating to the stable semantic conventions using the OTEL_SEMCONV_STABILITY_OPT_IN environment variable as follows:

Upgrade to the latest version of this instrumentation package.
Set OTEL_SEMCONV_STABILITY_OPT_IN=http/dup to emit both old and stable semantic conventions. (The http token is used to control the net.* attributes.)
Modify alerts, dashboards, metrics, and other processes in your Observability system to use the stable semantic conventions.
Set OTEL_SEMCONV_STABILITY_OPT_IN=http to emit only the stable semantic conventions.

By default, if OTEL_SEMCONV_STABILITY_OPT_IN is not set or does not include http, then the old v1.7.0 semconv is used. The intent is to provide an approximate 6 month time window for users of this instrumentation to migrate to the new networking semconv, after which a new minor version will use the new semconv by default and drop support for the old semconv. See the HTTP migration guide and deprecated network attributes for details.

Attributes collected:

Old semconv	Stable semconv	Description
`net.transport`	`network.transport`	One of `pipe`, `unix`, `ip_tcp` (old) or `tcp` (stable)
`net.peer.name`	`server.address`	Host name or the IPC file path
`net.peer.port`	`server.port`	Remote port number
`net.peer.ip`	`network.peer.address`	Peer address of the network connection - IP address or Unix domain socket name.
`net.host.ip`	`network.local.address`	Local address of the network connection - IP address or Unix domain socket name.
`net.host.port`	`network.local.port`	Local port number of the network connection.

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.