Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 6.78 KB

README.md

File metadata and controls

101 lines (76 loc) · 6.78 KB
Raw

OpenTelemetry Collector Logs Exporter for node with grpc

NPM Published Version Apache License

Note: This is an experimental package under active development. New releases may include breaking changes.

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

Installation

npm install --save @opentelemetry/exporter-logs-otlp-grpc

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 documentation and sample code for the traces exporter, as well as instructions for using TLS, visit the Collector Trace Exporter for web and node. To see documentation and sample code for the metric exporter, see the exporter-metrics-otlp-grpc package

Logs in Node - GRPC

The OTLPLogsExporter in Node expects the URL to only be the hostname. It will not work with /v1/logs. All options that work with trace also work with logs.

import {
  LoggerProvider,
  SimpleLogRecordProcessor,
} from '@opentelemetry/sdk-logs';
import { OTLPLogsExporter } from '@opentelemetry/exporter-logs-otlp-grpc';

const collectorOptions = {
  // url is optional and can be omitted - default is http://localhost:4317
  url: 'http://<collector-hostname>:<port>',
};

const loggerExpoter = new OTLPLogsExporter(collectorOptions);
const loggerProvider = new LoggerProvider();

loggerProvider.addLogRecordProcessor(
  new SimpleLogRecordProcessor(loggerExpoter)
);

['SIGINT', 'SIGTERM'].forEach(signal => {
  process.on(signal, () => loggerProvider.shutdown().catch(console.error));
});

// logging
const logger = loggerProvider.getLogger('example-logger');
logger.emit({ body: 'example-log' });

Environment Variable Configuration

Environment variable Description
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT The endpoint to send logs to. By default localhost:4317 will be used.
OTEL_EXPORTER_OTLP_ENDPOINT The endpoint to send trace, metric, and logs to. By default localhost:4317 will be used.
OTEL_EXPORTER_OTLP_LOGS_COMPRESSION The compression type to use on OTLP logs requests. Options include gzip. By default no compression will be used.
OTEL_EXPORTER_OTLP_COMPRESSION The compression type to use on OTLP trace, metric, and log requests. Options include gzip. By default no compression will be used.
OTEL_EXPORTER_OTLP_LOGS_INSECURE Whether to enable client transport security for the exporter's gRPC connection for logs requests. This option only applies to OTLP/gRPC when an endpoint is provided without the http or https scheme. Options include true or false. By default insecure is false which creates a secure connection.
OTEL_EXPORTER_OTLP_INSECURE Whether to enable client transport security for the exporter's gRPC connection for trace, metric and log requests. This option only applies to OTLP/gRPC when an endpoint is provided without the http or https scheme. Options include true or false. By default insecure is false which creates a secure connection.
OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE The path to the file containing trusted root certificate to use when verifying an OTLP logs server's TLS credentials. By default the host platform's trusted root certificate is used.
OTEL_EXPORTER_OTLP_CERTIFICATE The path to the file containing trusted root certificate to use when verifying an OTLP trace, metric, or log server's TLS credentials. By default the host platform's trusted root certificate is used.
OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY The path to the file containing private client key to use when verifying an OTLP logs client's TLS credentials. Must provide a client certificate/chain when providing a private client key. By default no client key file is used.
OTEL_EXPORTER_OTLP_CLIENT_KEY The path to the file containing private client key to use when verifying an OTLP trace, metric or log client's TLS credentials. Must provide a client certificate/chain when providing a private client key. By default no client key file is used.
OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE The path to the file containing trusted client certificate/chain for clients private key to use when verifying an OTLP logs server's TLS credentials. Must provide a private client key when providing a certificate/chain. By default no chain file is used.
OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE The path to the file containing trusted client certificate/chain for clients private key to use when verifying an OTLP trace, metric and log server's TLS credentials. Must provide a private client key when providing a certificate/chain. By default no chain file is used.
OTEL_EXPORTER_OTLP_LOGS_TIMEOUT The maximum waiting time, in milliseconds, allowed to send each OTLP logs batch. Default is 10000.
OTEL_EXPORTER_OTLP_TIMEOUT The maximum waiting time, in milliseconds, allowed to send each OTLP trace and metric batch. Default is 10000.

Settings configured programmatically take precedence over environment variables. Per-signal environment variables take precedence over non-per-signal environment variables.

Running opentelemetry-collector locally to see the logs

  1. Go to examples/otlp-exporter-node
  2. Follow the instructions there to view logs.

Useful links

License

Apache 2.0 - See LICENSE for more information.