otlp-logger 1.1.1 → 1.1.2

package/README.md

@@ -1,4 +1,5 @@
 # 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/)
 
@@ -6,15 +7,17 @@ Sends logs in the [OpenTelemetry Log Data Model](https://github.com/open-telemet
 
 ## 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` 
+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
 
@@ -33,27 +36,30 @@ Set either of the following environment variables:
 #### 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)
 
+[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`: 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
@@ -62,7 +68,7 @@ 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:
@@ -89,7 +95,7 @@ service:
 
 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:latest --config=/etc/otel-collector-config.yaml
 ```
 
@@ -113,7 +119,7 @@ logger.emit({
 
 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
 ```
 

package/lib/create-log-processor.js

@@ -6,19 +6,6 @@ const {
   ConsoleLogRecordExporter
 } = require('@opentelemetry/sdk-logs')
 
-const { MultiLogRecordProcessor } = require('./multi-log-processor')
-
-/**
- * @param {LogRecordProcessorOptions | LogRecordProcessorOptions[]} [logRecordProcessorOptions]
- */
-function createLogProcessor (logRecordProcessorOptions) {
-  return Array.isArray(logRecordProcessorOptions)
-    ? new MultiLogRecordProcessor(
-      logRecordProcessorOptions.map(createLogRecordProcessor)
-    )
-    : createLogRecordProcessor(logRecordProcessorOptions)
-}
-
 /**
  * @typedef {"batch" | "simple"} RecordProcessorType
  * @typedef {Object} LogRecordProcessorOptions
@@ -29,7 +16,7 @@ function createLogProcessor (logRecordProcessorOptions) {
  * @param {LogRecordProcessorOptions} [opts]
  * @returns {import('@opentelemetry/sdk-logs').LogRecordProcessor}
  */
-function createLogRecordProcessor (opts) {
+function createLogProcessor (opts) {
   const exporter = createExporter(opts?.exporterOptions)
 
   if (opts?.recordProcessorType === 'simple') {

package/lib/otlp-logger.js

@@ -37,13 +37,17 @@ function getOtlpLogger (opts) {
     )
   })
 
-  loggerProvider.addLogRecordProcessor(
-    createLogProcessor(opts.logRecordProcessorOptions)
-  )
+  const logRecordProcessorOptionsArray = Array.isArray(opts.logRecordProcessorOptions) ? opts.logRecordProcessorOptions : [opts.logRecordProcessorOptions]
+
+  logRecordProcessorOptionsArray.forEach(logRecordProcessorOptions => {
+    loggerProvider.addLogRecordProcessor(
+      createLogProcessor(logRecordProcessorOptions)
+    )
+  })
 
   logs.setGlobalLoggerProvider(loggerProvider)
 
-  const logger = logs.getLogger(opts.loggerName, opts.serviceVersion)
+  const logger = loggerProvider.getLogger(opts.loggerName, opts.serviceVersion)
 
   return {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "otlp-logger",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Exports logs to OpenTelemetry Collector using OTLP protocol",
   "main": "lib/otlp-logger.js",
   "scripts": {
@@ -17,21 +17,20 @@
   "repository": "github:Vunovati/otlp-logger",
   "license": "MIT",
   "dependencies": {
-    "@opentelemetry/api-logs": "^0.48.0",
-    "@opentelemetry/core": "^1.17.0",
-    "@opentelemetry/exporter-logs-otlp-grpc": "^0.48.0",
-    "@opentelemetry/exporter-logs-otlp-http": "^0.48.0",
-    "@opentelemetry/exporter-logs-otlp-proto": "^0.48.0",
+    "@opentelemetry/api-logs": "^0.49.1",
+    "@opentelemetry/exporter-logs-otlp-grpc": "^0.49.1",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.49.1",
+    "@opentelemetry/exporter-logs-otlp-proto": "^0.49.1",
     "@opentelemetry/resources": "^1.17.0",
-    "@opentelemetry/sdk-logs": "^0.48.0"
+    "@opentelemetry/sdk-logs": "^0.49.1"
   },
   "types": "./types/otlp-logger.d.ts",
   "devDependencies": {
-    "@commitlint/cli": "^18.2.0",
-    "@commitlint/config-conventional": "^18.1.0",
+    "@commitlint/cli": "^19.0.3",
+    "@commitlint/config-conventional": "^19.0.3",
     "@opentelemetry/api": "^1.4.1",
-    "@opentelemetry/instrumentation-http": "^0.48.0",
-    "@opentelemetry/sdk-node": "^0.48.0",
+    "@opentelemetry/instrumentation-http": "^0.49.1",
+    "@opentelemetry/sdk-node": "^0.49.1",
     "@tapjs/sinon": "^1.1.16",
     "@types/node": "^20.8.2",
     "husky": "^9.0.10",

package/types/create-log-processor.d.ts

@@ -24,7 +24,14 @@ export type ConsoleExporterOptions = {
 };
 export type ExporterOptions = GrpcExporterOptions | HttpExporterOptions | ProtobufExporterOptions | ConsoleExporterOptions;
 /**
- * @param {LogRecordProcessorOptions | LogRecordProcessorOptions[]} [logRecordProcessorOptions]
+ * @typedef {"batch" | "simple"} RecordProcessorType
+ * @typedef {Object} LogRecordProcessorOptions
+ * @property {RecordProcessorType} recordProcessorType = "batch"
+ * @property {ExporterOptions} [exporterOptions]
+ * @property {import('@opentelemetry/sdk-logs').BufferConfig} [processorConfig]
+ *
+ * @param {LogRecordProcessorOptions} [opts]
+ * @returns {import('@opentelemetry/sdk-logs').LogRecordProcessor}
  */
-export function createLogProcessor(logRecordProcessorOptions?: LogRecordProcessorOptions | LogRecordProcessorOptions[]): import("@opentelemetry/sdk-logs").LogRecordProcessor;
+export function createLogProcessor(opts?: LogRecordProcessorOptions): import('@opentelemetry/sdk-logs').LogRecordProcessor;
 //# sourceMappingURL=create-log-processor.d.ts.map

package/types/create-log-processor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-log-processor.d.ts","sourceRoot":"","sources":["../lib/create-log-processor.js"],"names":[],"mappings":"kCAsBa,OAAO,GAAG,QAAQ;;;;;yBAEjB,mBAAmB;sBACnB,eAAe;sBACf,OAAO,yBAAyB,EAAE,YAAY;;;cAiB9C,MAAM;0BACN,OAAO,wCAAwC,EAAE,0BAA0B;;;cAG3E,MAAM;0BACN,OAAO,mCAAmC,EAAE,0BAA0B;;;cAGtE,eAAe;8BACf,OAAO,mCAAmC,EAAE,0BAA0B;;;cAGtE,SAAS;;8BAEV,mBAAmB,GAAG,mBAAmB,GAAG,uBAAuB,GAAG,sBAAsB;AA/CzG;;GAEG;AACH,+DAFW,yBAAyB,GAAG,yBAAyB,EAAE,wDAQjE"}
+{"version":3,"file":"create-log-processor.d.ts","sourceRoot":"","sources":["../lib/create-log-processor.js"],"names":[],"mappings":"kCASa,OAAO,GAAG,QAAQ;;;;;yBAEjB,mBAAmB;sBACnB,eAAe;sBACf,OAAO,yBAAyB,EAAE,YAAY;;;cAiB9C,MAAM;0BACN,OAAO,wCAAwC,EAAE,0BAA0B;;;cAG3E,MAAM;0BACN,OAAO,mCAAmC,EAAE,0BAA0B;;;cAGtE,eAAe;8BACf,OAAO,mCAAmC,EAAE,0BAA0B;;;cAGtE,SAAS;;8BAEV,mBAAmB,GAAG,mBAAmB,GAAG,uBAAuB,GAAG,sBAAsB;AApCzG;;;;;;;;;GASG;AACH,0CAHW,yBAAyB,GACvB,OAAO,yBAAyB,EAAE,kBAAkB,CAUhE"}

package/types/otlp-logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"otlp-logger.d.ts","sourceRoot":"","sources":["../lib/otlp-logger.js"],"names":[],"mappings":";gBAiBc,MAAM;oBACN,MAAM;gCACN,OAAO,wBAAwB,EAAE,yBAAyB,GAAG,OAAO,wBAAwB,EAAE,yBAAyB,EAAE;;;AAJvI;;;;;;;;GAQG;AACH,oCAFW,OAAO;IA0Bd;;OAEG;cADQ,OAAO,yBAAyB,EAAE,SAAS;;EASzD"}
+{"version":3,"file":"otlp-logger.d.ts","sourceRoot":"","sources":["../lib/otlp-logger.js"],"names":[],"mappings":";gBAiBc,MAAM;oBACN,MAAM;gCACN,OAAO,wBAAwB,EAAE,yBAAyB,GAAG,OAAO,wBAAwB,EAAE,yBAAyB,EAAE;;;AAJvI;;;;;;;;GAQG;AACH,oCAFW,OAAO;IA8Bd;;OAEG;cADQ,OAAO,yBAAyB,EAAE,SAAS;;EASzD"}

package/lib/multi-log-processor.js

@@ -1,38 +0,0 @@
-'use_strict'
-
-const { callWithTimeout } = require('@opentelemetry/core')
-
-// taken from https://github.com/open-telemetry/opentelemetry-js/blob/5fcd8cf136e2235903dde3df9ba03ced594f0e95/experimental/packages/sdk-logs/src/types.ts#L27C3-L27C26
-const FORCE_FLUSH_TIMEOUT_MILLIS = 30000
-/**
- * Using the MultiLogRecordProcessor from the sdk-logs package is currently not possible because it is not exported.
- * This should work as a drop-in replacement.
- */
-class MultiLogRecordProcessor {
-  constructor (processors, forceFlushTimeoutMillis) {
-    this.processors = processors
-    this.forceFlushTimeoutMillis = forceFlushTimeoutMillis
-  }
-
-  async forceFlush () {
-    const timeout = this.forceFlushTimeoutMillis
-    await Promise.all(
-      this.processors.map(processor =>
-        (FORCE_FLUSH_TIMEOUT_MILLIS, callWithTimeout)(
-          processor.forceFlush(),
-          timeout
-        )
-      )
-    )
-  }
-
-  onEmit (logRecord) {
-    this.processors.forEach(processors => processors.onEmit(logRecord))
-  }
-
-  async shutdown () {
-    await Promise.all(this.processors.map(processor => processor.shutdown()))
-  }
-}
-
-exports.MultiLogRecordProcessor = MultiLogRecordProcessor

package/types/multi-log-processor.d.ts

@@ -1,13 +0,0 @@
-/**
- * Using the MultiLogRecordProcessor from the sdk-logs package is currently not possible because it is not exported.
- * This should work as a drop-in replacement.
- */
-export class MultiLogRecordProcessor {
-    constructor(processors: any, forceFlushTimeoutMillis: any);
-    processors: any;
-    forceFlushTimeoutMillis: any;
-    forceFlush(): Promise<void>;
-    onEmit(logRecord: any): void;
-    shutdown(): Promise<void>;
-}
-//# sourceMappingURL=multi-log-processor.d.ts.map

package/types/multi-log-processor.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"multi-log-processor.d.ts","sourceRoot":"","sources":["../lib/multi-log-processor.js"],"names":[],"mappings":"AAMA;;;GAGG;AACH;IACE,2DAGC;IAFC,gBAA4B;IAC5B,6BAAsD;IAGxD,4BAUC;IAED,6BAEC;IAED,0BAEC;CACF"}