@opentelemetry/metrics

OpenTelemetry Metrics SDK

OpenTelemetry metrics allow a user to collect data and export it to a metrics backend like Prometheus.

Installation

npm install --save @opentelemetry/metrics

Usage

Counter

Choose this kind of metric when the value is a quantity, the sum is of primary interest, and the event count and value distribution are not of primary interest. Counters are defined as Monotonic = true by default, meaning that positive values are expected.

const { MeterProvider } = require('@opentelemetry/metrics');

// Initialize the Meter to capture measurements in various ways.
const meter = new MeterProvider().getMeter('your-meter-name');

const counter = meter.createCounter('metric_name', {
  labelKeys: ["pid"],
  description: "Example of a counter"
});

const labels = { pid: process.pid };

// Create a BoundInstrument associated with specified label values.
const boundCounter = counter.bind(labels);
boundCounter.add(10);

See examples/prometheus for a short example.

Measure

Work in progress

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 on gitter

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.6.1

Released 2020-04-08

:rocket: (Enhancement)

• opentelemetry-exporter-jaeger
  • #924 [Jaeger-Exporter] host default env var (@naseemkullah)
• opentelemetry-metrics
  • #933 feat(meter): allow custom batcher #932 (@vmarchaud)

:bug: (Bug Fix)

• opentelemetry-plugin-http
  • #946 Remove bad null check (@dyladan)
• opentelemetry-exporter-prometheus, opentelemetry-metrics
  • #941 fix: do not clear other labelsets when updating metrics (@dyladan)

:books: (Refine Doc)

• opentelemetry-propagator-jaeger
  • #937 fix: Jaeger propagator example of usage" (@shivkanya9146)

Committers: 4

• Daniel Dyla (@dyladan)
• Naseem (@naseemkullah)
• Valentin Marchaud (@vmarchaud)
• @shivkanya9146