@backendkit-labs/observability 0.1.0 → 0.1.1

package/LICENSE

@@ -0,0 +1,184 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and the Work's derivative works.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and subsequently
+      incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, and
+      distribute Your modifications, or for such Derivative Works as a
+      whole, subject to the terms and conditions of this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024-2026 Mairon José Cuello Martínez
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

package/README.md

@@ -1,367 +1,367 @@
-# @backendkit-labs/observability
-
-Structured logging, distributed tracing correlation, metrics shipping, performance interceptors, and exception handling for **NestJS** — with optional OpenTelemetry integration.
-
-## Features
-
-| Feature | Description |
-|---|---|
-| **CorrelationIdService** | AsyncLocalStorage-based correlation ID propagation across the full async call stack |
-| **LoggerService** | Winston-backed structured logger with optional batched HTTP transport |
-| **MetricsService** | Fire-and-forget metric event shipping with buffering and circuit breaker |
-| **CorrelationInterceptor** | Reads/generates `x-correlation-id` and sets it on the response header |
-| **PerformanceInterceptor** | Logs and records HTTP request duration for every route |
-| **AllExceptionsFilter** | Unified error response shape with pluggable error mappers |
-| **@TrackPerformance** | Method decorator that wraps any async method in an OTel span |
-| **OTel optional** | `@opentelemetry/api` is a peer — drop it and everything becomes a no-op |
-
----
-
-## Installation
-
-```bash
-npm install @backendkit-labs/observability
-
-# optional — only if you use OTel tracing
-npm install @opentelemetry/api
-```
-
----
-
-## Quick start
-
-```typescript
-// app.module.ts
-import { Module }              from '@nestjs/common';
-import { ObservabilityModule } from '@backendkit-labs/observability';
-
-@Module({
-  imports: [
-    ObservabilityModule.forRoot({
-      serviceName: 'my-api',
-      environment: 'production',
-      logLevel:    'info',
-
-      // Ship logs to a remote endpoint (optional)
-      http: {
-        url:       'https://logs.example.com/ingest',
-        authToken: process.env.OBS_AUTH_TOKEN,
-      },
-
-      // Ship metrics to a remote endpoint (optional)
-      metrics: {
-        url:       'https://metrics.example.com/ingest',
-        authToken: process.env.OBS_AUTH_TOKEN,
-      },
-    }),
-  ],
-})
-export class AppModule {}
-```
-
-Register interceptors and the exception filter globally in `main.ts`:
-
-```typescript
-import { NestFactory }              from '@nestjs/core';
-import {
-  CorrelationInterceptor,
-  PerformanceInterceptor,
-  AllExceptionsFilter,
-  LoggerService,
-} from '@backendkit-labs/observability';
-import { AppModule }                from './app.module';
-
-async function bootstrap() {
-  const app = await NestFactory.create(AppModule);
-
-  app.useGlobalInterceptors(
-    app.get(CorrelationInterceptor),
-    app.get(PerformanceInterceptor),
-  );
-
-  app.useGlobalFilters(app.get(AllExceptionsFilter));
-
-  // Use LoggerService as the NestJS application logger
-  app.useLogger(app.get(LoggerService));
-
-  await app.listen(3000);
-}
-bootstrap();
-```
-
----
-
-## ObservabilityModule.forRoot options
-
-```typescript
-interface ObservabilityOptions {
-  serviceName:  string;
-  environment?: string;           // default: "production"
-  logLevel?:    'error' | 'warn' | 'info' | 'http' | 'verbose' | 'debug' | 'silly';
-  http?:        HttpTransportOptions;
-  metrics?:     MetricsOptions;
-}
-```
-
-### HTTP log transport options
-
-```typescript
-interface HttpTransportOptions {
-  url:              string;
-  authToken?:       string;
-  headers?:         Record<string, string>;
-  batchSize?:       number;   // default 100
-  maxBufferSize?:   number;   // default 2000
-  flushIntervalMs?: number;   // default 5000
-  timeoutMs?:       number;   // default 5000
-  circuitBreaker?:  Partial<CircuitBreakerConfig>; // see below
-}
-```
-
-### Metrics transport options
-
-```typescript
-interface MetricsOptions {
-  url:              string;
-  authToken?:       string;
-  headers?:         Record<string, string>;
-  flushIntervalMs?: number;   // default 10000
-  maxBufferSize?:   number;   // default 5000
-  timeoutMs?:       number;   // default 5000
-  circuitBreaker?:  Partial<CircuitBreakerConfig>; // see below
-}
-```
-
----
-
-## CorrelationIdService
-
-Propagates a request-scoped correlation ID through every `await` using `AsyncLocalStorage`.
-
-```typescript
-@Injectable()
-export class OrdersService {
-  constructor(private readonly correlation: CorrelationIdService) {}
-
-  async processOrder(id: string) {
-    // Always returns the ID for the current request context
-    const cid = this.correlation.get();
-
-    // Or undefined when called outside a context
-    const maybeId = this.correlation.getOrUndefined();
-
-    // OTel trace/span IDs (undefined when OTel not installed)
-    const trace = this.correlation.getTraceContext();
-    // => { traceId: 'abc…', spanId: '123…' } | undefined
-  }
-}
-```
-
-The `CorrelationInterceptor` automatically seeds the context from the incoming `x-correlation-id` header (or generates a fresh UUID) and echoes the ID back in the response header.
-
----
-
-## LoggerService
-
-Drop-in replacement for NestJS's built-in logger. All log entries include `service`, `environment`, and `correlationId` automatically.
-
-```typescript
-@Injectable()
-export class PaymentsService {
-  constructor(private readonly logger: LoggerService) {}
-
-  async charge(amount: number) {
-    this.logger.log('Charging card', PaymentsService.name);
-    this.logger.warn('High amount', PaymentsService.name);
-    this.logger.error('Card declined', undefined, PaymentsService.name);
-
-    // Arbitrary extra fields
-    this.logger.logWithMeta('info', 'Payment processed', {
-      amount,
-      currency: 'USD',
-      userId: 'u_123',
-    });
-  }
-}
-```
-
-### Console output format
-
-```
-2024-01-15T10:30:00.000Z [info] Charging card {"service":"payments","correlationId":"a1b2…"}
-```
-
-### HTTP transport
-
-When `http` is configured, log entries are buffered in memory and flushed in batches. A built-in circuit breaker pauses sends after repeated failures so logging never blocks your application.
-
----
-
-## MetricsService
-
-```typescript
-@Injectable()
-export class CheckoutService {
-  constructor(private readonly metrics: MetricsService) {}
-
-  async checkout(cart: Cart) {
-    const start = Date.now();
-    // ... process ...
-    this.metrics.record('checkout.duration', Date.now() - start, {
-      unit: 'ms',
-      tags: { region: 'us-east-1' },
-    });
-
-    this.metrics.record('checkout.items', cart.items.length, {
-      tags: { currency: cart.currency },
-    });
-  }
-}
-```
-
-Events are buffered and shipped in batches. The service flushes remaining events on `onModuleDestroy` (graceful shutdown).
-
----
-
-## AllExceptionsFilter
-
-Returns a consistent error shape for every unhandled exception:
-
-```json
-{
-  "ok": false,
-  "statusCode": 404,
-  "message": "Resource not found",
-  "code": "NOT_FOUND",
-  "correlationId": "a1b2c3d4-...",
-  "timestamp": "2024-01-15T10:30:00.000Z"
-}
-```
-
-### Custom error mappers
-
-Register domain-specific error classes so they are mapped to the correct HTTP status:
-
-```typescript
-import { AllExceptionsFilter, ErrorMapper } from '@backendkit-labs/observability';
-
-// In main.ts, after app.get(AllExceptionsFilter)
-const filter = app.get(AllExceptionsFilter);
-
-const domainMapper: ErrorMapper = (err) => {
-  if (err instanceof ResourceNotFoundError) {
-    return { statusCode: 404, message: err.message, code: 'NOT_FOUND' };
-  }
-  if (err instanceof ValidationError) {
-    return { statusCode: 422, message: err.message, code: 'VALIDATION_ERROR' };
-  }
-  return null; // fall through to next mapper or default handling
-};
-
-filter.addMapper(domainMapper);
-app.useGlobalFilters(filter);
-```
-
-Multiple mappers are tried in registration order; the first non-`null` result wins.
-
----
-
-## @TrackPerformance decorator
-
-Wraps any `async` method in an OpenTelemetry span. When OTel is not installed, it becomes a pure pass-through with zero overhead.
-
-```typescript
-import { TrackPerformance } from '@backendkit-labs/observability';
-
-@Injectable()
-export class ReportsService {
-  @TrackPerformance()
-  async generateReport(id: string): Promise<Report> {
-    // Span name: "ReportsService.generateReport"
-    return this.db.buildReport(id);
-  }
-
-  @TrackPerformance({
-    operation:  'custom-operation-name',
-    attributes: { team: 'analytics', critical: true },
-  })
-  async exportToCsv(id: string): Promise<Buffer> {
-    return this.db.export(id);
-  }
-}
-```
-
----
-
-## OpenTelemetry integration
-
-Install `@opentelemetry/api` and configure an SDK (e.g. `@opentelemetry/sdk-node`) separately. This package auto-detects the API and attaches spans — no extra configuration needed here.
-
-```bash
-npm install @opentelemetry/api @opentelemetry/sdk-node
-```
-
-`CorrelationIdService.getTraceContext()` returns the active `traceId` and `spanId` when OTel is active, useful for log correlation:
-
-```typescript
-const trace = this.correlation.getTraceContext();
-// { traceId: 'abc123…', spanId: 'def456…' }
-```
-
----
-
-## Circuit breaker behaviour
-
-Both the HTTP log transport and the metrics transport use [`@backendkit-labs/circuit-breaker`](../circuit-breaker) to protect your application from cascading failures in the observability backend:
-
-```
-CLOSED ──(failure rate ≥ threshold)──► OPEN ──(openTimeoutMs)──► HALF_OPEN ──(probe succeeds)──► CLOSED
-                                                                               └─(probe fails)───► OPEN
-```
-
-### Transport defaults
-
-| Option | Default | Description |
-|---|---|---|
-| `failureThreshold` | `60` | % of calls in the window that must fail to open the circuit |
-| `slidingWindowSize` | `5` | Number of calls in the evaluation window |
-| `minimumCalls` | `3` | Minimum calls before thresholds are evaluated |
-| `openTimeoutMs` | `30 000` | Time to wait in OPEN before transitioning to HALF_OPEN |
-| `halfOpenMaxCalls` | `1` | Probe calls allowed in HALF_OPEN |
-| `slowCallThreshold` | `100` | % of slow calls to open the circuit (disabled by default) |
-| `slowCallDurationMs` | `60 000` | Duration above which a call is considered slow |
-
-### Customising the circuit breaker
-
-Pass any subset of `CircuitBreakerConfig` via the `circuitBreaker` option. `name` and `isFailure` are managed internally.
-
-```typescript
-import { CircuitBreakerState } from '@backendkit-labs/circuit-breaker';
-
-ObservabilityModule.forRoot({
-  serviceName: 'my-api',
-  metrics: {
-    url: 'https://metrics.example.com/ingest',
-    circuitBreaker: {
-      failureThreshold:  80,      // open only when 80% of calls fail
-      slidingWindowSize: 10,
-      minimumCalls:      5,
-      openTimeoutMs:     60_000,  // stay open for 60 s
-      halfOpenMaxCalls:  2,       // send 2 probes before closing
-      onStateChange: (from, to, metrics) => {
-        if (to === CircuitBreakerState.OPEN) {
-          alerting.trigger(`Metrics CB opened — failure rate ${metrics.failureRate}%`);
-        }
-      },
-    },
-  },
-});
-```
-
-The same `circuitBreaker` option is available on the `http` log transport.
-
----
-
-## License
-
-MIT
+# @backendkit-labs/observability
+
+Structured logging, distributed tracing correlation, metrics shipping, performance interceptors, and exception handling for **NestJS** — with optional OpenTelemetry integration.
+
+## Features
+
+| Feature | Description |
+|---|---|
+| **CorrelationIdService** | AsyncLocalStorage-based correlation ID propagation across the full async call stack |
+| **LoggerService** | Winston-backed structured logger with optional batched HTTP transport |
+| **MetricsService** | Fire-and-forget metric event shipping with buffering and circuit breaker |
+| **CorrelationInterceptor** | Reads/generates `x-correlation-id` and sets it on the response header |
+| **PerformanceInterceptor** | Logs and records HTTP request duration for every route |
+| **AllExceptionsFilter** | Unified error response shape with pluggable error mappers |
+| **@TrackPerformance** | Method decorator that wraps any async method in an OTel span |
+| **OTel optional** | `@opentelemetry/api` is a peer — drop it and everything becomes a no-op |
+
+---
+
+## Installation
+
+```bash
+npm install @backendkit-labs/observability
+
+# optional — only if you use OTel tracing
+npm install @opentelemetry/api
+```
+
+---
+
+## Quick start
+
+```typescript
+// app.module.ts
+import { Module }              from '@nestjs/common';
+import { ObservabilityModule } from '@backendkit-labs/observability';
+
+@Module({
+  imports: [
+    ObservabilityModule.forRoot({
+      serviceName: 'my-api',
+      environment: 'production',
+      logLevel:    'info',
+
+      // Ship logs to a remote endpoint (optional)
+      http: {
+        url:       'https://logs.example.com/ingest',
+        authToken: process.env.OBS_AUTH_TOKEN,
+      },
+
+      // Ship metrics to a remote endpoint (optional)
+      metrics: {
+        url:       'https://metrics.example.com/ingest',
+        authToken: process.env.OBS_AUTH_TOKEN,
+      },
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+Register interceptors and the exception filter globally in `main.ts`:
+
+```typescript
+import { NestFactory }              from '@nestjs/core';
+import {
+  CorrelationInterceptor,
+  PerformanceInterceptor,
+  AllExceptionsFilter,
+  LoggerService,
+} from '@backendkit-labs/observability';
+import { AppModule }                from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+
+  app.useGlobalInterceptors(
+    app.get(CorrelationInterceptor),
+    app.get(PerformanceInterceptor),
+  );
+
+  app.useGlobalFilters(app.get(AllExceptionsFilter));
+
+  // Use LoggerService as the NestJS application logger
+  app.useLogger(app.get(LoggerService));
+
+  await app.listen(3000);
+}
+bootstrap();
+```
+
+---
+
+## ObservabilityModule.forRoot options
+
+```typescript
+interface ObservabilityOptions {
+  serviceName:  string;
+  environment?: string;           // default: "production"
+  logLevel?:    'error' | 'warn' | 'info' | 'http' | 'verbose' | 'debug' | 'silly';
+  http?:        HttpTransportOptions;
+  metrics?:     MetricsOptions;
+}
+```
+
+### HTTP log transport options
+
+```typescript
+interface HttpTransportOptions {
+  url:              string;
+  authToken?:       string;
+  headers?:         Record<string, string>;
+  batchSize?:       number;   // default 100
+  maxBufferSize?:   number;   // default 2000
+  flushIntervalMs?: number;   // default 5000
+  timeoutMs?:       number;   // default 5000
+  circuitBreaker?:  Partial<CircuitBreakerConfig>; // see below
+}
+```
+
+### Metrics transport options
+
+```typescript
+interface MetricsOptions {
+  url:              string;
+  authToken?:       string;
+  headers?:         Record<string, string>;
+  flushIntervalMs?: number;   // default 10000
+  maxBufferSize?:   number;   // default 5000
+  timeoutMs?:       number;   // default 5000
+  circuitBreaker?:  Partial<CircuitBreakerConfig>; // see below
+}
+```
+
+---
+
+## CorrelationIdService
+
+Propagates a request-scoped correlation ID through every `await` using `AsyncLocalStorage`.
+
+```typescript
+@Injectable()
+export class OrdersService {
+  constructor(private readonly correlation: CorrelationIdService) {}
+
+  async processOrder(id: string) {
+    // Always returns the ID for the current request context
+    const cid = this.correlation.get();
+
+    // Or undefined when called outside a context
+    const maybeId = this.correlation.getOrUndefined();
+
+    // OTel trace/span IDs (undefined when OTel not installed)
+    const trace = this.correlation.getTraceContext();
+    // => { traceId: 'abc…', spanId: '123…' } | undefined
+  }
+}
+```
+
+The `CorrelationInterceptor` automatically seeds the context from the incoming `x-correlation-id` header (or generates a fresh UUID) and echoes the ID back in the response header.
+
+---
+
+## LoggerService
+
+Drop-in replacement for NestJS's built-in logger. All log entries include `service`, `environment`, and `correlationId` automatically.
+
+```typescript
+@Injectable()
+export class PaymentsService {
+  constructor(private readonly logger: LoggerService) {}
+
+  async charge(amount: number) {
+    this.logger.log('Charging card', PaymentsService.name);
+    this.logger.warn('High amount', PaymentsService.name);
+    this.logger.error('Card declined', undefined, PaymentsService.name);
+
+    // Arbitrary extra fields
+    this.logger.logWithMeta('info', 'Payment processed', {
+      amount,
+      currency: 'USD',
+      userId: 'u_123',
+    });
+  }
+}
+```
+
+### Console output format
+
+```
+2024-01-15T10:30:00.000Z [info] Charging card {"service":"payments","correlationId":"a1b2…"}
+```
+
+### HTTP transport
+
+When `http` is configured, log entries are buffered in memory and flushed in batches. A built-in circuit breaker pauses sends after repeated failures so logging never blocks your application.
+
+---
+
+## MetricsService
+
+```typescript
+@Injectable()
+export class CheckoutService {
+  constructor(private readonly metrics: MetricsService) {}
+
+  async checkout(cart: Cart) {
+    const start = Date.now();
+    // ... process ...
+    this.metrics.record('checkout.duration', Date.now() - start, {
+      unit: 'ms',
+      tags: { region: 'us-east-1' },
+    });
+
+    this.metrics.record('checkout.items', cart.items.length, {
+      tags: { currency: cart.currency },
+    });
+  }
+}
+```
+
+Events are buffered and shipped in batches. The service flushes remaining events on `onModuleDestroy` (graceful shutdown).
+
+---
+
+## AllExceptionsFilter
+
+Returns a consistent error shape for every unhandled exception:
+
+```json
+{
+  "ok": false,
+  "statusCode": 404,
+  "message": "Resource not found",
+  "code": "NOT_FOUND",
+  "correlationId": "a1b2c3d4-...",
+  "timestamp": "2024-01-15T10:30:00.000Z"
+}
+```
+
+### Custom error mappers
+
+Register domain-specific error classes so they are mapped to the correct HTTP status:
+
+```typescript
+import { AllExceptionsFilter, ErrorMapper } from '@backendkit-labs/observability';
+
+// In main.ts, after app.get(AllExceptionsFilter)
+const filter = app.get(AllExceptionsFilter);
+
+const domainMapper: ErrorMapper = (err) => {
+  if (err instanceof ResourceNotFoundError) {
+    return { statusCode: 404, message: err.message, code: 'NOT_FOUND' };
+  }
+  if (err instanceof ValidationError) {
+    return { statusCode: 422, message: err.message, code: 'VALIDATION_ERROR' };
+  }
+  return null; // fall through to next mapper or default handling
+};
+
+filter.addMapper(domainMapper);
+app.useGlobalFilters(filter);
+```
+
+Multiple mappers are tried in registration order; the first non-`null` result wins.
+
+---
+
+## @TrackPerformance decorator
+
+Wraps any `async` method in an OpenTelemetry span. When OTel is not installed, it becomes a pure pass-through with zero overhead.
+
+```typescript
+import { TrackPerformance } from '@backendkit-labs/observability';
+
+@Injectable()
+export class ReportsService {
+  @TrackPerformance()
+  async generateReport(id: string): Promise<Report> {
+    // Span name: "ReportsService.generateReport"
+    return this.db.buildReport(id);
+  }
+
+  @TrackPerformance({
+    operation:  'custom-operation-name',
+    attributes: { team: 'analytics', critical: true },
+  })
+  async exportToCsv(id: string): Promise<Buffer> {
+    return this.db.export(id);
+  }
+}
+```
+
+---
+
+## OpenTelemetry integration
+
+Install `@opentelemetry/api` and configure an SDK (e.g. `@opentelemetry/sdk-node`) separately. This package auto-detects the API and attaches spans — no extra configuration needed here.
+
+```bash
+npm install @opentelemetry/api @opentelemetry/sdk-node
+```
+
+`CorrelationIdService.getTraceContext()` returns the active `traceId` and `spanId` when OTel is active, useful for log correlation:
+
+```typescript
+const trace = this.correlation.getTraceContext();
+// { traceId: 'abc123…', spanId: 'def456…' }
+```
+
+---
+
+## Circuit breaker behaviour
+
+Both the HTTP log transport and the metrics transport use [`@backendkit-labs/circuit-breaker`](../circuit-breaker) to protect your application from cascading failures in the observability backend:
+
+```
+CLOSED ──(failure rate ≥ threshold)──► OPEN ──(openTimeoutMs)──► HALF_OPEN ──(probe succeeds)──► CLOSED
+                                                                               └─(probe fails)───► OPEN
+```
+
+### Transport defaults
+
+| Option | Default | Description |
+|---|---|---|
+| `failureThreshold` | `60` | % of calls in the window that must fail to open the circuit |
+| `slidingWindowSize` | `5` | Number of calls in the evaluation window |
+| `minimumCalls` | `3` | Minimum calls before thresholds are evaluated |
+| `openTimeoutMs` | `30 000` | Time to wait in OPEN before transitioning to HALF_OPEN |
+| `halfOpenMaxCalls` | `1` | Probe calls allowed in HALF_OPEN |
+| `slowCallThreshold` | `100` | % of slow calls to open the circuit (disabled by default) |
+| `slowCallDurationMs` | `60 000` | Duration above which a call is considered slow |
+
+### Customising the circuit breaker
+
+Pass any subset of `CircuitBreakerConfig` via the `circuitBreaker` option. `name` and `isFailure` are managed internally.
+
+```typescript
+import { CircuitBreakerState } from '@backendkit-labs/circuit-breaker';
+
+ObservabilityModule.forRoot({
+  serviceName: 'my-api',
+  metrics: {
+    url: 'https://metrics.example.com/ingest',
+    circuitBreaker: {
+      failureThreshold:  80,      // open only when 80% of calls fail
+      slidingWindowSize: 10,
+      minimumCalls:      5,
+      openTimeoutMs:     60_000,  // stay open for 60 s
+      halfOpenMaxCalls:  2,       // send 2 probes before closing
+      onStateChange: (from, to, metrics) => {
+        if (to === CircuitBreakerState.OPEN) {
+          alerting.trigger(`Metrics CB opened — failure rate ${metrics.failureRate}%`);
+        }
+      },
+    },
+  },
+});
+```
+
+The same `circuitBreaker` option is available on the `http` log transport.
+
+---
+
+## License
+
+Apache-2.0

package/package.json

@@ -1,72 +1,96 @@
-{
-  "name": "@backendkit-labs/observability",
-  "version": "0.1.0",
-  "description": "Structured logging, metrics, correlation ID propagation, and exception handling for NestJS — no OTel SDK required",
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types":   "./dist/index.d.ts",
-      "import":  "./dist/index.js",
-      "require": "./dist/index.cjs"
-    }
-  },
-  "files": ["dist", "README.md", "LICENSE"],
-  "scripts": {
-    "build":          "tsup",
-    "dev":            "tsup --watch",
-    "test":           "vitest run",
-    "test:watch":     "vitest",
-    "test:coverage":  "vitest run --coverage",
-    "typecheck":      "tsc --noEmit",
-    "lint":           "eslint src/",
-    "prepublishOnly": "npm run build && npm run test && npm run lint"
-  },
-  "keywords": [
-    "observability", "logging", "metrics", "correlation-id", "nestjs",
-    "winston", "opentelemetry", "tracing", "structured-logging", "node"
-  ],
-  "author": "Mairon José Cuello Martínez",
-  "license": "MIT",
-  "homepage": "https://github.com/backendkit-dev/backendkit-monorepo/tree/master/packages/observability#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/backendkit-dev/backendkit-monorepo.git",
-    "directory": "packages/observability"
-  },
-  "bugs": { "url": "https://github.com/backendkit-dev/backendkit-monorepo/issues" },
-  "sideEffects": false,
-  "engines": { "node": ">=18" },
-  "dependencies": {
-    "@backendkit-labs/circuit-breaker": "*",
-    "axios":   "^1.7.0",
-    "winston": "^3.11.0",
-    "winston-transport": "^4.7.0"
-  },
-  "peerDependencies": {
-    "@nestjs/common":       ">=10.0.0",
-    "@nestjs/core":         ">=10.0.0",
-    "@opentelemetry/api":   ">=1.0.0",
-    "rxjs":                 ">=7.0.0"
-  },
-  "peerDependenciesMeta": {
-    "@opentelemetry/api": { "optional": true }
-  },
-  "devDependencies": {
-    "@eslint/js":           "^9.39.4",
-    "@nestjs/common":       "^10.0.0",
-    "@nestjs/core":         "^10.0.0",
-    "@opentelemetry/api":   "^1.9.0",
-    "@types/express":       "^4.17.21",
-    "@types/node":          "^22.0.0",
-    "eslint":               "^9.0.0",
-    "reflect-metadata":     "^0.2.0",
-    "rxjs":                 "^7.8.0",
-    "tsup":                 "^8.0.0",
-    "typescript":           "^5.5.0",
-    "typescript-eslint":    "^8.59.3",
-    "vitest":               "^2.0.0"
-  }
-}
+{
+  "name": "@backendkit-labs/observability",
+  "version": "0.1.1",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "BackendKit Labs",
+    "email": "backendkit.dev@gmail.com"
+  },
+  "description": "Structured logging, metrics, correlation ID propagation, and exception handling for NestJS — no OTel SDK required",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/",
+    "prepublishOnly": "npm run build && npm run test && npm run lint"
+  },
+  "keywords": [
+    "observability",
+    "logging",
+    "metrics",
+    "correlation-id",
+    "nestjs",
+    "winston",
+    "opentelemetry",
+    "tracing",
+    "structured-logging",
+    "node"
+  ],
+  "homepage": "https://github.com/backendkit-dev/backendkit-monorepo/tree/master/packages/observability#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/backendkit-dev/backendkit-monorepo.git",
+    "directory": "packages/observability"
+  },
+  "bugs": {
+    "url": "https://github.com/backendkit-dev/backendkit-monorepo/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@backendkit-labs/circuit-breaker": "*",
+    "axios": "^1.7.0",
+    "winston": "^3.11.0",
+    "winston-transport": "^4.7.0"
+  },
+  "peerDependencies": {
+    "@nestjs/common": ">=10.0.0",
+    "@nestjs/core": ">=10.0.0",
+    "@opentelemetry/api": ">=1.0.0",
+    "rxjs": ">=7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@opentelemetry/api": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.4",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@types/express": "^4.17.21",
+    "@types/node": "^22.0.0",
+    "eslint": "^9.0.0",
+    "reflect-metadata": "^0.2.0",
+    "rxjs": "^7.8.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0",
+    "typescript-eslint": "^8.59.3",
+    "vitest": "^2.0.0"
+  }
+}