@atrim/instrument-node 0.5.0 → 0.5.1-3a86b84-20260105170223

package/README.md

@@ -1,42 +1,43 @@
 # @atrim/instrument-node
 
-**One-line OpenTelemetry for Node.js**
+**Configuration layer for OpenTelemetry Node.js**
 
 [![npm version](https://badge.fury.io/js/%40atrim%2Finstrument-node.svg)](https://www.npmjs.com/package/@atrim/instrument-node)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-OpenTelemetry instrumentation for Node.js with centralized YAML configuration. Works with any Node.js framework (Express, Fastify, Koa, Hono) and runtime (Node.js, Bun, Deno).
+Built on [@opentelemetry/auto-instrumentations-node](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node), this package adds centralized YAML configuration, pattern-based span filtering, and first-class Effect-TS integration.
 
-## Quick Start
-
-**1. Install**
+## What This Package Adds
 
-```bash
-npm install @atrim/instrument-node
-```
+| Feature | Description |
+|---------|-------------|
+| **Pattern-based span filtering** | Control which spans are created via YAML config (unique to this package) |
+| **Centralized configuration** | Load instrumentation config from file, URL, or environment variable |
+| **Effect-TS integration** | Typed layers, annotation helpers for Effect users |
+| **Smart defaults** | Auto-detects service name, configures graceful shutdown |
 
-**2. Initialize** (at the top of your app)
+**Note:** Auto-instrumentation for Express, HTTP, Fastify, etc. comes from the underlying OpenTelemetry packages. This library configures and extends that functionality.
 
-### Promise API (Traditional)
+## Installation
 
-```typescript
-import { initializeInstrumentation } from '@atrim/instrument-node'
+```bash
+# Required
+npm install @atrim/instrument-node @opentelemetry/api
 
-await initializeInstrumentation()
+# Optional: Effect-TS integration
+npm install effect @effect/opentelemetry @effect/platform @effect/platform-node
 ```
 
-### Effect API (Recommended)
+## Quick Start
 
 ```typescript
-import { Effect } from 'effect'
-import { initializeInstrumentationEffect } from '@atrim/instrument-node'
+import { initializeInstrumentation } from '@atrim/instrument-node'
 
-await Effect.runPromise(initializeInstrumentationEffect())
+await initializeInstrumentation()
+// Done! Traces go to http://localhost:4318
 ```
 
-**3. Done!** Your app is now sending traces to OpenTelemetry.
-
-By default, traces go to `http://localhost:4318`. To send to a remote collector:
+**Remote collector:**
 
 ```typescript
 await initializeInstrumentation({
@@ -44,308 +45,106 @@ await initializeInstrumentation({
 })
 ```
 
-### What just happened?
-
-Auto-detected and configured:
-- ✅ Service name from `package.json`
-- ✅ OTLP endpoint (local or remote)
-- ✅ Auto-instrumentation for Express, HTTP, Fastify, etc.
-- ✅ Graceful shutdown on SIGTERM/SIGINT
-
-## Optional: Control What Gets Traced
-
-Create `instrumentation.yaml` in your project root:
-
-```yaml
-version: "1.0"
-instrumentation:
-  enabled: true
-  instrument_patterns:
-    - pattern: "^app\\."      # ✅ Trace application operations
-  ignore_patterns:
-    - pattern: "^health\\."   # ❌ Skip health checks
-```
-
-That's it!
-
-## Features
-
-- **Zero-config** - Works out of the box with sensible defaults
-- **Universal** - Node.js 20+, Bun 1.0+, Deno 1.40+
-- **Framework-agnostic** - Express, Fastify, Koa, Hono, vanilla HTTP
-- **Effect-TS first** - Typed error handling with Effect (optional)
-- **Pattern-based filtering** - Control which spans are created via YAML
-- **HTTP filtering** - Prevent noisy health checks and metrics endpoints
-- **Centralized config** - YAML file, URL, or environment variable
-- **Production-ready** - Graceful shutdown, error handling, performance optimized
-
-## Documentation
-
-Full documentation is available in the [main repository](https://github.com/atrim-ai/instrumentation):
-
-### Core Docs
-
-- 📖 [Getting Started](../../docs/getting-started.md) - 5-minute setup guide
-- ⚙️ [Configuration](../../docs/configuration.md) - YAML configuration reference
-- 📋 [Examples](../../docs/EXAMPLES.md) - 8+ working examples
-- 🔧 [Troubleshooting](../../docs/TROUBLESHOOTING.md) - Common issues and solutions
-- 📚 [API Reference](../../docs/api-reference.md) - Complete API documentation
-
-### Specialized Guides
-
-- 🌐 [HTTP Filtering](../../docs/HTTP_FILTERING_INVESTIGATION.md) - Prevent noisy traces
-- 🔄 [Effect Integration](../../examples/effect-ts/README.md) - Effect-TS patterns
-- 🧪 [Testing Guide](../../docs/TESTING.md) - How to test instrumented apps
-
-## Installation
-
-### npm
-
-```bash
-npm install @atrim/instrument-node
-```
-
-### yarn
+**What gets auto-configured:**
 
-```bash
-yarn add @atrim/instrument-node
-```
-
-### pnpm
-
-```bash
-pnpm add @atrim/instrument-node
-```
-
-### Bun
+- Service name from `package.json`
+- OTLP endpoint
+- Auto-instrumentation (HTTP, Express, Fastify, etc.)
+- Graceful shutdown
 
-```bash
-bun add @atrim/instrument-node
-```
-
-## Usage Examples
-
-### Express Application
-
-```typescript
-import express from 'express'
-import { initializeInstrumentation } from '@atrim/instrument-node'
-
-// Initialize at startup
-await initializeInstrumentation()
-
-const app = express()
-
-app.get('/users', async (req, res) => {
-  // Automatically traced!
-  const users = await fetchUsers()
-  res.json(users)
-})
-
-app.listen(3000)
-```
-
-### Effect-TS Application
+## Effect-TS Integration
 
 ```typescript
 import { Effect, Layer } from 'effect'
 import { EffectInstrumentationLive } from '@atrim/instrument-node/effect'
 
 const program = Effect.gen(function* () {
-  // Automatically traced with Effect.withSpan()
   yield* myOperation.pipe(Effect.withSpan('app.operation'))
-}).pipe(
-  Effect.provide(EffectInstrumentationLive)
-)
+}).pipe(Effect.provide(EffectInstrumentationLive))
 
 await Effect.runPromise(program)
 ```
 
-### Bun Runtime
-
-```typescript
-import { initializeInstrumentation } from '@atrim/instrument-node'
-
-// Works exactly the same as Node.js
-await initializeInstrumentation()
-
-Bun.serve({
-  port: 3000,
-  fetch(req) {
-    return new Response('Hello from Bun!')
-  }
-})
-```
-
-### Remote Configuration
+**Span annotation helpers:**
 
 ```typescript
-import { initializeInstrumentation } from '@atrim/instrument-node'
+import { annotateUser, annotateBatch, annotateCache } from '@atrim/instrument-node/effect'
 
-await initializeInstrumentation({
-  configUrl: 'https://config.company.com/instrumentation.yaml',
-  cacheTimeout: 300_000 // 5 minutes
-})
+const process = Effect.gen(function* () {
+  yield* annotateUser('user-123', 'user@example.com')
+  yield* annotateBatch(100, 10)
+  yield* annotateCache(true, 'user:123')
+  // ...
+}).pipe(Effect.withSpan('batch.process'))
 ```
 
-## Configuration
-
-### Priority Order (Highest to Lowest)
+Available: `annotateUser`, `annotateBatch`, `annotateDataSize`, `annotateLLM`, `annotateQuery`, `annotateHttpRequest`, `annotateError`, `annotatePriority`, `annotateCache`
 
-1. **Explicit Config Object** - Passed programmatically
-2. **Environment Variable** - `ATRIM_INSTRUMENTATION_CONFIG`
-3. **Project Root File** - `./instrumentation.yaml`
-4. **Default Config** - Built-in defaults
+## Configuration (Optional)
 
-### instrumentation.yaml Example
+Create `instrumentation.yaml` in your project root:
 
 ```yaml
 version: "1.0"
-
 instrumentation:
   enabled: true
-  logging: "on"
-
-  # Pattern-based span filtering
   instrument_patterns:
-    - pattern: "^app\\."
-      enabled: true
-      description: "Application operations"
-    - pattern: "^storage\\."
-      enabled: true
-      description: "Storage layer"
-
+    - pattern: "^app\\."      # Trace app operations
   ignore_patterns:
-    - pattern: "^health\\."
-      description: "Health checks"
-    - pattern: "^metrics\\."
-      description: "Metrics endpoints"
-
-# Effect-TS specific (optional)
-effect:
-  auto_extract_metadata: true
-```
-
-See [Configuration Guide](../../docs/configuration.md) for complete reference.
-
-## HTTP Request Filtering
-
-**IMPORTANT:** HTTP filtering requires explicit configuration to prevent noisy traces.
-
-### Add HTTP Filtering Patterns
-
-```yaml
-# instrumentation.yaml
-instrumentation:
+    - pattern: "^health\\."   # Skip health checks
   http_filtering:
     enabled: true
     ignore_routes:
       - pattern: "^/health$"
       - pattern: "^/metrics$"
-      - pattern: "^/api/internal/"
-      - pattern: "http://.*:4318/v1/traces"  # Prevent OTLP trace loops!
 ```
 
-See [HTTP Filtering Guide](../../docs/HTTP_FILTERING_INVESTIGATION.md) for details.
-
-## API Reference
-
-### Standard API (Promise-based)
+**Priority order:** Explicit config > `ATRIM_INSTRUMENTATION_CONFIG` env var > `./instrumentation.yaml` > defaults
 
-```typescript
-// Main initialization
-initializeInstrumentation(options?: SdkInitializationOptions): Promise<NodeSDK | null>
-
-// Pattern matching only (skip SDK)
-initializePatternMatchingOnly(options?: ConfigLoaderOptions): Promise<void>
+## Runtimes & Frameworks
 
-// Configuration
-loadConfig(options?: ConfigLoaderOptions): Promise<InstrumentationConfig>
+| Runtime | Version |
+|---------|---------|
+| Node.js | 20+ |
+| Bun | 1.0+ |
+| Deno | 1.40+ |
 
-// Service detection
-detectServiceInfo(): Promise<ServiceInfo>
-getServiceName(): Promise<string>
-getServiceVersion(): Promise<string>
-```
+| Framework | Support |
+|-----------|---------|
+| Express | Auto-instrumented (via OTel) |
+| Fastify | Auto-instrumented (via OTel) |
+| Koa | Auto-instrumented (via OTel) |
+| Hono | Manual spans |
+| Effect-TS | First-class integration (unique) |
 
-### Effect API
+## Version Compatibility
 
-```typescript
-// Main initialization (Effect)
-initializeInstrumentationEffect(options?: SdkInitializationOptions): Effect.Effect<NodeSDK | null, InitializationError | ConfigError>
-
-// Effect-TS Layer
-EffectInstrumentationLive: Layer.Layer<Tracer.Tracer, ConfigError, never>
-
-// Service detection (Effect)
-detectServiceInfoEffect: Effect.Effect<ServiceInfo, ServiceDetectionError>
-getServiceNameEffect: Effect.Effect<string, ServiceDetectionError>
-getServiceVersionEffect: Effect.Effect<string, never>
-```
+| @atrim/instrument-node | @opentelemetry/api | effect |
+|------------------------|--------------------| -------|
+| 0.6.x                  | ^1.0.0 (1.0 - 1.9+) | ^3.0.0 (optional) |
 
-See [API Reference](../../docs/api-reference.md) for complete documentation.
+**Notes:**
 
-## Runtimes Supported
-
-- ✅ **Node.js** 20.0.0+
-- ✅ **Bun** 1.0.0+
-- ✅ **Deno** 1.40.0+ (via npm compatibility)
-
-## Frameworks Supported
-
-- ✅ **Express** - Auto-instrumentation included
-- ✅ **Fastify** - Auto-instrumentation included
-- ✅ **Koa** - Auto-instrumentation included
-- ✅ **Hono** - Works with manual spans
-- ✅ **Vanilla HTTP** - Works with any Node.js HTTP server
-- ✅ **Effect-TS** - First-class integration with Effect.withSpan()
-
-## Examples
-
-See the [examples directory](../../examples/) for complete working examples:
-
-- [Express](../../examples/express/) - Basic Express app
-- [Effect-TS](../../examples/effect-ts/) - Advanced Effect patterns
-- [Effect Platform](../../examples/effect-platform/) - Pure Effect HTTP server
-- [Vanilla TypeScript](../../examples/vanilla/) - Standard Node.js
-- [Bun Runtime](../../examples/bun/) - Bun-specific example
-- [Remote Config](../../examples/remote-config/) - Load config from URL
-- [Multi-Service](../../examples/multi-service/) - Distributed tracing
+- `@opentelemetry/api` is the only required peer dependency
+- Effect packages are optional - core features work without them
+- The library is tested with @opentelemetry/api 1.9.x in CI
 
 ## Troubleshooting
 
-See [Troubleshooting Guide](../../docs/TROUBLESHOOTING.md) for common issues and solutions.
-
-### Quick Fixes
+**No traces?** Check collector: `docker run -p 4318:4318 otel/opentelemetry-collector`
 
-**No traces appearing?**
-- Check collector is running: `docker run -p 4318:4318 otel/opentelemetry-collector`
-- Check endpoint: `OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318`
+**Too many traces?** Add HTTP filtering patterns for health checks, metrics, OTLP exports.
 
-**Too many traces?**
-- Add HTTP filtering patterns (health checks, metrics, OTLP exports)
-- See [HTTP Filtering Guide](../../docs/HTTP_FILTERING_INVESTIGATION.md)
+**Effect spans missing?** Ensure you're using `Effect.withSpan()` and providing `EffectInstrumentationLive`.
 
-**Effect-TS spans not appearing?**
-- Make sure you're using `Effect.withSpan()`
-- Provide `EffectInstrumentationLive` layer
-
-## Contributing
+## Documentation
 
-Contributions welcome! See [main repository](https://github.com/atrim-ai/instrumentation) for guidelines.
+- [Getting Started](../../docs/getting-started.md)
+- [Configuration Reference](../../docs/configuration.md)
+- [API Reference](../../docs/api-reference.md)
+- [Examples](../../examples/)
+- [Troubleshooting](../../docs/TROUBLESHOOTING.md)
 
 ## License
 
-MIT © Atrim AI
-
-## Related Packages
-
-- [@atrim/instrument-core](../core) - Internal shared logic (private)
-- @atrim/instrument-web - Browser/web support _(Phase 1)_
-
-## Links
-
-- 📦 [npm package](https://www.npmjs.com/package/@atrim/instrument-node)
-- 🐙 [GitHub repository](https://github.com/atrim-ai/instrumentation)
-- 🐛 [Issue tracker](https://github.com/atrim-ai/instrumentation/issues)
-- 📖 [Documentation](https://github.com/atrim-ai/instrumentation#readme)
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atrim/instrument-node",
-  "version": "0.5.0",
+  "version": "0.5.1-3a86b84-20260105170223",
   "description": "OpenTelemetry instrumentation for Node.js with centralized YAML configuration",
   "type": "module",
   "license": "MIT",
@@ -54,50 +54,48 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@effect/opentelemetry": "^0.59.0",
-    "@effect/platform": "^0.93.0",
-    "@effect/platform-node": "latest",
     "@opentelemetry/auto-instrumentations-node": "^0.67.0",
     "@opentelemetry/exporter-trace-otlp-http": "^0.208.0",
     "@opentelemetry/instrumentation": "^0.208.0",
+    "@opentelemetry/resources": "^2.2.0",
     "@opentelemetry/sdk-node": "^0.208.0",
     "@opentelemetry/sdk-trace-base": "^2.2.0",
-    "effect": "^3.19.0",
+    "@opentelemetry/sdk-trace-node": "^2.2.0",
+    "@opentelemetry/semantic-conventions": "^1.38.0",
     "yaml": "^2.3.0",
     "zod": "^3.22.0"
   },
   "devDependencies": {
+    "@effect/opentelemetry": "^0.59.1",
+    "@effect/platform": "^0.93.6",
+    "@effect/platform-node": "^0.103.0",
     "@opentelemetry/api": "^1.9.0",
-    "@opentelemetry/resources": "^2.2.0",
     "@opentelemetry/sdk-logs": "^0.208.0",
     "@opentelemetry/sdk-metrics": "^2.2.0",
     "@opentelemetry/sdk-trace-node": "^2.2.0",
     "@opentelemetry/sdk-trace-web": "^2.2.0",
     "@opentelemetry/semantic-conventions": "^1.38.0",
-    "@types/node": "^20.10.0",
-    "@vitest/coverage-v8": "^4.0.8",
-    "effect": "^3.19.0",
-    "testcontainers": "^11.8.1",
+    "@types/node": "^25.0.3",
+    "@vitest/coverage-v8": "^4.0.16",
+    "effect": "^3.19.8",
+    "testcontainers": "^11.11.0",
     "tsup": "^8.0.1",
     "tsx": "^4.7.0",
     "typescript": "^5.7.2",
-    "vitest": "^4.0.8",
+    "vitest": "^4.0.16",
     "@atrim/instrument-core": "0.5.0"
   },
   "peerDependencies": {
+    "@opentelemetry/api": "^1.0.0",
+    "effect": "^3.0.0",
     "@effect/opentelemetry": ">=0.40.0",
     "@effect/platform": ">=0.70.0",
-    "@opentelemetry/api": "^1.0.0",
-    "@opentelemetry/sdk-trace-base": "^1.0.0",
-    "effect": "^3.0.0"
+    "@effect/platform-node": ">=0.60.0"
   },
   "peerDependenciesMeta": {
     "@opentelemetry/api": {
       "optional": false
     },
-    "@opentelemetry/sdk-trace-base": {
-      "optional": true
-    },
     "effect": {
       "optional": true
     },
@@ -106,6 +104,9 @@
     },
     "@effect/platform": {
       "optional": true
+    },
+    "@effect/platform-node": {
+      "optional": true
     }
   },
   "scripts": {
@@ -122,10 +123,10 @@
     "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
     "format:check": "prettier --check \"src/**/*.ts\" \"test/**/*.ts\"",
     "clean": "rm -rf target",
-    "publish:dev:version": "npm version $(git describe --tags --abbrev=0 | sed 's/^.*@//' | sed 's/^v//')-$(git rev-parse --short HEAD)-$(date -u +%Y%m%d%H%M%S) --no-git-tag-version",
+    "publish:dev:version": "pnpm version $(node -p \"require('./package.json').version\")-$(git rev-parse --short HEAD)-$(date -u +%Y%m%d%H%M%S) --no-git-tag-version",
     "publish:dev:save": "node -p \"require('./package.json').version\" > .version",
     "publish:dev:publish": "pnpm build && pnpm publish --tag dev --access public --no-git-checks",
-    "publish:dev:reset": "npm version 1.0.0 --no-git-tag-version",
+    "publish:dev:reset": "pnpm version 0.5.1 --no-git-tag-version",
     "publish:dev": "pnpm publish:dev:version && pnpm publish:dev:save && pnpm publish:dev:publish && pnpm publish:dev:reset"
   }
 }