autotel 3.0.5 → 3.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -138,6 +138,25 @@ Replace `NODE_OPTIONS` and 30+ lines of SDK boilerplate with `init()`, wrap func
|
|
|
138
138
|
| Teams need both observability **and** product events. | Ship technical telemetry and funnel/behavior events through the same API with contextual enrichment. |
|
|
139
139
|
| Production readiness requires redaction, rate limiting, and circuit breakers. | Those guardrails are on by default so you can safely enable telemetry everywhere. |
|
|
140
140
|
|
|
141
|
+
## Entry point map
|
|
142
|
+
|
|
143
|
+
`autotel` has ~35 subpath exports. For most scenarios you only need one or two. Cloudflare Workers and other edge runtimes should use [`autotel-cloudflare`](../autotel-cloudflare) or [`autotel-edge`](../autotel-edge), not `autotel` (which expects Node).
|
|
144
|
+
|
|
145
|
+
| Scenario | Package | Import |
|
|
146
|
+
| --------------------------------------------------- | ------------------------------------- | ---------------------------------------------------------------------- |
|
|
147
|
+
| Node service — init + spans | `autotel` | `import { init, trace, span } from 'autotel'` |
|
|
148
|
+
| Node service — pino-style logger with trace context | `autotel` | `import { createLogger } from 'autotel/logger'` |
|
|
149
|
+
| Node service — class decorators | `autotel` | `import { Trace, Span } from 'autotel/decorators'` |
|
|
150
|
+
| Node service — Drizzle ORM spans | `autotel-drizzle` | `import { instrumentDrizzleClient } from 'autotel-drizzle'` |
|
|
151
|
+
| Node service — testing assertions | `autotel` | `import { createTraceCollector } from 'autotel/testing'` |
|
|
152
|
+
| Cloudflare Worker — fetch with spans | `autotel-cloudflare` | `import { wrapModule, trace } from 'autotel-cloudflare'` |
|
|
153
|
+
| Cloudflare Worker — logs only, no `nodejs_compat` | `autotel-cloudflare` | `import { createEdgeLogger } from 'autotel-cloudflare/logger'` |
|
|
154
|
+
| Cloudflare Worker — queue consumer | `autotel-cloudflare` | `import { wrapModule, getQueueLogger } from 'autotel-cloudflare'` |
|
|
155
|
+
| Cloudflare Worker — Durable Object | `autotel-cloudflare` | `import { wrapDurableObject } from 'autotel-cloudflare'` |
|
|
156
|
+
| Hono on Workers | `autotel-cloudflare` + `autotel-hono` | `wrapModule` from `autotel-cloudflare`, middleware from `autotel-hono` |
|
|
157
|
+
| Vercel Edge / Netlify Edge / Deno Deploy | `autotel-edge` | `import { init, trace } from 'autotel-edge'` |
|
|
158
|
+
| Edge runtime — logs only | `autotel-edge` | `import { createEdgeLogger } from 'autotel-edge/logger'` |
|
|
159
|
+
|
|
141
160
|
## Quick Start
|
|
142
161
|
|
|
143
162
|
> Want to follow along in code? This repo ships with `apps/example-basic` (mirrors the steps below) and `apps/example-http` for an Express server, you can run either with `pnpm start` after `pnpm install && pnpm build` at the root.
|
|
@@ -3130,4 +3149,10 @@ init({
|
|
|
3130
3149
|
// MongoDB and Redis operations are now automatically traced
|
|
3131
3150
|
```
|
|
3132
3151
|
|
|
3152
|
+
## See also
|
|
3153
|
+
|
|
3154
|
+
- [autotel-cloudflare](../autotel-cloudflare) — Cloudflare Workers with KV/R2/D1/DO instrumentation
|
|
3155
|
+
- [autotel-edge](../autotel-edge) — vendor-agnostic edge runtime foundation
|
|
3156
|
+
- [autotel-drizzle](../autotel-drizzle) — Drizzle ORM query spans
|
|
3157
|
+
|
|
3133
3158
|
Happy observing!
|