brass-runtime 1.16.0 → 1.16.1

package/dist/observability/index.d.ts

@@ -1,10 +1,11 @@
-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';
+import { L as LogLevel, S as SpanAttributes, O as Observability, T as TraceContextCarrier, R as RequestObservabilityContextInput, a as RequestObservabilityContext, b as ObservabilityOptions } from '../server-GJPg8ZSG.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-GJPg8ZSG.js';
+import { M as MetricsRegistry } from '../tracer-Hwt1cl7h.js';
+import { a as HttpRequest, d as HttpMiddleware } from '../client-CZHU674n.js';
+import '../effect-DIUHZ9IN.js';
+import '../schedule-CK3Ml_7p.js';
+import '../stream-B4oK9JFP.js';
+import '../schema/index.js';
 
 type HttpOutcome = "success" | "error" | "abort" | "bad_url" | "fetch_error" | "timeout" | "pool_rejected" | "pool_timeout" | "pool_closed" | "batch_split_error";
 type HttpObservabilityLogOptions = {
@@ -24,17 +25,89 @@ type HttpAdaptiveLimiterObservabilityOptions = {
      */
     readonly includeKeyLabel?: boolean;
 };
+type HttpPolicyLabelKey = "preset" | "lane" | "poolKey" | "dedupKey" | "priority" | "retry";
+type HttpPolicyObservabilityOptions = {
+    readonly enabled?: boolean;
+    /**
+     * Adds selected policy fields as metric labels. Disabled by default because
+     * pool keys, lanes, and dedup keys may be high-cardinality in user systems.
+     */
+    readonly labelKeys?: readonly HttpPolicyLabelKey[];
+};
 type HttpObservabilityOptions = {
     readonly metrics?: MetricsRegistry | false;
     readonly logs?: false | HttpObservabilityLogOptions;
     readonly spans?: false | HttpObservabilitySpanOptions;
     readonly adaptiveLimiter?: boolean | HttpAdaptiveLimiterObservabilityOptions;
+    readonly policy?: boolean | HttpPolicyObservabilityOptions;
     readonly injectTraceHeaders?: boolean;
     readonly includeHostLabel?: boolean;
     readonly route?: string | ((req: HttpRequest) => string | undefined);
     readonly clock?: () => number;
     readonly durationBuckets?: readonly number[];
 };
+declare const HTTP_OBSERVABILITY_CONTRACT: Readonly<{
+    readonly metrics: Readonly<{
+        requestsTotal: "brass_http_client_requests_total";
+        durationMs: "brass_http_client_duration_ms";
+        inFlight: "brass_http_client_in_flight";
+        adaptiveLimiterLimit: "brass_http_adaptive_limiter_limit";
+        adaptiveLimiterInFlight: "brass_http_adaptive_limiter_in_flight";
+        adaptiveLimiterQueueDepth: "brass_http_adaptive_limiter_queue_depth";
+        adaptiveLimiterStateCount: "brass_http_adaptive_limiter_state_count";
+        adaptiveLimiterUtilization: "brass_http_adaptive_limiter_utilization";
+        adaptiveLimiterErrorRate: "brass_http_adaptive_limiter_error_rate";
+        adaptiveLimiterRequestsPerSecond: "brass_http_adaptive_limiter_requests_per_second";
+        adaptiveLimiterCompletionsPerSecond: "brass_http_adaptive_limiter_completions_per_second";
+        adaptiveLimiterRejectionRate: "brass_http_adaptive_limiter_rejection_rate";
+    }>;
+    readonly labels: Readonly<{
+        method: "method";
+        host: "host";
+        route: "route";
+        outcome: "outcome";
+        status: "status";
+        adaptiveLimiterKey: "key";
+        lane: "lane";
+        poolKey: "pool_key";
+        dedupKey: "dedup_key";
+        priority: "priority";
+        retry: "retry";
+        policy: "policy";
+    }>;
+    readonly spanAttributes: Readonly<{
+        method: "http.request.method";
+        url: "url.full";
+        route: "http.route";
+        host: "server.address";
+        durationMs: "http.duration_ms";
+        outcome: "http.outcome";
+        statusCode: "http.status_code";
+        retryable: "http.retryable";
+        policyLane: "http.request.policy.lane";
+        policyPreset: "http.request.policy.preset";
+        policyPoolKey: "http.request.policy.pool_key";
+        policyDedupKey: "http.request.policy.dedup_key";
+        policyPriority: "http.request.policy.priority";
+        policyRetry: "http.request.policy.retry";
+    }>;
+    readonly logMessages: Readonly<{
+        request: "http.client.request";
+        response: "http.client.response";
+        error: "http.client.error";
+    }>;
+    readonly logFields: Readonly<{
+        method: "method";
+        url: "url";
+        host: "host";
+        route: "route";
+        status: "status";
+        outcome: "outcome";
+        durationMs: "durationMs";
+        retryable: "retryable";
+        policy: "policy";
+    }>;
+}>;
 declare function withHttpObservability(options?: Observability | HttpObservabilityOptions): HttpMiddleware;
 declare const makeHttpObservabilityMiddleware: typeof withHttpObservability;
 
@@ -76,4 +149,4 @@ declare function makeObservabilityFromEnv(env?: ObservabilityEnv, overrides?: Ob
 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 };
+export { type ExpressLikeRequest, type FastifyLikeRequest, type FetchLikeRequest, HTTP_OBSERVABILITY_CONTRACT, type HttpAdaptiveLimiterObservabilityOptions, type HttpObservabilityLogOptions, type HttpObservabilityOptions, type HttpObservabilitySpanOptions, type HttpOutcome, type HttpPolicyLabelKey, type HttpPolicyObservabilityOptions, 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 };