autotel 2.25.4 → 2.26.0

package/README.md

@@ -146,8 +146,10 @@ Replace `NODE_OPTIONS` and 30+ lines of SDK boilerplate with `init()`, wrap func
 
 ```bash
 npm install autotel
+npm install -D autotel-devtools # optional but recommended for local DX
 # or
 pnpm add autotel
+pnpm add -D autotel-devtools
 ```
 
 ### 2. Initialize once at startup
@@ -157,7 +159,7 @@ import { init } from 'autotel';
 
 init({
   service: 'checkout-api',
-  environment: process.env.NODE_ENV,
+  devtools: true,
 });
 ```
 
@@ -169,6 +171,29 @@ Defaults:
 - Version: auto-detected from `package.json`
 - Events auto-flush when the root span finishes
 
+Recommended local workflow:
+
+```typescript
+init({
+  service: 'checkout-api',
+  devtools: true,
+});
+```
+
+- `devtools: true` points traces, metrics, and logs at local `autotel-devtools`
+- `devtools: { embedded: true }` tries to start `autotel-devtools` for you
+- when you switch to a hosted backend, replace `devtools` with `endpoint` and optional `headers`
+
+Example remote backend config:
+
+```typescript
+init({
+  service: 'checkout-api',
+  endpoint: process.env.OTEL_EXPORTER_OTLP_ENDPOINT,
+  headers: process.env.OTEL_EXPORTER_OTLP_HEADERS,
+});
+```
+
 Sampling presets:
 
 - Simple path: `sampling: 'development' | 'errors-only' | 'production' | 'off'`
@@ -1978,6 +2003,14 @@ OTLP_ENDPOINT=https://otel.mycompany.com node server.js
 init({
   service: string; // required
   subscribers?: EventSubscriber[];
+  devtools?: boolean | {
+    enabled?: boolean;
+    endpoint?: string;
+    embedded?: boolean;
+    host?: string;
+    port?: number;
+    verbose?: boolean;
+  };
   endpoint?: string;
   protocol?: 'http' | 'grpc'; // OTLP protocol (default: 'http')
   metrics?: boolean | 'auto';
@@ -2006,6 +2039,19 @@ init({
 });
 ```
 
+Local-first recommendation:
+
+```typescript
+init({
+  service: 'my-app',
+  devtools: true,
+});
+```
+
+- `devtools: true` routes traces, metrics, and logs to local `autotel-devtools`
+- `devtools: { embedded: true }` attempts to start `autotel-devtools` automatically
+- use `endpoint` and `headers` when you are ready to ship telemetry to a hosted backend
+
 **Sampling Configuration:**
 
 ```typescript

package/dist/auto.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunkITYASFHQ_cjs = require('./chunk-ITYASFHQ.cjs');
+var chunkUJJPTSEI_cjs = require('./chunk-UJJPTSEI.cjs');
 var chunkOFPZULMQ_cjs = require('./chunk-OFPZULMQ.cjs');
 require('./chunk-KZEC4CHV.cjs');
 require('./chunk-ZNMBW67B.cjs');
@@ -23,7 +23,7 @@ module$1.register("import-in-the-middle/hook.mjs", (typeof document === 'undefin
 var yamlConfig = chunkOFPZULMQ_cjs.loadYamlConfig();
 var autoInstrumentationsEnv = process.env.AUTOTEL_INTEGRATIONS;
 var autoInstrumentations = autoInstrumentationsEnv === "true" ? true : autoInstrumentationsEnv ? autoInstrumentationsEnv.split(",").map((s) => s.trim()) : yamlConfig?.autoInstrumentations ?? ["http", "express"];
-chunkITYASFHQ_cjs.init({
+chunkUJJPTSEI_cjs.init({
   service: yamlConfig?.service ?? process.env.OTEL_SERVICE_NAME ?? "unknown-service",
   debug: yamlConfig?.debug ?? process.env.AUTOTEL_DEBUG === "true",
   autoInstrumentations

package/dist/auto.js

@@ -1,4 +1,4 @@
-import { init } from './chunk-MNBAXRVG.js';
+import { init } from './chunk-EXOXDI5A.js';
 import { loadYamlConfig } from './chunk-RUD7KS4R.js';
 import './chunk-XDKK53OL.js';
 import './chunk-WGWSHJ2N.js';

package/dist/{chunk-OPTGXEVN.js → chunk-4PTCDOZY.js}

@@ -2,7 +2,7 @@ import { setSpanName } from './chunk-B3ZHLLMP.js';
 import { validateEvent, runInOperationContext } from './chunk-WD4RP6IV.js';
 import { getOrCreateCorrelationId } from './chunk-S4OFEXLA.js';
 import { createTraceContext, getActiveContextWithBaggage, getContextStorage, enterOrRun } from './chunk-BBBWDIYQ.js';
-import { getValidationConfig, isInitialized, warnIfNotInitialized, getConfig as getConfig$1, getEventsConfig, getLogger, getSdk } from './chunk-MNBAXRVG.js';
+import { getValidationConfig, isInitialized, warnIfNotInitialized, getConfig as getConfig$1, getEventsConfig, getLogger, getSdk } from './chunk-EXOXDI5A.js';
 import { AlwaysSampler, AUTOTEL_SAMPLING_TAIL_KEEP, AUTOTEL_SAMPLING_TAIL_EVALUATED } from './chunk-VYA6QDNA.js';
 import { getConfig } from './chunk-J5QENANM.js';
 import { trace, SpanStatusCode, context, propagation } from '@opentelemetry/api';
@@ -1807,5 +1807,5 @@ function withBaggage(options) {
 }
 
 export { ctx, getEventQueue, instrument, resetEventQueue, span, trace2 as trace, track, withBaggage, withNewContext, withTracing };
-//# sourceMappingURL=chunk-OPTGXEVN.js.map
-//# sourceMappingURL=chunk-OPTGXEVN.js.map
+//# sourceMappingURL=chunk-4PTCDOZY.js.map
+//# sourceMappingURL=chunk-4PTCDOZY.js.map