brass-runtime 1.15.0 → 1.16.0

package/dist/observability/index.d.ts

@@ -0,0 +1,79 @@
+import { L as LogLevel, S as SpanAttributes, O as Observability, T as TraceContextCarrier, R as RequestObservabilityContextInput, a as RequestObservabilityContext, b as ObservabilityOptions } from '../server-C8hDXA74.js';
+export { C as CardinalityConfig, c as CardinalityLimiterOptions, E as ExportBatchResult, d as ExportPipeline, e as ExportPipelineFlushOptions, f as ExportPipelineFlushResult, g as ExportPipelineOptions, h as ExportPipelineStats, i as ExportPipelineTuning, j as ExportRetryOptions, k as ExportSignal, H as HealthCheck, l as HealthCheckResult, m as HealthHttpResponse, n as HealthStatus, o as HttpServerObservabilityLogOptions, p as HttpServerObservabilityOptions, q as HttpServerObservabilitySpanOptions, r as HttpServerOutcome, I as InjectTraceContextOptions, s as OTLP_JSON_CONTENT_TYPE, t as ObservabilityExporters, u as ObservabilityFlushError, v as ObservabilityFlushResult, w as ObservabilityLogExportResult, x as ObservabilityOtlpOptions, y as ObservabilityRedactor, z as ObservabilityRequestEnvInput, A as ObservabilityRuntimeEnv, B as ObservabilityTraceExportResult, D as ObservedHttpServerResult, F as OtlpAttributeValue, G as OtlpExportOptions, J as OtlpFetch, K as OtlpHttpExportResult, M as OtlpHttpExporterOptions, N as OtlpHttpResponse, P as PROMETHEUS_CONTENT_TYPE, Q as PrometheusMetricsExporter, U as PrometheusMetricsOptions, V as RedactionConfig, W as RedactionOptions, X as RequestObservabilityRuntimeOptions, Y as ResolvedTraceSampling, Z as RuntimeHealthOptions, _ as RuntimeHealthReport, $ as RuntimeMetricsSinkOptions, a0 as SpanLink, a1 as SpanOptions, a2 as SpanSource, a3 as StructuredLogRecord, a4 as StructuredLogSinkOptions, a5 as StructuredLogSource, a6 as TraceContextHeaderValue, a7 as TraceSamplingConfig, a8 as TraceSamplingOptions, a9 as TraceSamplingRule, aa as alwaysOffSampler, ab as alwaysOnSampler, ac as currentBaggage, ad as currentSpanLink, ae as defaultStructuredLogWriter, af as exemplarFromTraceContext, ag as exportWithRetry, ah as extractBaggage, ai as extractTraceContext, aj as formatBaggage, ak as formatPrometheusMetrics, al as formatStructuredLog, am as formatTraceparent, an as healthToHttpResponse, ao as injectBaggage, ap as injectTraceContext, aq as logEffect, ar as makeCardinalityLimitedMetrics, as as makeExportPipeline, at as makeObservability, au as makeObservabilityRedactor, av as makeOtlpHttpLogExporter, aw as makeOtlpHttpMetricsExporter, ax as makeOtlpHttpSpanExporter, ay as makePrometheusMetricsExporter, az as makeRequestObservabilityContext, aA as makeRuntimeHealth, aB as makeRuntimeMetricsSink, aC as makeStructuredLogSink, aD as makeTraceSampler, aE as metricsSnapshotToOtlp, aF as normalizeHttpRoute, aG as normalizeSpanId, aH as normalizeTraceId, aI as observeHttpServerRequest, aJ as otlpAnyValue, aK as parseBaggage, aL as parseTraceparent, aM as postOtlpJson, aN as ratioSampler, aO as readiness, aP as resolveRequestBaggage, aQ as resolveRequestTraceSeed, aR as resolveTraceSampling, aS as runObservedHttpServerEffect, aT as runtimeHealth, aU as sanitizeHttpTarget, aV as shouldSampleWith, aW as snapshotRuntimeHealth, aX as spanEvent, aY as spanLink, aZ as spansToOtlp, a_ as structuredLogsToOtlp, a$ as toOtlpAttributes, b0 as unixNanoFromMs, b1 as withBaggage, b2 as withLogContext, b3 as withSpan, b4 as withTimeout } from '../server-C8hDXA74.js';
+import { M as MetricsRegistry } from '../tracer-B5tRH9H7.js';
+import { a as HttpRequest, d as HttpMiddleware } from '../client-CtFmoDvM.js';
+import '../effect-CGNl5Rqp.js';
+import '../stream-dvSs0QS5.js';
+import '../schedule-Fque9Abz.js';
+
+type HttpOutcome = "success" | "error" | "abort" | "bad_url" | "fetch_error" | "timeout" | "pool_rejected" | "pool_timeout" | "pool_closed" | "batch_split_error";
+type HttpObservabilityLogOptions = {
+    readonly requestLevel?: LogLevel | false;
+    readonly responseLevel?: LogLevel | false;
+    readonly errorLevel?: LogLevel | false;
+};
+type HttpObservabilitySpanOptions = {
+    readonly name?: string | ((req: HttpRequest) => string);
+    readonly attributes?: SpanAttributes | ((req: HttpRequest) => SpanAttributes);
+};
+type HttpAdaptiveLimiterObservabilityOptions = {
+    readonly enabled?: boolean;
+    /**
+     * Adds a `key` metric label when a stable limiter key can be inferred.
+     * Keep disabled for high-cardinality downstreams.
+     */
+    readonly includeKeyLabel?: boolean;
+};
+type HttpObservabilityOptions = {
+    readonly metrics?: MetricsRegistry | false;
+    readonly logs?: false | HttpObservabilityLogOptions;
+    readonly spans?: false | HttpObservabilitySpanOptions;
+    readonly adaptiveLimiter?: boolean | HttpAdaptiveLimiterObservabilityOptions;
+    readonly injectTraceHeaders?: boolean;
+    readonly includeHostLabel?: boolean;
+    readonly route?: string | ((req: HttpRequest) => string | undefined);
+    readonly clock?: () => number;
+    readonly durationBuckets?: readonly number[];
+};
+declare function withHttpObservability(options?: Observability | HttpObservabilityOptions): HttpMiddleware;
+declare const makeHttpObservabilityMiddleware: typeof withHttpObservability;
+
+type FetchLikeRequest = {
+    readonly headers?: TraceContextCarrier;
+    readonly method?: string;
+    readonly url?: string;
+};
+type NodeLikeIncomingMessage = {
+    readonly headers?: Record<string, string | readonly string[] | undefined>;
+    readonly method?: string;
+    readonly url?: string;
+};
+type ExpressLikeRequest = NodeLikeIncomingMessage & {
+    readonly originalUrl?: string;
+    readonly path?: string;
+    readonly route?: {
+        readonly path?: string;
+    };
+};
+type FastifyLikeRequest = NodeLikeIncomingMessage & {
+    readonly routeOptions?: {
+        readonly url?: string;
+    };
+    readonly routerPath?: string;
+};
+declare function makeFetchRequestObservabilityContext(observability: Observability, request: FetchLikeRequest, input?: RequestObservabilityContextInput): RequestObservabilityContext;
+declare function makeNodeRequestObservabilityContext(observability: Observability, request: NodeLikeIncomingMessage, input?: RequestObservabilityContextInput): RequestObservabilityContext;
+declare function makeExpressRequestObservabilityContext(observability: Observability, request: ExpressLikeRequest, input?: RequestObservabilityContextInput): RequestObservabilityContext;
+declare function makeFastifyRequestObservabilityContext(observability: Observability, request: FastifyLikeRequest, input?: RequestObservabilityContextInput): RequestObservabilityContext;
+declare function withFetchRequestObservability<RequestLike extends FetchLikeRequest, A>(observability: Observability, handler: (ctx: RequestObservabilityContext, request: RequestLike) => A | Promise<A>, input?: RequestObservabilityContextInput): (request: RequestLike) => Promise<A>;
+declare function withNodeRequestObservability<RequestLike extends NodeLikeIncomingMessage, A>(observability: Observability, handler: (ctx: RequestObservabilityContext, request: RequestLike) => A | Promise<A>, input?: RequestObservabilityContextInput): (request: RequestLike) => Promise<A>;
+
+type ObservabilityPreset = "development" | "production" | "test" | "disabled";
+type ObservabilityEnv = Record<string, string | undefined>;
+declare function makeNoopObservability(): Observability;
+declare function makeObservabilityPreset(preset: ObservabilityPreset, overrides?: ObservabilityOptions): Observability;
+declare function makeObservabilityFromEnv(env?: ObservabilityEnv, overrides?: ObservabilityOptions): Observability;
+declare function observabilityOptionsForPreset(preset: Exclude<ObservabilityPreset, "disabled">): ObservabilityOptions;
+declare function observabilityOptionsFromEnv(env?: ObservabilityEnv, preset?: Exclude<ObservabilityPreset, "disabled">): ObservabilityOptions;
+
+export { type ExpressLikeRequest, type FastifyLikeRequest, type FetchLikeRequest, type HttpAdaptiveLimiterObservabilityOptions, type HttpObservabilityLogOptions, type HttpObservabilityOptions, type HttpObservabilitySpanOptions, type HttpOutcome, LogLevel, type NodeLikeIncomingMessage, Observability, type ObservabilityEnv, ObservabilityOptions, type ObservabilityPreset, RequestObservabilityContext, RequestObservabilityContextInput, SpanAttributes, TraceContextCarrier, makeExpressRequestObservabilityContext, makeFastifyRequestObservabilityContext, makeFetchRequestObservabilityContext, makeHttpObservabilityMiddleware, makeNodeRequestObservabilityContext, makeNoopObservability, makeObservabilityFromEnv, makeObservabilityPreset, observabilityOptionsForPreset, observabilityOptionsFromEnv, withFetchRequestObservability, withHttpObservability, withNodeRequestObservability };