evlog 1.3.0 → 1.4.0

package/README.md

@@ -3,8 +3,9 @@
 [![npm version](https://img.shields.io/npm/v/evlog?color=black)](https://npmjs.com/package/evlog)
 [![npm downloads](https://img.shields.io/npm/dm/evlog?color=black)](https://npm.chart.dev/evlog)
 [![CI](https://img.shields.io/github/actions/workflow/status/HugoRCD/evlog/ci.yml?branch=main&color=black)](https://github.com/HugoRCD/evlog/actions/workflows/ci.yml)
-[![bundle size](https://img.shields.io/bundlephobia/minzip/evlog?color=black&label=size)](https://bundlephobia.com/package/evlog)
+[![TypeScript](https://img.shields.io/badge/TypeScript-black?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
 [![Nuxt](https://img.shields.io/badge/Nuxt-black?logo=nuxt&logoColor=white)](https://nuxt.com/)
+[![Documentation](https://img.shields.io/badge/Documentation-black?logo=readme&logoColor=white)](https://evlog.dev)
 [![license](https://img.shields.io/github/license/HugoRCD/evlog?color=black)](https://github.com/HugoRCD/evlog/blob/main/LICENSE)
 
 **Your logs are lying to you.**
@@ -389,6 +390,85 @@ Notes:
 - `request.cf` is included (colo, country, asn) unless disabled
 - Use `headerAllowlist` to avoid logging sensitive headers
 
+## Adapters
+
+Send your logs to external observability platforms with built-in adapters.
+
+### Axiom
+
+```typescript
+// server/plugins/evlog-drain.ts
+import { createAxiomDrain } from 'evlog/axiom'
+
+export default defineNitroPlugin((nitroApp) => {
+  nitroApp.hooks.hook('evlog:drain', createAxiomDrain())
+})
+```
+
+Set environment variables:
+
+```bash
+NUXT_AXIOM_TOKEN=xaat-your-token
+NUXT_AXIOM_DATASET=your-dataset
+```
+
+### OTLP (OpenTelemetry)
+
+Works with Grafana, Datadog, Honeycomb, and any OTLP-compatible backend.
+
+```typescript
+// server/plugins/evlog-drain.ts
+import { createOTLPDrain } from 'evlog/otlp'
+
+export default defineNitroPlugin((nitroApp) => {
+  nitroApp.hooks.hook('evlog:drain', createOTLPDrain())
+})
+```
+
+Set environment variables:
+
+```bash
+NUXT_OTLP_ENDPOINT=http://localhost:4318
+```
+
+### Multiple Destinations
+
+Send logs to multiple services:
+
+```typescript
+// server/plugins/evlog-drain.ts
+import { createAxiomDrain } from 'evlog/axiom'
+import { createOTLPDrain } from 'evlog/otlp'
+
+export default defineNitroPlugin((nitroApp) => {
+  const axiom = createAxiomDrain()
+  const otlp = createOTLPDrain()
+
+  nitroApp.hooks.hook('evlog:drain', async (ctx) => {
+    await Promise.allSettled([axiom(ctx), otlp(ctx)])
+  })
+})
+```
+
+### Custom Adapters
+
+Build your own adapter for any destination:
+
+```typescript
+// server/plugins/evlog-drain.ts
+export default defineNitroPlugin((nitroApp) => {
+  nitroApp.hooks.hook('evlog:drain', async (ctx) => {
+    await fetch('https://your-service.com/logs', {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
+      body: JSON.stringify(ctx.event),
+    })
+  })
+})
+```
+
+> See the [full documentation](https://evlog.hrcd.fr/adapters/overview) for adapter configuration options, troubleshooting, and advanced patterns.
+
 ## API Reference
 
 ### `initLogger(config)`

package/dist/nitro/plugin.mjs

@@ -15,6 +15,15 @@ function shouldLog(path, include, exclude) {
   }
   return include.some((pattern) => matchesPattern(path, pattern));
 }
+function getServiceForPath(path, routes) {
+  if (!routes) return void 0;
+  for (const [pattern, config] of Object.entries(routes)) {
+    if (matchesPattern(path, pattern)) {
+      return config.service;
+    }
+  }
+  return void 0;
+}
 const SENSITIVE_HEADERS = [
   "authorization",
   "cookie",
@@ -46,14 +55,17 @@ function getResponseStatus(event) {
   return 200;
 }
 function callDrainHook(nitroApp, emittedEvent, event) {
-  if (emittedEvent) {
-    nitroApp.hooks.callHook("evlog:drain", {
-      event: emittedEvent,
-      request: { method: event.method, path: event.path, requestId: event.context.requestId },
-      headers: getSafeHeaders(event)
-    }).catch((err) => {
-      console.error("[evlog] drain failed:", err);
-    });
+  if (!emittedEvent) return;
+  const drainPromise = nitroApp.hooks.callHook("evlog:drain", {
+    event: emittedEvent,
+    request: { method: event.method, path: event.path, requestId: event.context.requestId },
+    headers: getSafeHeaders(event)
+  }).catch((err) => {
+    console.error("[evlog] drain failed:", err);
+  });
+  const waitUntil = event.context.cloudflare?.context?.waitUntil ?? event.context.waitUntil;
+  if (typeof waitUntil === "function") {
+    waitUntil(drainPromise);
   }
 }
 const plugin = defineNitroPlugin((nitroApp) => {
@@ -75,6 +87,10 @@ const plugin = defineNitroPlugin((nitroApp) => {
       path: e.path,
       requestId: e.context.requestId || crypto.randomUUID()
     });
+    const routeService = getServiceForPath(e.path, evlogConfig?.routes);
+    if (routeService) {
+      log.set({ service: routeService });
+    }
     e.context.log = log;
   });
   nitroApp.hooks.hook("error", async (error, { event }) => {

package/dist/nuxt/module.d.mts

@@ -1,5 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { EnvironmentContext, SamplingConfig, TransportConfig } from '../types.mjs';
+import { EnvironmentContext, RouteConfig, SamplingConfig, TransportConfig } from '../types.mjs';
 
 interface ModuleOptions {
     /**
@@ -25,6 +25,20 @@ interface ModuleOptions {
      * @example ['/api/_nuxt_icon/**', '/health']
      */
     exclude?: string[];
+    /**
+     * Route-specific service configuration.
+     * Allows setting different service names for different routes.
+     * Patterns are matched using glob syntax.
+     *
+     * @example
+     * ```ts
+     * routes: {
+     *   '/api/foo/**': { service: 'service1' },
+     *   '/api/bar/**': { service: 'service2' }
+     * }
+     * ```
+     */
+    routes?: Record<string, RouteConfig>;
     /**
      * Sampling configuration for filtering logs.
      * Allows configuring what percentage of logs to keep per level.

package/dist/nuxt/module.d.ts

@@ -1,5 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { EnvironmentContext, SamplingConfig, TransportConfig } from '../types.js';
+import { EnvironmentContext, RouteConfig, SamplingConfig, TransportConfig } from '../types.js';
 
 interface ModuleOptions {
     /**
@@ -25,6 +25,20 @@ interface ModuleOptions {
      * @example ['/api/_nuxt_icon/**', '/health']
      */
     exclude?: string[];
+    /**
+     * Route-specific service configuration.
+     * Allows setting different service names for different routes.
+     * Patterns are matched using glob syntax.
+     *
+     * @example
+     * ```ts
+     * routes: {
+     *   '/api/foo/**': { service: 'service1' },
+     *   '/api/bar/**': { service: 'service2' }
+     * }
+     * ```
+     */
+    routes?: Record<string, RouteConfig>;
     /**
      * Sampling configuration for filtering logs.
      * Allows configuring what percentage of logs to keep per level.

package/dist/runtime/server/useLogger.d.mts

@@ -4,6 +4,7 @@ import { ServerEvent, RequestLogger } from '../../types.mjs';
  * Returns the request logger attached to the given server event.
  *
  * @param event - The current server event containing the context with the logger.
+ * @param service - Optional service name to override the default service.
  * @returns The request-scoped logger.
  * @throws Error if the logger is not initialized on the event context.
  *
@@ -13,7 +14,15 @@ import { ServerEvent, RequestLogger } from '../../types.mjs';
  *   log.set({ foo: 'bar' })
  *   // ...
  * })
+ *
+ * @example
+ * // Override service name for specific routes
+ * export default defineEventHandler((event) => {
+ *   const log = useLogger(event, 'payment-service')
+ *   log.set({ foo: 'bar' })
+ *   // ...
+ * })
  */
-declare function useLogger(event: ServerEvent): RequestLogger;
+declare function useLogger(event: ServerEvent, service?: string): RequestLogger;
 
 export { useLogger };

package/dist/runtime/server/useLogger.d.ts

@@ -4,6 +4,7 @@ import { ServerEvent, RequestLogger } from '../../types.js';
  * Returns the request logger attached to the given server event.
  *
  * @param event - The current server event containing the context with the logger.
+ * @param service - Optional service name to override the default service.
  * @returns The request-scoped logger.
  * @throws Error if the logger is not initialized on the event context.
  *
@@ -13,7 +14,15 @@ import { ServerEvent, RequestLogger } from '../../types.js';
  *   log.set({ foo: 'bar' })
  *   // ...
  * })
+ *
+ * @example
+ * // Override service name for specific routes
+ * export default defineEventHandler((event) => {
+ *   const log = useLogger(event, 'payment-service')
+ *   log.set({ foo: 'bar' })
+ *   // ...
+ * })
  */
-declare function useLogger(event: ServerEvent): RequestLogger;
+declare function useLogger(event: ServerEvent, service?: string): RequestLogger;
 
 export { useLogger };

package/dist/runtime/server/useLogger.mjs

@@ -1,10 +1,13 @@
-function useLogger(event) {
+function useLogger(event, service) {
   const log = event.context.log;
   if (!log) {
     throw new Error(
       '[evlog] Logger not initialized. Make sure the evlog Nitro plugin is registered. If using Nuxt, add "evlog" to your modules.'
     );
   }
+  if (service) {
+    log.set({ service });
+  }
   return log;
 }
 

package/dist/types.d.mts

@@ -160,6 +160,13 @@ interface SamplingConfig {
      */
     keep?: TailSamplingCondition[];
 }
+/**
+ * Route-based service configuration
+ */
+interface RouteConfig {
+    /** Service name to use for routes matching this pattern */
+    service: string;
+}
 /**
  * Environment context automatically included in every log event
  */
@@ -325,7 +332,16 @@ interface H3EventContext {
 interface ServerEvent {
     method: string;
     path: string;
-    context: H3EventContext;
+    context: H3EventContext & {
+        /** Cloudflare Workers context (available when deployed to CF Workers) */
+        cloudflare?: {
+            context: {
+                waitUntil: (promise: Promise<unknown>) => void;
+            };
+        };
+        /** Vercel Edge context (available when deployed to Vercel Edge) */
+        waitUntil?: (promise: Promise<unknown>) => void;
+    };
     node?: {
         res?: {
             statusCode?: number;
@@ -345,4 +361,4 @@ interface ParsedError {
     raw: unknown;
 }
 
-export type { BaseWideEvent, DrainContext, EnvironmentContext, ErrorOptions, H3EventContext, IngestPayload, Log, LogLevel, LoggerConfig, ParsedError, RequestLogger, RequestLoggerOptions, SamplingConfig, SamplingRates, ServerEvent, TailSamplingCondition, TailSamplingContext, TransportConfig, WideEvent };
+export type { BaseWideEvent, DrainContext, EnvironmentContext, ErrorOptions, H3EventContext, IngestPayload, Log, LogLevel, LoggerConfig, ParsedError, RequestLogger, RequestLoggerOptions, RouteConfig, SamplingConfig, SamplingRates, ServerEvent, TailSamplingCondition, TailSamplingContext, TransportConfig, WideEvent };

package/dist/types.d.ts

@@ -160,6 +160,13 @@ interface SamplingConfig {
      */
     keep?: TailSamplingCondition[];
 }
+/**
+ * Route-based service configuration
+ */
+interface RouteConfig {
+    /** Service name to use for routes matching this pattern */
+    service: string;
+}
 /**
  * Environment context automatically included in every log event
  */
@@ -325,7 +332,16 @@ interface H3EventContext {
 interface ServerEvent {
     method: string;
     path: string;
-    context: H3EventContext;
+    context: H3EventContext & {
+        /** Cloudflare Workers context (available when deployed to CF Workers) */
+        cloudflare?: {
+            context: {
+                waitUntil: (promise: Promise<unknown>) => void;
+            };
+        };
+        /** Vercel Edge context (available when deployed to Vercel Edge) */
+        waitUntil?: (promise: Promise<unknown>) => void;
+    };
     node?: {
         res?: {
             statusCode?: number;
@@ -345,4 +361,4 @@ interface ParsedError {
     raw: unknown;
 }
 
-export type { BaseWideEvent, DrainContext, EnvironmentContext, ErrorOptions, H3EventContext, IngestPayload, Log, LogLevel, LoggerConfig, ParsedError, RequestLogger, RequestLoggerOptions, SamplingConfig, SamplingRates, ServerEvent, TailSamplingCondition, TailSamplingContext, TransportConfig, WideEvent };
+export type { BaseWideEvent, DrainContext, EnvironmentContext, ErrorOptions, H3EventContext, IngestPayload, Log, LogLevel, LoggerConfig, ParsedError, RequestLogger, RequestLoggerOptions, RouteConfig, SamplingConfig, SamplingRates, ServerEvent, TailSamplingCondition, TailSamplingContext, TransportConfig, WideEvent };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "evlog",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Wide event logging library with structured error handling. Inspired by LoggingSucks.",
   "author": "HugoRCD <contact@hrcd.fr>",
   "homepage": "https://evlog.dev",