OpenTelemetry Logs SDK

[![NPM Published Version][npm-img]][npm-url]

[![Apache License][license-image]][license-image]

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

OpenTelemetry logs module contains the foundation for all logs SDKs of opentelemetry-js.

Used standalone, this module provides methods for manual instrumentation of code, offering full control over recording logs for client-side JavaScript (browser) and Node.js.

It does not provide automated instrumentation of known libraries or host environment logs out-of-the-box.

Installation

```bash

npm install --save @opentelemetry/api-logs

npm install --save @opentelemetry/sdk-logs

```

Usage

The basic setup of the SDK can be seen as followings:

```js

const logsAPI = require('@opentelemetry/api-logs');

const {

LoggerProvider,

SimpleLogRecordProcessor,

ConsoleLogRecordExporter,

} = require('@opentelemetry/sdk-logs');

// To start a logger, you first need to initialize the Logger provider.

// and add a processor to export log record

const loggerProvider = new LoggerProvider({

processors: [new SimpleLogRecordProcessor(new ConsoleLogRecordExporter())]

});

// To create a log record, you first need to get a Logger instance

const logger = loggerProvider.getLogger('default');

// You can also use global singleton

logsAPI.logs.setGlobalLoggerProvider(loggerProvider);

const logger = logsAPI.logs.getLogger('default');

// emit a log record

logger.emit({

severityNumber: logsAPI.SeverityNumber.INFO,

severityText: 'INFO',

body: 'this is a log record body',

attributes: { 'log.type': 'LogRecord' },

});

```

Config

Logs configuration is a merge of both the user supplied configuration and the default

configuration as specified in config.ts

Example

See examples/logs

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][discussions-url]

License

Apache 2.0 - See [LICENSE][license-url] for more information.

[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions

[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE

[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat

[npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-logs

[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fsdk%2Dlogs.svg

README.​md