Merge branch 'main' of github.com:zonneplan/open-telemetry-js

.github/workflows/ci-release.yml

@@ -44,7 +44,10 @@ jobs:
         run: |
           git add .
           git commit -m "chore(release): bump version to ${{ steps.get_tag.outputs.tag }}"
-          git tag -a ${{ steps.get_tag.outputs.tag }} -m "chore(release): ${{ steps.get_tag.outputs.tag }}"
+          git push
+
+          git tag ${{ steps.get_tag.outputs.tag }}
+          git push origin ${{ steps.get_tag.outputs.tag }}
 
       # Order matters for the publishing, packages with dependencies should be published last
       - name: Publish package

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.1.0](https://github.com/zonneplan/open-telemetry-js/compare/v1.0.2...v1.1.0) (2024-10-08)
+
+
+### Features
+
+* use diag error logging for uninitialized providers ([577e1d4](https://github.com/zonneplan/open-telemetry-js/commit/577e1d47578616c62d0514709144b3d704f3bd63))
+
+## [1.0.2](https://github.com/zonneplan/open-telemetry-js/compare/v1.0.1...v1.0.2) (2024-10-03)
+
+## [1.0.1](https://github.com/zonneplan/open-telemetry-js/compare/v1.0.0...v1.0.1) (2024-10-03)
+
 ## [1.0.0](https://github.com/zonneplan/open-telemetry-js/compare/v0.1.0...v1.0.0) (2024-07-05)
 
 

libs/dependency-syncer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zonneplan/dependency-syncer",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "dependencies": {
     "@nx/devkit": "18.0.8",
     "tslib": "^2.3.0"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zonneplan/open-telemetry-js",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "license": "MIT",
   "scripts": {
     "prepare": "([ \"$NODE_ENV\" = \"production\" ] || husky .git-hooks)"

packages/open-telemetry-nest/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@zonneplan/open-telemetry-nest",
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "dependencies": {
     "@nestjs/common": "^10.3.10",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/api-logs": "^0.52.1",
     "@opentelemetry/exporter-prometheus": "^0.52.1",
     "@opentelemetry/sdk-metrics": "^1.25.1",
-    "@zonneplan/open-telemetry-node": "^1.0.0",
+    "@zonneplan/open-telemetry-node": "^1.1.0",
     "prom-client": "^15.1.3",
     "tslib": "^2.6.3",
     "winston": "^3.13.0"

packages/open-telemetry-nest/src/logging/adapters/nest-winston-logger.adapter.ts

@@ -3,7 +3,7 @@ import { Logger } from 'winston';
 import { GlobalProviders } from '@zonneplan/open-telemetry-node';
 import { LogAttributes, SeverityNumber } from '@opentelemetry/api-logs';
 import { LoggerService } from '../services/logger.service';
-import { context } from '@opentelemetry/api';
+import { context, diag } from '@opentelemetry/api';
 import {
   NEST_LOG_LEVEL_WINSTON_SEVERITY,
   SEVERITY_NUMBER_TO_TEXT_MAP,
@@ -126,7 +126,7 @@ export class NestWinstonLoggerAdapter extends LoggerService {
     }
 
     if (!GlobalProviders.logProvider) {
-      console.error('OpenTelemetry log provider not initialized');
+      diag.error('OpenTelemetry log provider not initialized');
       return;
     }
 

packages/open-telemetry-node/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zonneplan/open-telemetry-node",
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/api-logs": "^0.52.1",

packages/open-telemetry-node/src/core/builders/open-telemetry.builder.ts

@@ -30,12 +30,6 @@ import { NodeSDK } from '@opentelemetry/sdk-node';
 import { MeterProvider } from '@opentelemetry/sdk-metrics';
 
 export interface IOpenTelemetryBuilder {
-  /**
-   * @deprecated - will be removed in v1.1, use {@link withDiagLogging} instead.
-   *  for identical behaviour use `withDiagLogging(DiagLogLevel.DEBUG)`
-   */
-  withDebugLogging(): this;
-
   /**
    * Enables diagnostic logging with the specified level.
    * @param level
@@ -98,12 +92,6 @@ export class OpenTelemetryBuilder implements IOpenTelemetryBuilder {
     return this;
   }
 
-  /** @inheritdoc */
-  public withDebugLogging(): this {
-    this.diagLogLevel = DiagLogLevel.DEBUG;
-    return this;
-  }
-
   public withLogging(
     optionsBuilder: OptionsBuilderFn<IOpenTelemetryLoggingOptionsBuilder>
   ): this;

packages/open-telemetry-node/src/metrics/metrics/gauge.spec.ts

@@ -24,58 +24,6 @@ describe('Gauge', () => {
     jest.useFakeTimers().setSystemTime(currentDate.getTime());
   });
 
-  describe('set', () => {
-    it('should set the correct count and attributes when set is called', async () => {
-      // Arrange
-      const value = 5;
-      const attributes = { test: 'test' };
-
-      // Act
-      gauge?.set(value, attributes);
-
-      // Assert
-      const metrics = await getMetrics();
-      const metricDescriptor = metrics?.descriptor;
-      expect(metricDescriptor?.name).toEqual(metricName);
-
-      const dataPoints = metrics?.dataPoints;
-      expect(dataPoints).toHaveLength(1);
-
-      const gaugeData = dataPoints?.[0];
-      expect(gaugeData?.value).toEqual(value);
-      expect(gaugeData?.attributes).toEqual(attributes);
-    });
-
-    it('should set multiple data points for the same metric when set is called multiple times with different attributes', async () => {
-      // Arrange
-      const attributes2 = { test: 'test' };
-      const attributes3 = { test: 'test2' };
-
-      // Act
-      gauge?.set(1);
-      gauge?.set(2, attributes2);
-      gauge?.set(3, attributes3);
-
-      // Assert
-      const metrics = await getMetrics();
-      const metricDescriptor = metrics?.descriptor;
-      expect(metricDescriptor?.name).toEqual(metricName);
-
-      const dataPoints = metrics?.dataPoints;
-      expect(dataPoints).toHaveLength(3);
-
-      const [gaugeData, gaugeData2, gaugeData3] = dataPoints ?? [];
-      expect(gaugeData?.value).toEqual(1);
-      expect(gaugeData?.attributes).toEqual({});
-
-      expect(gaugeData2?.value).toEqual(2);
-      expect(gaugeData2?.attributes).toEqual(attributes2);
-
-      expect(gaugeData3?.value).toEqual(3);
-      expect(gaugeData3?.attributes).toEqual(attributes3);
-    });
-  });
-
   describe('record', () => {
     it('should set the correct count and attributes when set is called', async () => {
       // Arrange

packages/open-telemetry-node/src/metrics/metrics/gauge.ts

@@ -15,13 +15,6 @@ export class Gauge {
     this.record(Date.now() / 1000, attributes);
   }
 
-  /**
-   * @deprecated use {@link record} instead. Will be removed in version 1.1.
-   */
-  public set(value: number, attributes?: Attributes): void {
-    this.gauge.record(value, attributes);
-  }
-
   /**
    * Records the value to the gauge.
    * @param value the value to record.

packages/open-telemetry-node/src/metrics/metrics/get-or-create-metric.ts

@@ -1,5 +1,6 @@
 import { MetricOptions, MetricTypeMap } from '../models/metric-options.model';
 import { GlobalProviders } from '../../globals';
+import { diag } from '@opentelemetry/api';
 
 /**
  * Gets a metric if exists, otherwise creates a new metric.
@@ -12,7 +13,7 @@ export const getOrCreateMetric = <
   options: MetricOptions<TMetricType>
 ): TMetric | null => {
   if (!GlobalProviders.metricProvider) {
-    console.error('OpenTelemetry metrics are not initialized');
+    diag.error('OpenTelemetry metrics are not initialized');
     return null;
   }
 

packages/open-telemetry-zonneplan/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zonneplan/open-telemetry-zonneplan",
   "license": "MIT",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "dependencies": {
     "@nestjs/common": "^10.3.10",
     "@opentelemetry/auto-instrumentations-node": "^0.47.1",
@@ -13,8 +13,8 @@
     "@opentelemetry/instrumentation-winston": "^0.38.0",
     "@opentelemetry/sdk-metrics": "^1.25.1",
     "@opentelemetry/sdk-trace-base": "^1.25.1",
-    "@zonneplan/open-telemetry-nest": "^1.0.0",
-    "@zonneplan/open-telemetry-node": "^1.0.0",
+    "@zonneplan/open-telemetry-nest": "^1.1.0",
+    "@zonneplan/open-telemetry-node": "^1.1.0",
     "opentelemetry-instrumentation-kafkajs": "^0.41.0",
     "tslib": "^2.6.3",
     "winston": "^3.13.0"