Package Exports
- @opentelemetry/sdk-logs
- @opentelemetry/sdk-logs/build/esm
- @opentelemetry/sdk-logs/build/esm/index.js
- @opentelemetry/sdk-logs/build/esnext
- @opentelemetry/sdk-logs/build/esnext/index.js
- @opentelemetry/sdk-logs/build/src/index.js
- @opentelemetry/sdk-logs/build/src/internal/LoggerProviderSharedState.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@opentelemetry/sdk-logs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
OpenTelemetry Logs SDK
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
npm install --save @opentelemetry/api-logs
npm install --save @opentelemetry/sdk-logsUsage
The basic setup of the SDK can be seen as followings:
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.
const loggerProvider = new LoggerProvider();
// Add a processor to export log record
loggerProvider.addLogRecordProcessor(
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
License
Apache 2.0 - See LICENSE for more information.