@atrim/instrument-node 0.5.1 → 0.5.2-dev.5f953c6.20251221220614

package/target/dist/index.d.cts

@@ -548,6 +548,10 @@ declare function getServiceVersionAsync(): Promise<string | undefined>;
  * This processor filters spans based on configured patterns before they are exported.
  * It wraps another processor (typically BatchSpanProcessor) and only forwards spans
  * that match the instrumentation patterns.
+ *
+ * Filtering is applied at two levels:
+ * 1. Span name patterns (instrument_patterns / ignore_patterns)
+ * 2. HTTP path patterns (http.ignore_incoming_paths) - for HTTP spans
  */
 
 /**
@@ -570,6 +574,7 @@ declare function getServiceVersionAsync(): Promise<string | undefined>;
 declare class PatternSpanProcessor implements SpanProcessor {
     private matcher;
     private wrappedProcessor;
+    private httpIgnorePatterns;
     constructor(config: InstrumentationConfig, wrappedProcessor: SpanProcessor);
     /**
      * Called when a span is started
@@ -582,8 +587,20 @@ declare class PatternSpanProcessor implements SpanProcessor {
      * Called when a span is ended
      *
      * This is where we make the final decision on whether to export the span.
+     * We check both span name patterns and HTTP path patterns.
      */
     onEnd(span: ReadableSpan): void;
+    /**
+     * Check if span should be ignored based on HTTP path attributes
+     *
+     * This checks the span's url.path, http.route, or http.target attributes
+     * against the configured http.ignore_incoming_paths patterns.
+     *
+     * This enables filtering of Effect HTTP spans (and any other HTTP spans)
+     * based on path patterns, which is essential for filtering out OTLP
+     * endpoint requests like /v1/traces, /v1/logs, /v1/metrics.
+     */
+    private shouldIgnoreHttpSpan;
     /**
      * Shutdown the processor
      */

package/target/dist/index.d.ts

@@ -548,6 +548,10 @@ declare function getServiceVersionAsync(): Promise<string | undefined>;
  * This processor filters spans based on configured patterns before they are exported.
  * It wraps another processor (typically BatchSpanProcessor) and only forwards spans
  * that match the instrumentation patterns.
+ *
+ * Filtering is applied at two levels:
+ * 1. Span name patterns (instrument_patterns / ignore_patterns)
+ * 2. HTTP path patterns (http.ignore_incoming_paths) - for HTTP spans
  */
 
 /**
@@ -570,6 +574,7 @@ declare function getServiceVersionAsync(): Promise<string | undefined>;
 declare class PatternSpanProcessor implements SpanProcessor {
     private matcher;
     private wrappedProcessor;
+    private httpIgnorePatterns;
     constructor(config: InstrumentationConfig, wrappedProcessor: SpanProcessor);
     /**
      * Called when a span is started
@@ -582,8 +587,20 @@ declare class PatternSpanProcessor implements SpanProcessor {
      * Called when a span is ended
      *
      * This is where we make the final decision on whether to export the span.
+     * We check both span name patterns and HTTP path patterns.
      */
     onEnd(span: ReadableSpan): void;
+    /**
+     * Check if span should be ignored based on HTTP path attributes
+     *
+     * This checks the span's url.path, http.route, or http.target attributes
+     * against the configured http.ignore_incoming_paths patterns.
+     *
+     * This enables filtering of Effect HTTP spans (and any other HTTP spans)
+     * based on path patterns, which is essential for filtering out OTLP
+     * endpoint requests like /v1/traces, /v1/logs, /v1/metrics.
+     */
+    private shouldIgnoreHttpSpan;
     /**
      * Shutdown the processor
      */

package/target/dist/index.js

@@ -84,6 +84,13 @@ var InstrumentationConfigSchema = z.object({
     ignore_patterns: z.array(PatternConfigSchema)
   }),
   effect: z.object({
+    // Enable/disable Effect tracing entirely
+    // When false, EffectInstrumentationLive returns Layer.empty
+    enabled: z.boolean().default(true),
+    // Exporter mode:
+    // - "unified": Use global TracerProvider from Node SDK (recommended, enables filtering)
+    // - "standalone": Use Effect's own OTLP exporter (bypasses Node SDK filtering)
+    exporter: z.enum(["unified", "standalone"]).default("unified"),
     auto_extract_metadata: z.boolean(),
     auto_isolation: AutoIsolationConfigSchema.optional()
   }).optional(),
@@ -430,8 +437,14 @@ var PatternSpanProcessor = class {
   constructor(config, wrappedProcessor) {
     __publicField(this, "matcher");
     __publicField(this, "wrappedProcessor");
+    __publicField(this, "httpIgnorePatterns", []);
     this.matcher = new PatternMatcher(config);
     this.wrappedProcessor = wrappedProcessor;
+    if (config.http?.ignore_incoming_paths) {
+      this.httpIgnorePatterns = config.http.ignore_incoming_paths.map(
+        (pattern) => new RegExp(pattern)
+      );
+    }
   }
   /**
    * Called when a span is started
@@ -449,12 +462,40 @@ var PatternSpanProcessor = class {
    * Called when a span is ended
    *
    * This is where we make the final decision on whether to export the span.
+   * We check both span name patterns and HTTP path patterns.
    */
   onEnd(span) {
     const spanName = span.name;
-    if (this.matcher.shouldInstrument(spanName)) {
-      this.wrappedProcessor.onEnd(span);
+    if (!this.matcher.shouldInstrument(spanName)) {
+      return;
+    }
+    if (this.shouldIgnoreHttpSpan(span)) {
+      return;
+    }
+    this.wrappedProcessor.onEnd(span);
+  }
+  /**
+   * Check if span should be ignored based on HTTP path attributes
+   *
+   * This checks the span's url.path, http.route, or http.target attributes
+   * against the configured http.ignore_incoming_paths patterns.
+   *
+   * This enables filtering of Effect HTTP spans (and any other HTTP spans)
+   * based on path patterns, which is essential for filtering out OTLP
+   * endpoint requests like /v1/traces, /v1/logs, /v1/metrics.
+   */
+  shouldIgnoreHttpSpan(span) {
+    if (this.httpIgnorePatterns.length === 0) {
+      return false;
+    }
+    const urlPath = span.attributes["url.path"];
+    const httpRoute = span.attributes["http.route"];
+    const httpTarget = span.attributes["http.target"];
+    const pathToCheck = urlPath || httpRoute || httpTarget;
+    if (!pathToCheck) {
+      return false;
     }
+    return this.httpIgnorePatterns.some((pattern) => pattern.test(pathToCheck));
   }
   /**
    * Shutdown the processor
@@ -743,6 +784,8 @@ function getDefaultConfig() {
       ]
     },
     effect: {
+      enabled: true,
+      exporter: "unified",
       auto_extract_metadata: true
     }
   };