@atrim/instrument-node 0.4.0 → 0.4.1

package/target/dist/index.d.cts

@@ -3,8 +3,8 @@ import { NodeSDKConfiguration, NodeSDK } from '@opentelemetry/sdk-node';
 import { Instrumentation } from '@opentelemetry/instrumentation';
 import { RequestOptions, IncomingMessage } from 'node:http';
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
-import { ConfigLoaderOptions, InstrumentationConfig, PatternMatcher } from '@atrim/instrument-core';
-export { ConfigLoaderOptions, InstrumentationConfig, PatternConfig, PatternMatcher, getPatternMatcher, loadConfig, shouldInstrumentSpan } from '@atrim/instrument-core';
+import { InstrumentationConfig, PatternMatcher } from '@atrim/instrument-core';
+export { InstrumentationConfig, PatternConfig, PatternMatcher, getPatternMatcher, shouldInstrumentSpan } from '@atrim/instrument-core';
 import * as effect_Cause from 'effect/Cause';
 import * as effect_Types from 'effect/Types';
 import { SpanProcessor, Span, ReadableSpan } from '@opentelemetry/sdk-trace-base';
@@ -45,6 +45,60 @@ declare function createOtlpExporter(options?: OtlpExporterOptions): OTLPTraceExp
  */
 declare function getOtlpEndpoint(options?: OtlpExporterOptions): string;
 
+/**
+ * Node.js configuration loader using Effect Platform
+ *
+ * Provides FileSystem and HttpClient layers for the core ConfigLoader service
+ */
+
+/**
+ * Reset the cached loader (for testing purposes)
+ * @internal
+ */
+declare function _resetConfigLoaderCache(): void;
+/**
+ * Load configuration from URI (Promise-based convenience API)
+ *
+ * Automatically provides Node.js platform layers (FileSystem + HttpClient)
+ *
+ * @param uri - Configuration URI (file://, http://, https://, or relative path)
+ * @param options - Optional loading options (e.g., to disable caching)
+ * @returns Promise that resolves to validated configuration
+ */
+declare function loadConfig(uri: string, options?: {
+    cacheTimeout?: number;
+}): Promise<InstrumentationConfig>;
+/**
+ * Load configuration from inline content (Promise-based convenience API)
+ *
+ * @param content - YAML string, JSON string, or plain object
+ * @returns Promise that resolves to validated configuration
+ */
+declare function loadConfigFromInline(content: string | unknown): Promise<InstrumentationConfig>;
+/**
+ * Legacy options interface for backward compatibility
+ */
+interface ConfigLoaderOptions {
+    configPath?: string;
+    configUrl?: string;
+    config?: InstrumentationConfig;
+    cacheTimeout?: number;
+}
+/**
+ * Load configuration with priority order (backward compatible API)
+ *
+ * Priority order (highest to lowest):
+ * 1. Explicit config object (options.config)
+ * 2. Environment variable (ATRIM_INSTRUMENTATION_CONFIG)
+ * 3. Explicit path/URL (options.configPath or options.configUrl)
+ * 4. Project root file (./instrumentation.yaml)
+ * 5. Default config (built-in defaults)
+ *
+ * @param options - Configuration options
+ * @returns Promise that resolves to validated configuration
+ */
+declare function loadConfigWithOptions(options?: ConfigLoaderOptions): Promise<InstrumentationConfig>;
+
 /**
  * NodeSDK Initialization
  *
@@ -599,4 +653,4 @@ declare function annotateCacheOperation(span: Span$1, operation: 'get' | 'set' |
  */
 declare function suppressShutdownErrors(): void;
 
-export { ConfigError, ConfigFileError, ConfigUrlError, ConfigValidationError, ExportError, InitializationError, type OtlpExporterOptions, PatternSpanProcessor, type SdkInitializationOptions, ServiceDetectionError, type ServiceInfo, ShutdownError, annotateCacheOperation, annotateDbQuery, annotateHttpRequest, createOtlpExporter, detectServiceInfoAsync as detectServiceInfo, detectServiceInfo as detectServiceInfoEffect, getOtlpEndpoint, getSdkInstance, getServiceInfoWithFallback, getServiceNameAsync as getServiceName, getServiceName as getServiceNameEffect, getServiceVersionAsync as getServiceVersion, getServiceVersion as getServiceVersionEffect, initializeInstrumentation, initializeInstrumentationEffect, initializePatternMatchingOnly, initializePatternMatchingOnlyEffect, markSpanError, markSpanSuccess, recordException, resetSdk, setSpanAttributes, shutdownSdk, suppressShutdownErrors };
+export { ConfigError, ConfigFileError, type ConfigLoaderOptions, ConfigUrlError, ConfigValidationError, ExportError, InitializationError, type OtlpExporterOptions, PatternSpanProcessor, type SdkInitializationOptions, ServiceDetectionError, type ServiceInfo, ShutdownError, annotateCacheOperation, annotateDbQuery, annotateHttpRequest, _resetConfigLoaderCache as clearConfigCache, createOtlpExporter, detectServiceInfoAsync as detectServiceInfo, detectServiceInfo as detectServiceInfoEffect, getOtlpEndpoint, getSdkInstance, getServiceInfoWithFallback, getServiceNameAsync as getServiceName, getServiceName as getServiceNameEffect, getServiceVersionAsync as getServiceVersion, getServiceVersion as getServiceVersionEffect, initializeInstrumentation, initializeInstrumentationEffect, initializePatternMatchingOnly, initializePatternMatchingOnlyEffect, loadConfig, loadConfigFromInline, loadConfigWithOptions, markSpanError, markSpanSuccess, recordException, resetSdk, setSpanAttributes, shutdownSdk, suppressShutdownErrors };

package/target/dist/index.d.ts

@@ -3,8 +3,8 @@ import { NodeSDKConfiguration, NodeSDK } from '@opentelemetry/sdk-node';
 import { Instrumentation } from '@opentelemetry/instrumentation';
 import { RequestOptions, IncomingMessage } from 'node:http';
 import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
-import { ConfigLoaderOptions, InstrumentationConfig, PatternMatcher } from '@atrim/instrument-core';
-export { ConfigLoaderOptions, InstrumentationConfig, PatternConfig, PatternMatcher, getPatternMatcher, loadConfig, shouldInstrumentSpan } from '@atrim/instrument-core';
+import { InstrumentationConfig, PatternMatcher } from '@atrim/instrument-core';
+export { InstrumentationConfig, PatternConfig, PatternMatcher, getPatternMatcher, shouldInstrumentSpan } from '@atrim/instrument-core';
 import * as effect_Cause from 'effect/Cause';
 import * as effect_Types from 'effect/Types';
 import { SpanProcessor, Span, ReadableSpan } from '@opentelemetry/sdk-trace-base';
@@ -45,6 +45,60 @@ declare function createOtlpExporter(options?: OtlpExporterOptions): OTLPTraceExp
  */
 declare function getOtlpEndpoint(options?: OtlpExporterOptions): string;
 
+/**
+ * Node.js configuration loader using Effect Platform
+ *
+ * Provides FileSystem and HttpClient layers for the core ConfigLoader service
+ */
+
+/**
+ * Reset the cached loader (for testing purposes)
+ * @internal
+ */
+declare function _resetConfigLoaderCache(): void;
+/**
+ * Load configuration from URI (Promise-based convenience API)
+ *
+ * Automatically provides Node.js platform layers (FileSystem + HttpClient)
+ *
+ * @param uri - Configuration URI (file://, http://, https://, or relative path)
+ * @param options - Optional loading options (e.g., to disable caching)
+ * @returns Promise that resolves to validated configuration
+ */
+declare function loadConfig(uri: string, options?: {
+    cacheTimeout?: number;
+}): Promise<InstrumentationConfig>;
+/**
+ * Load configuration from inline content (Promise-based convenience API)
+ *
+ * @param content - YAML string, JSON string, or plain object
+ * @returns Promise that resolves to validated configuration
+ */
+declare function loadConfigFromInline(content: string | unknown): Promise<InstrumentationConfig>;
+/**
+ * Legacy options interface for backward compatibility
+ */
+interface ConfigLoaderOptions {
+    configPath?: string;
+    configUrl?: string;
+    config?: InstrumentationConfig;
+    cacheTimeout?: number;
+}
+/**
+ * Load configuration with priority order (backward compatible API)
+ *
+ * Priority order (highest to lowest):
+ * 1. Explicit config object (options.config)
+ * 2. Environment variable (ATRIM_INSTRUMENTATION_CONFIG)
+ * 3. Explicit path/URL (options.configPath or options.configUrl)
+ * 4. Project root file (./instrumentation.yaml)
+ * 5. Default config (built-in defaults)
+ *
+ * @param options - Configuration options
+ * @returns Promise that resolves to validated configuration
+ */
+declare function loadConfigWithOptions(options?: ConfigLoaderOptions): Promise<InstrumentationConfig>;
+
 /**
  * NodeSDK Initialization
  *
@@ -599,4 +653,4 @@ declare function annotateCacheOperation(span: Span$1, operation: 'get' | 'set' |
  */
 declare function suppressShutdownErrors(): void;
 
-export { ConfigError, ConfigFileError, ConfigUrlError, ConfigValidationError, ExportError, InitializationError, type OtlpExporterOptions, PatternSpanProcessor, type SdkInitializationOptions, ServiceDetectionError, type ServiceInfo, ShutdownError, annotateCacheOperation, annotateDbQuery, annotateHttpRequest, createOtlpExporter, detectServiceInfoAsync as detectServiceInfo, detectServiceInfo as detectServiceInfoEffect, getOtlpEndpoint, getSdkInstance, getServiceInfoWithFallback, getServiceNameAsync as getServiceName, getServiceName as getServiceNameEffect, getServiceVersionAsync as getServiceVersion, getServiceVersion as getServiceVersionEffect, initializeInstrumentation, initializeInstrumentationEffect, initializePatternMatchingOnly, initializePatternMatchingOnlyEffect, markSpanError, markSpanSuccess, recordException, resetSdk, setSpanAttributes, shutdownSdk, suppressShutdownErrors };
+export { ConfigError, ConfigFileError, type ConfigLoaderOptions, ConfigUrlError, ConfigValidationError, ExportError, InitializationError, type OtlpExporterOptions, PatternSpanProcessor, type SdkInitializationOptions, ServiceDetectionError, type ServiceInfo, ShutdownError, annotateCacheOperation, annotateDbQuery, annotateHttpRequest, _resetConfigLoaderCache as clearConfigCache, createOtlpExporter, detectServiceInfoAsync as detectServiceInfo, detectServiceInfo as detectServiceInfoEffect, getOtlpEndpoint, getSdkInstance, getServiceInfoWithFallback, getServiceNameAsync as getServiceName, getServiceName as getServiceNameEffect, getServiceVersionAsync as getServiceVersion, getServiceVersion as getServiceVersionEffect, initializeInstrumentation, initializeInstrumentationEffect, initializePatternMatchingOnly, initializePatternMatchingOnlyEffect, loadConfig, loadConfigFromInline, loadConfigWithOptions, markSpanError, markSpanSuccess, recordException, resetSdk, setSpanAttributes, shutdownSdk, suppressShutdownErrors };