https://github.com/vunovati/otlp-logger

https://github.com/vunovati/otlp-logger

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/vunovati/otlp-logger
• Owner: Vunovati
• License: mit
• Created: 2023-11-19T17:21:13.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-14T16:31:44.000Z (about 2 months ago)
• Last Synced: 2025-04-14T16:51:37.632Z (about 2 months ago)
• Language: JavaScript
• Size: 124 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# otlp-logger

[![npm version](https://img.shields.io/npm/v/otlp-logger)](https://www.npmjs.com/package/otlp-logger)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)

Sends logs in the [OpenTelemetry Log Data Model](https://github.com/open-telemetry/opentelemetry-specification/blob/fc8289b8879f3a37e1eba5b4e445c94e74b20359/specification/logs/data-model.md) to an OTLP logs collector.

## Install

```bash

npm i otlp-logger

```

## Configuration

### Protocol

can be set to `http/protobuf`, `grpc`, `http` or `console` by using

* env var `OTEL_EXPORTER_OTLP_PROTOCOL`

* env var `OTEL_EXPORTER_OTLP_LOGS_PROTOCOL`

* setting the exporterProtocol option

Settings configured programmatically take precedence over environment variables. Per-signal environment variables take precedence over non-per-signal environment variables. This principle applies to all the configurations in this module.

If no protocol is specified, `http/protobuf` is used as a default.

### Exporter settings

#### Collector URL

Set either of the following environment variables:

`OTEL_EXPORTER_OTLP_LOGS_ENDPOINT`,

`OTEL_EXPORTER_OTLP_ENDPOINT`

#### Protocol-specific exporter configuration

#### `http/protobuf`

[Env vars in README](https://github.com/open-telemetry/opentelemetry-js/blob/d4a41bd815dd50703f692000a70c59235ad71959/experimental/packages/exporter-trace-otlp-proto/README.md#exporter-timeout-configuration)

#### `grpc`

[Environment Variable Configuration](https://github.com/open-telemetry/opentelemetry-js/blob/d4a41bd815dd50703f692000a70c59235ad71959/experimental/packages/exporter-logs-otlp-grpc/README.md#environment-variable-configuration)

#### `http`

[Env vars in README](https://github.com/open-telemetry/opentelemetry-js/blob/d4a41bd815dd50703f692000a70c59235ad71959/experimental/packages/exporter-trace-otlp-http/README.md#configuration-options-as-environment-variables)

#### Processor-specific configuration

If batch log processor is selected (is default), it can be configured using env vars described in the [OpenTelemetry specification](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#batch-logrecord-processor)

### Options

When using the transport, the following options can be used to configure the transport programmatically:

* `loggerName`: name to be used by the OpenTelemetry logger

* `serviceVersion`: version to be used by the OpenTelemetry logger

* `resourceAttributes`: Object containing [resource attributes](https://opentelemetry.io/docs/instrumentation/js/resources/). Optional

* `logRecordProcessorOptions`: a single object or an array of objects specifying the LogProcessor and LogExporter types and constructor params. Optional

## Usage

### Minimalistic example

Make sure you have access to an OTEL collector.

To start quickly, create a minimal configuration for OTEL collector in the `otel-collector-config.yaml` file:

```yaml

receivers:

  otlp:

    protocols:

      grpc:

exporters:

  file:

    path: ./etc/test-logs/otlp-logs.log

    flush_interval: 1

  logging:

    verbosity: basic

  

processors:

  batch:

service:

  pipelines:

    logs:

      receivers: [otlp]

      processors: []

      exporters: [logging, file]

```

The collector can then be ran with:

```bash

docker run --volume=$(pwd)/otel-collector-config.yaml:/etc/otel-collector-config.yaml:rw --volume=/tmp/test-logs:/etc/test-logs:rw -p 4317:4317 -d otel/opentelemetry-collector-contrib:0.103.1 --config=/etc/otel-collector-config.yaml

```

Create an index.js file containing

```js

const { getOtlpLogger } = require('otlp-logger')

const logger = getOtlpLogger({

  loggerName: 'test',

  serviceVersion: '1.0.0'

})

logger.emit({

  severityNumber: 1,

  severityText: 'TRACE',

  body: 'test',

  timestamp: Date.now()

})

```

Run the service setting the `OTEL_EXPORTER_OTLP_LOGS_ENDPOINT` and `OTEL_RESOURCE_ATTRIBUTES` env vars

```bash

OTEL_EXPORTER_OTLP_LOGS_PROTOCOL='grpc' OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://localhost:4317 OTEL_RESOURCE_ATTRIBUTES="service.name=my-service,service.version=1.2.3" node index.js

```

## License

MIT