@opentelemetry/exporter-metrics-otlp-proto

What is @opentelemetry/exporter-metrics-otlp-proto?

@opentelemetry/exporter-metrics-otlp-proto is an npm package that allows you to export metrics data from your application to the OpenTelemetry Collector using the OTLP (OpenTelemetry Protocol) over gRPC in a protobuf format. This package is part of the OpenTelemetry project, which provides a set of APIs, libraries, agents, and instrumentation to enable observability in your applications.

What are @opentelemetry/exporter-metrics-otlp-proto's main functionalities?

Exporting Metrics

This code sample demonstrates how to set up the OTLPMetricExporter to export metrics data to an OpenTelemetry Collector. It creates a MeterProvider with the exporter and an interval for exporting metrics. A counter metric is then created and incremented.

const { MeterProvider } = require('@opentelemetry/sdk-metrics-base');
const { OTLPMetricExporter } = require('@opentelemetry/exporter-metrics-otlp-proto');

const exporter = new OTLPMetricExporter({
  url: 'http://localhost:4317',
});

const meterProvider = new MeterProvider({
  exporter,
  interval: 2000,
});

const meter = meterProvider.getMeter('example-meter');
const counter = meter.createCounter('example_counter');

counter.add(10, { key: 'value' });

Other packages similar to @opentelemetry/exporter-metrics-otlp-proto

@opentelemetry/exporter-metrics-otlp-http

@opentelemetry/exporter-metrics-otlp-http is another exporter for OpenTelemetry metrics, but it uses the OTLP over HTTP instead of gRPC. This can be useful in environments where HTTP is preferred or required over gRPC.

@opentelemetry/exporter-prometheus

@opentelemetry/exporter-prometheus allows you to export metrics in a format that can be scraped by Prometheus. This is useful if you are using Prometheus as your monitoring solution and want to integrate OpenTelemetry metrics with it.

@opentelemetry/exporter-collector

@opentelemetry/exporter-collector is a more general exporter that can send both traces and metrics to the OpenTelemetry Collector. It supports multiple transport protocols including gRPC and HTTP, making it a versatile choice for exporting telemetry data.

README

OpenTelemetry Collector Metrics Exporter for node with protobuf

This module provides exporter for node to be used with OTLP (http/protobuf) compatible receivers. Compatible with opentelemetry-collector versions >=0.32 <=0.53.

Installation

npm install --save @opentelemetry/exporter-metrics-otlp-proto

Service Name

The OpenTelemetry Collector Exporter does not have a service name configuration. In order to set the service name, use the service.name resource attribute as prescribed in the OpenTelemetry Resource Semantic Conventions. To see sample code and documentation for the traces exporter, visit the Collector Trace Exporter for web and node.

Metrics in Node - PROTO over http

const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
const { OTLPMetricExporter } =  require('@opentelemetry/exporter-metrics-otlp-proto');
const collectorOptions = {
  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
};
const exporter = new OTLPMetricExporter(collectorOptions);
const meterProvider = new MeterProvider({});

meterProvider.addMetricReader(new PeriodicExportingMetricReader({
  exporter: metricExporter,
  exportIntervalMillis: 1000,
}));

// Now, start recording data
const meter = meterProvider.getMeter('example-meter');
const counter = meter.createCounter('metric_name');
counter.add(10, { 'key': 'value' });

Running opentelemetry-collector locally to see the metrics

1. Go to examples/otlp-exporter-node
2. Follow the instructions there to observe the metrics.

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.