Socket
Socket
Sign inDemoInstall

@opentelemetry/exporter-logs-otlp-grpc

Package Overview
Dependencies
5
Maintainers
0
Versions
21
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/exporter-logs-otlp-grpc


Version published
Maintainers
0
Install size
21.8 MB
Created

Readme

Source

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 a logs-exporter for OTLP (gRPC) using protocol version v0.20.0.

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 OTLPLogExporter 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,
  BatchLogRecordProcessor,
} from '@opentelemetry/sdk-logs';
import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-grpc';

const collectorOptions = {
  // url is optional and can be omitted - default is http://localhost:4317
  // Unix domain sockets are also supported: 'unix:///path/to/socket.sock'
  url: 'http://<collector-hostname>:<port>',
};

const loggerExporter = new OTLPLogExporter(collectorOptions);
const loggerProvider = new LoggerProvider();

loggerProvider.addLogRecordProcessor(
  new BatchLogRecordProcessor(loggerExporter)
);

['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 variableDescription
OTEL_EXPORTER_OTLP_LOGS_ENDPOINTThe endpoint to send logs to. By default localhost:4317 will be used.
OTEL_EXPORTER_OTLP_ENDPOINTThe endpoint to send trace, metric, and logs to. By default localhost:4317 will be used.
OTEL_EXPORTER_OTLP_COMPRESSIONThe compression type to use on OTLP trace, metric, and log requests. Options include gzip. By default no compression will be used.
OTEL_EXPORTER_OTLP_INSECUREWhether 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_CERTIFICATEThe 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_CLIENT_KEYThe 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_CLIENT_CERTIFICATEThe 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_TIMEOUTThe 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.

License

Apache 2.0 - See LICENSE for more information.

Keywords

FAQs

Last updated on 20 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc