@devopsplaybook.io/otel-utils 1.4.0 → 1.5.0-beta.33.0612f7c

package/README.md

@@ -121,7 +121,7 @@ const cpuGauge = meter.createObservableGauge(
 
 - `createCounter(key)` — Creates a `Counter` with name `${serviceName}.${key}`.
 - `createUpDownCounter(key)` — Creates an `UpDownCounter`.
-- `createHistogram(key)` — Creates a `Histogram`.
+- `createHistogram(key, options?)` — Creates a `Histogram` named `${serviceName}.${key}`; with `{ unprefixed: true }` the histogram is created exactly as `key`, without the service-name prefix.
 - `createObservableGauge(key, callback, description?)` — Creates an `ObservableGauge` with a callback. Description is optional.
 - `shutdown()` — Flushes buffered metrics and shuts the meter provider down.
 

package/dist/src/StandardMeter.d.ts

@@ -1,5 +1,15 @@
 import { Counter, Histogram, ObservableGauge, UpDownCounter } from "@opentelemetry/api";
 import { ConfigOTelInterface } from "./models/ConfigOTelInterface";
+/**
+ * Options accepted by {@link StandardMeter.createHistogram}.
+ */
+export interface StandardMeterCreateHistogramOptions {
+    /**
+     * Create the histogram without the `${serviceName}.` prefix:
+     * exported exactly as `key`.
+     */
+    unprefixed?: boolean;
+}
 export declare class StandardMeter {
     private meter;
     private meterProvider;
@@ -9,6 +19,6 @@ export declare class StandardMeter {
     shutdown(): Promise<void>;
     createCounter(key: string): Counter;
     createUpDownCounter(key: string): UpDownCounter;
-    createHistogram(key: string): Histogram;
+    createHistogram(key: string, options?: StandardMeterCreateHistogramOptions): Histogram;
     createObservableGauge(key: string, callback: (observableResult: any) => void, description?: string): ObservableGauge;
 }

package/dist/src/StandardMeter.js

@@ -46,8 +46,8 @@ class StandardMeter {
     createUpDownCounter(key) {
         return this.meter.createUpDownCounter(`${this.serviceName}.${key}`);
     }
-    createHistogram(key) {
-        return this.meter.createHistogram(`${this.serviceName}.${key}`);
+    createHistogram(key, options) {
+        return this.meter.createHistogram((options === null || options === void 0 ? void 0 : options.unprefixed) ? key : `${this.serviceName}.${key}`);
     }
     createObservableGauge(key, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devopsplaybook.io/otel-utils",
-  "version": "1.4.0",
+  "version": "1.5.0-beta.33.0612f7c",
   "description": "Utility to simplify integration with Open Telemetry",
   "keywords": [
     "Open",

package/src/StandardMeter.spec.ts

@@ -97,6 +97,24 @@ describe("StandardMeter", () => {
     );
   });
 
+  it("creates a histogram without the service-name prefix when the unprefixed option is set", async () => {
+    const meter = new StandardMeter({
+      SERVICE_ID: "metric-service",
+      VERSION: "1.0.0",
+      OPENTELEMETRY_COLLECTOR_HTTP_METRICS: "http://collector:4318/v1/metrics",
+    });
+
+    meter.createHistogram("session.duration", { unprefixed: true }).record(1);
+    meter.createHistogram("requests.latency").record(42);
+
+    await meter.shutdown();
+
+    const names = metricNames(lastExporter());
+    expect(names).toContain("session.duration");
+    expect(names).toContain("metric-service.requests.latency");
+    expect(names).not.toContain("metric-service.session.duration");
+  });
+
   it("works without a collector and without a gauge description", async () => {
     const meter = new StandardMeter({
       SERVICE_ID: "metric-service",

package/src/StandardMeter.ts

@@ -13,6 +13,17 @@ import {
 } from "@opentelemetry/sdk-metrics";
 import { ConfigOTelInterface } from "./models/ConfigOTelInterface";
 
+/**
+ * Options accepted by {@link StandardMeter.createHistogram}.
+ */
+export interface StandardMeterCreateHistogramOptions {
+  /**
+   * Create the histogram without the `${serviceName}.` prefix:
+   * exported exactly as `key`.
+   */
+  unprefixed?: boolean;
+}
+
 export class StandardMeter {
   private meter: Meter;
   private meterProvider: MeterProvider;
@@ -66,8 +77,13 @@ export class StandardMeter {
     return this.meter.createUpDownCounter(`${this.serviceName}.${key}`);
   }
 
-  public createHistogram(key: string): Histogram {
-    return this.meter.createHistogram(`${this.serviceName}.${key}`);
+  public createHistogram(
+    key: string,
+    options?: StandardMeterCreateHistogramOptions,
+  ): Histogram {
+    return this.meter.createHistogram(
+      options?.unprefixed ? key : `${this.serviceName}.${key}`,
+    );
   }
 
   public createObservableGauge(