@pingops/otel 0.2.6 → 0.4.0

package/README.md

@@ -49,24 +49,47 @@ const processor = new PingopsSpanProcessor({
 - `baseUrl: string` - PingOps backend URL (required)
 - `debug?: boolean` - Enable debug logging (default: `false`)
 - `serviceName: string` - Service name for resource identification (required)
-- `headersAllowList?: string[]` - List of headers to include (case-insensitive)
-- `headersDenyList?: string[]` - List of headers to exclude (case-insensitive, takes precedence)
+- `transforms?: HttpTransformConfig` - Outbound transform rules for request/response headers, bodies, and query params
 - `domainAllowList?: DomainRule[]` - Domain allow list rules
 - `domainDenyList?: DomainRule[]` - Domain deny list rules
+- `llmMonitoring?: LlmMonitoringConfig` - Optional GenAI usage enrichment (disabled by default)
 - `batchSize?: number` - Batch size for sending spans, only used in batched mode (default: `50`)
 - `batchTimeout?: number` - Batch timeout in milliseconds, only used in batched mode (default: `5000`)
 - `exportMode?: 'immediate' | 'batched'` - Span export mode:
   - **batched**: Recommended for production environments with long-running processes. Spans are batched and exported in groups for optimal performance (default)
   - **immediate**: Recommended for short-lived environments such as serverless functions. Spans are exported immediately to prevent data loss when the process terminates
 
+### LLM Monitoring (Opt-In)
+
+```ts
+const processor = new PingopsSpanProcessor({
+  apiKey: "your-api-key",
+  baseUrl: "https://api.pingops.com",
+  serviceName: "my-service",
+  llmMonitoring: {
+    enabled: true,
+    streaming: true,
+  },
+});
+```
+
+When enabled, the processor enriches matching outbound LLM spans with:
+
+- OTel GenAI attributes (provider, operation, model, token usage)
+- PingOps token attributes (`pingops.gen_ai.usage.*`) for backend cost computation
+
 ### Domain Rules
 
 ```typescript
 interface DomainRule {
   domain: string; // Exact or suffix match (e.g., '.github.com')
   paths?: string[]; // Path prefix matches
-  headersAllowList?: string[];
-  headersDenyList?: string[];
+  transforms?: HttpTransformConfig; // Domain-specific transform overrides global transforms
+}
+
+interface HttpTransformConfig {
+  applyDefaultSensitiveHeaderRedaction?: boolean; // default true
+  rules?: HttpTransformRule[];
 }
 ```