@breadstone/archipel-platform-telemetry 0.0.22 → 0.0.24

package/README.md

@@ -1,28 +1,50 @@
 # @breadstone/archipel-platform-telemetry
 
-Application monitoring, metrics, and telemetry infrastructure.
+Application monitoring, metrics, and distributed tracing infrastructure for NestJS.
+
+## Features
+
+- **Metrics collection** — Counter, histogram, and gauge recording via `TelemetryFacade`
+- **Distributed tracing** — OpenTelemetry SDK integration with automatic span creation
+- **Operation interceptor** — `OperationTelemetryInterceptor` wraps controller methods in telemetry operations
+- **Graceful degradation** — Falls back to `NoopTelemetryFacade` when disabled — zero overhead
+- **Health checks** — Integration with health module for observability readiness
+- **Structured logging** — `TelemetryLoggerService` with request correlation IDs
+- **Eager metric init** — `MetricsService` creates instruments at startup via `OnModuleInit`
+- **Write-once SDK guard** — `OtelSdkHolder` prevents accidental double-initialization of the OpenTelemetry SDK
+- **Shutdown timeout** — SDK shutdown is capped at 5 seconds to prevent hanging processes
 
 ## Quick Start
 
 ```typescript
 import { TelemetryModule } from '@breadstone/archipel-platform-telemetry';
+
+@Module({
+  imports: [TelemetryModule],
+})
+export class AppModule {}
 ```
 
-## Documentation
+## Lifecycle
 
-📖 **Telemetry Guide:** [`.docs/guides/telemetry-and-observability.md`](../../.docs/guides/telemetry-and-observability.md)
+- **Startup (`OnModuleInit`):** `MetricsService` creates metric instruments eagerly.
+- **Shutdown:** SDK shutdown is capped at 5 seconds to prevent hanging processes.
 
-## Features
+## Peer Dependencies
+
+| Package                                     | Required | Notes             |
+| ------------------------------------------- | -------- | ----------------- |
+| `@nestjs/common`                            | Yes      | NestJS core       |
+| `@nestjs/core`                              | Yes      | NestJS core       |
+| `@opentelemetry/api`                        | Yes      | OpenTelemetry API |
+| `@opentelemetry/sdk-node`                   | Yes      | OpenTelemetry SDK |
+| `@opentelemetry/exporter-metrics-otlp-http` | Yes      | Metrics exporter  |
+| `@opentelemetry/exporter-trace-otlp-http`   | Yes      | Trace exporter    |
+| `rxjs`                                      | Yes      | Reactive streams  |
 
-- **Metrics collection**: Counter, histogram, and gauge recording via `TelemetryFacade`
-- **Distributed tracing**: OpenTelemetry SDK integration with automatic span creation
-- **Operation interceptor**: `OperationTelemetryInterceptor` wraps controller methods in telemetry operations (returns `Observable<unknown>`)
-- **Graceful degradation**: Falls back to `NoopTelemetryFacade` when disabled — zero overhead
-- **Health checks**: Integration with health module for observability readiness
-- **Structured logging**: `TelemetryLoggerService` with request correlation IDs
-- **Eager metric init**: `MetricsService` creates instruments at startup via `OnModuleInit`
-- **Write-once SDK guard**: `OtelSdkHolder` prevents accidental double-initialization of the OpenTelemetry SDK
-- **Shutdown timeout**: SDK shutdown is capped at 5 seconds to prevent hanging processes
+## Documentation
+
+📖 **Telemetry Guide:** [`.docs/guides/telemetry-and-observability.md`](../../.docs/guides/telemetry-and-observability.md)
 
 ## Development
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breadstone/archipel-platform-telemetry",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "description": "OpenTelemetry integration with tracing, metrics, and graceful no-op fallback for NestJS.",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -28,8 +28,8 @@
     "README.md"
   ],
   "dependencies": {
-    "@breadstone/archipel-platform-caching": "0.0.22",
-    "@breadstone/archipel-platform-core": "0.0.22",
+    "@breadstone/archipel-platform-caching": "0.0.24",
+    "@breadstone/archipel-platform-core": "0.0.24",
     "tslib": "2.8.1"
   },
   "peerDependencies": {

package/src/OtelSdkHolder.d.ts

@@ -12,7 +12,7 @@ export declare class OtelSdkHolder implements OnApplicationShutdown {
     private _sdk?;
     /**
      * Stores the SDK reference so it can be shut down later.
-     * Can only be called once — subsequent calls are ignored.
+     * Can only be called once - subsequent calls are ignored.
      */
     setSdk(sdk: unknown): void;
     /** @inheritdoc */

package/src/OtelSdkHolder.js

@@ -24,11 +24,11 @@ let OtelSdkHolder = OtelSdkHolder_1 = class OtelSdkHolder {
     // #region Methods
     /**
      * Stores the SDK reference so it can be shut down later.
-     * Can only be called once — subsequent calls are ignored.
+     * Can only be called once - subsequent calls are ignored.
      */
     setSdk(sdk) {
         if (this._sdk) {
-            this._logger.warn('OtelSdkHolder.setSdk() called more than once — ignoring.');
+            this._logger.warn('OtelSdkHolder.setSdk() called more than once - ignoring.');
             return;
         }
         this._sdk = sdk;