@smthrs/observability 0.35.0 → 1.0.0-rc.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +56 -0
- package/LICENSE +1 -1
- package/README.md +84 -0
- package/dist/cjs/BrowserOtel.d.ts +37 -0
- package/dist/cjs/BrowserOtel.d.ts.map +1 -0
- package/dist/cjs/BrowserOtel.js +47 -0
- package/dist/cjs/BrowserOtel.js.map +7 -0
- package/dist/cjs/Endpoint.d.ts +70 -0
- package/dist/cjs/Endpoint.d.ts.map +1 -0
- package/dist/cjs/Endpoint.js +85 -0
- package/dist/cjs/Endpoint.js.map +7 -0
- package/dist/cjs/JournalLogger.d.ts +232 -0
- package/dist/cjs/JournalLogger.d.ts.map +1 -0
- package/dist/cjs/JournalLogger.js +388 -0
- package/dist/cjs/JournalLogger.js.map +7 -0
- package/dist/cjs/Logger.d.ts +55 -0
- package/dist/cjs/Logger.d.ts.map +1 -0
- package/dist/cjs/Logger.js +72 -0
- package/dist/cjs/Logger.js.map +7 -0
- package/dist/cjs/Metric.d.ts +67 -0
- package/dist/cjs/Metric.d.ts.map +1 -0
- package/dist/cjs/Metric.js +68 -0
- package/dist/cjs/Metric.js.map +7 -0
- package/dist/cjs/NodeOtel.d.ts +42 -0
- package/dist/cjs/NodeOtel.d.ts.map +1 -0
- package/dist/cjs/NodeOtel.js +78 -0
- package/dist/cjs/NodeOtel.js.map +7 -0
- package/dist/cjs/Otel.d.ts +62 -0
- package/dist/cjs/Otel.d.ts.map +1 -0
- package/dist/cjs/Otel.js +75 -0
- package/dist/cjs/Otel.js.map +7 -0
- package/dist/cjs/Otlp.d.ts +200 -0
- package/dist/cjs/Otlp.d.ts.map +1 -0
- package/dist/cjs/Otlp.js +235 -0
- package/dist/cjs/Otlp.js.map +7 -0
- package/dist/cjs/Resource.d.ts +162 -0
- package/dist/cjs/Resource.d.ts.map +1 -0
- package/dist/cjs/Resource.js +186 -0
- package/dist/cjs/Resource.js.map +7 -0
- package/dist/cjs/index.d.ts +61 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +47 -0
- package/dist/cjs/index.js.map +7 -0
- package/dist/cjs/internal/schemaIssuePath.d.ts +31 -0
- package/dist/cjs/internal/schemaIssuePath.d.ts.map +1 -0
- package/dist/cjs/internal/schemaIssuePath.js +49 -0
- package/dist/cjs/internal/schemaIssuePath.js.map +7 -0
- package/dist/cjs/package.json +1 -0
- package/dist/esm/BrowserOtel.d.ts +37 -0
- package/dist/esm/BrowserOtel.d.ts.map +1 -0
- package/dist/esm/BrowserOtel.js +24 -0
- package/dist/esm/BrowserOtel.js.map +1 -0
- package/dist/esm/Endpoint.d.ts +70 -0
- package/dist/esm/Endpoint.d.ts.map +1 -0
- package/dist/esm/Endpoint.js +110 -0
- package/dist/esm/Endpoint.js.map +1 -0
- package/dist/esm/JournalLogger.d.ts +232 -0
- package/dist/esm/JournalLogger.d.ts.map +1 -0
- package/dist/esm/JournalLogger.js +482 -0
- package/dist/esm/JournalLogger.js.map +1 -0
- package/dist/esm/Logger.d.ts +55 -0
- package/dist/esm/Logger.d.ts.map +1 -0
- package/dist/esm/Logger.js +60 -0
- package/dist/esm/Logger.js.map +1 -0
- package/dist/esm/Metric.d.ts +67 -0
- package/dist/esm/Metric.d.ts.map +1 -0
- package/dist/esm/Metric.js +80 -0
- package/dist/esm/Metric.js.map +1 -0
- package/dist/esm/NodeOtel.d.ts +42 -0
- package/dist/esm/NodeOtel.d.ts.map +1 -0
- package/dist/esm/NodeOtel.js +56 -0
- package/dist/esm/NodeOtel.js.map +1 -0
- package/dist/esm/Otel.d.ts +62 -0
- package/dist/esm/Otel.d.ts.map +1 -0
- package/dist/esm/Otel.js +51 -0
- package/dist/esm/Otel.js.map +1 -0
- package/dist/esm/Otlp.d.ts +200 -0
- package/dist/esm/Otlp.d.ts.map +1 -0
- package/dist/esm/Otlp.js +350 -0
- package/dist/esm/Otlp.js.map +1 -0
- package/dist/esm/Resource.d.ts +162 -0
- package/dist/esm/Resource.d.ts.map +1 -0
- package/dist/esm/Resource.js +237 -0
- package/dist/esm/Resource.js.map +1 -0
- package/dist/esm/index.d.ts +61 -0
- package/dist/esm/index.d.ts.map +1 -0
- package/dist/esm/index.js +61 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/internal/schemaIssuePath.d.ts +31 -0
- package/dist/esm/internal/schemaIssuePath.d.ts.map +1 -0
- package/dist/esm/internal/schemaIssuePath.js +59 -0
- package/dist/esm/internal/schemaIssuePath.js.map +1 -0
- package/docs/README.md +162 -0
- package/docs/api.md +768 -0
- package/docs/concepts/instrumentation-and-export.md +68 -0
- package/docs/concepts/layer-map.md +72 -0
- package/docs/concepts/validated-acquisition.md +105 -0
- package/docs/guides/export-to-a-collector.md +167 -0
- package/docs/guides/forward-logs-to-the-journal.md +226 -0
- package/docs/guides/install-a-logger.md +111 -0
- package/docs/guides/read-runtime-metrics.md +83 -0
- package/docs/guides/testing.md +134 -0
- package/docs/guides/wire-an-opentelemetry-sdk.md +220 -0
- package/docs/installation.md +98 -0
- package/docs/quickstart.md +145 -0
- package/docs/troubleshooting.md +168 -0
- package/package.json +221 -32
- package/src/BrowserOtel.ts +51 -0
- package/src/Endpoint.ts +131 -0
- package/src/JournalLogger.ts +596 -0
- package/src/Logger.ts +106 -0
- package/src/Metric.ts +88 -0
- package/src/NodeOtel.ts +90 -0
- package/src/Otel.ts +117 -0
- package/src/Otlp.ts +477 -0
- package/src/Resource.ts +324 -0
- package/src/index.ts +67 -0
- package/src/internal/schemaIssuePath.ts +65 -0
- package/docker-compose.otel.yml +0 -104
- package/grafana/dashboards/smithers-dashboard.json +0 -453
- package/grafana/provisioning/dashboards/dashboards.yml +0 -12
- package/grafana/provisioning/datasources/datasources.yml +0 -49
- package/loki/loki-config.yaml +0 -35
- package/otel-collector-config.yml +0 -38
- package/prometheus/prometheus.yml +0 -8
- package/src/MetricName.ts +0 -1
- package/src/MetricsServiceLive.js +0 -9
- package/src/README.md +0 -28
- package/src/ResolvedSmithersObservabilityOptions.ts +0 -12
- package/src/SmithersEvent.ts +0 -843
- package/src/SmithersLogFormat.ts +0 -1
- package/src/SmithersMetricDefinition.ts +0 -15
- package/src/SmithersMetricType.ts +0 -1
- package/src/SmithersMetricUnit.ts +0 -1
- package/src/SmithersObservability.js +0 -15
- package/src/SmithersObservabilityOptions.ts +0 -12
- package/src/SmithersObservabilityService.ts +0 -13
- package/src/_coreCorrelation/CorrelationContext.ts +0 -10
- package/src/_coreCorrelation/CorrelationContextLive.js +0 -11
- package/src/_coreCorrelation/CorrelationContextService.js +0 -15
- package/src/_coreCorrelation/CorrelationContextServiceShape.ts +0 -12
- package/src/_coreCorrelation/CorrelationPatch.ts +0 -3
- package/src/_coreCorrelation/README.md +0 -20
- package/src/_coreCorrelation/_correlationStorage.js +0 -4
- package/src/_coreCorrelation/correlationContextFiberRef.js +0 -5
- package/src/_coreCorrelation/correlationContextToLogAnnotations.js +0 -18
- package/src/_coreCorrelation/getCurrentCorrelationContext.js +0 -9
- package/src/_coreCorrelation/getCurrentCorrelationContextEffect.js +0 -11
- package/src/_coreCorrelation/index.js +0 -14
- package/src/_coreCorrelation/mergeCorrelationContext.js +0 -51
- package/src/_coreCorrelation/runWithCorrelationContext.js +0 -14
- package/src/_coreCorrelation/updateCurrentCorrelationContext.js +0 -17
- package/src/_coreCorrelation/withCorrelationContext.js +0 -38
- package/src/_coreCorrelation/withCurrentCorrelationContext.js +0 -11
- package/src/_coreMetrics.js +0 -14
- package/src/_coreMetricsShape.ts +0 -44
- package/src/_corePrometheus.js +0 -91
- package/src/_corePrometheusShape.ts +0 -11
- package/src/_coreTracing.js +0 -132
- package/src/_coreTracingShape.ts +0 -17
- package/src/_otelLogBuilders.js +0 -102
- package/src/_sessionFileResolvers.js +0 -164
- package/src/_smithersSpanAttributeAliases.js +0 -19
- package/src/_smithersTraceSpanStorage.js +0 -3
- package/src/_traceEventNormalizers.js +0 -499
- package/src/_traceRedaction.js +0 -162
- package/src/agentSessionEventToOtelLogRecord.js +0 -55
- package/src/agentTrace.ts +0 -144
- package/src/agentTraceCapabilities.js +0 -151
- package/src/annotateSmithersTrace.js +0 -11
- package/src/canonicalTraceEventToOtelLogRecord.js +0 -55
- package/src/correlation.js +0 -56
- package/src/createSmithersObservabilityLayer.js +0 -59
- package/src/createSmithersOtelLayer.js +0 -23
- package/src/createSmithersRuntimeLayer.js +0 -2
- package/src/detectAgentFamily.js +0 -26
- package/src/detectCaptureMode.js +0 -29
- package/src/emitOtelLogRecord.js +0 -19
- package/src/getCurrentSmithersTraceAnnotations.js +0 -14
- package/src/getCurrentSmithersTraceSpan.js +0 -7
- package/src/index.d.ts +0 -1392
- package/src/index.js +0 -137
- package/src/kindPhase.js +0 -17
- package/src/logging.js +0 -264
- package/src/makeSmithersSpanAttributes.js +0 -20
- package/src/metrics/README.md +0 -22
- package/src/metrics/SmithersMetricDefinition.ts +0 -17
- package/src/metrics/SmithersMetricType.ts +0 -1
- package/src/metrics/SmithersMetricUnit.ts +0 -1
- package/src/metrics/_asyncExternalWaitCounts.js +0 -4
- package/src/metrics/_buckets.js +0 -37
- package/src/metrics/_incrementGauge.js +0 -11
- package/src/metrics/_processStartMs.js +0 -1
- package/src/metrics/activeNodes.js +0 -2
- package/src/metrics/activeRuns.js +0 -2
- package/src/metrics/agentActionsTotal.js +0 -2
- package/src/metrics/agentDurationMs.js +0 -3
- package/src/metrics/agentErrorsTotal.js +0 -2
- package/src/metrics/agentEventsTotal.js +0 -2
- package/src/metrics/agentInvocationsTotal.js +0 -2
- package/src/metrics/agentRetriesTotal.js +0 -2
- package/src/metrics/agentSessionsTotal.js +0 -2
- package/src/metrics/agentTokensTotal.js +0 -2
- package/src/metrics/alertDeliveriesAttempted.js +0 -2
- package/src/metrics/alertDeliveriesSuppressed.js +0 -2
- package/src/metrics/alertsAcknowledgedTotal.js +0 -2
- package/src/metrics/alertsActive.js +0 -2
- package/src/metrics/alertsEscalatedTotal.js +0 -2
- package/src/metrics/alertsFiredTotal.js +0 -2
- package/src/metrics/alertsReopenedTotal.js +0 -2
- package/src/metrics/alertsResolvedTotal.js +0 -2
- package/src/metrics/alertsSilencedTotal.js +0 -2
- package/src/metrics/approvalPending.js +0 -2
- package/src/metrics/approvalWaitDuration.js +0 -5
- package/src/metrics/approvalsDenied.js +0 -2
- package/src/metrics/approvalsGranted.js +0 -2
- package/src/metrics/approvalsRequested.js +0 -2
- package/src/metrics/attemptDuration.js +0 -3
- package/src/metrics/attentionBacklog.js +0 -2
- package/src/metrics/cacheHits.js +0 -2
- package/src/metrics/cacheMisses.js +0 -2
- package/src/metrics/dbQueryDuration.js +0 -3
- package/src/metrics/dbRetries.js +0 -2
- package/src/metrics/dbTransactionDuration.js +0 -3
- package/src/metrics/dbTransactionRetries.js +0 -2
- package/src/metrics/dbTransactionRollbacks.js +0 -2
- package/src/metrics/devtoolsActiveSubscribers.js +0 -2
- package/src/metrics/devtoolsBackpressureDisconnectTotal.js +0 -2
- package/src/metrics/devtoolsDeltaBuildMs.js +0 -3
- package/src/metrics/devtoolsEventBytes.js +0 -3
- package/src/metrics/devtoolsEventTotal.js +0 -2
- package/src/metrics/devtoolsSnapshotBuildMs.js +0 -5
- package/src/metrics/devtoolsSubscribeTotal.js +0 -2
- package/src/metrics/errorsTotal.js +0 -2
- package/src/metrics/eventsEmittedTotal.js +0 -2
- package/src/metrics/externalWaitAsyncPending.js +0 -2
- package/src/metrics/gatewayApprovalDecisionsTotal.js +0 -2
- package/src/metrics/gatewayAuthEventsTotal.js +0 -2
- package/src/metrics/gatewayConnectionsActive.js +0 -2
- package/src/metrics/gatewayConnectionsClosedTotal.js +0 -2
- package/src/metrics/gatewayConnectionsTotal.js +0 -2
- package/src/metrics/gatewayCronTriggersTotal.js +0 -2
- package/src/metrics/gatewayErrorsTotal.js +0 -2
- package/src/metrics/gatewayHeartbeatTicksTotal.js +0 -2
- package/src/metrics/gatewayMessagesReceivedTotal.js +0 -2
- package/src/metrics/gatewayMessagesSentTotal.js +0 -2
- package/src/metrics/gatewayRpcCallsTotal.js +0 -2
- package/src/metrics/gatewayRpcDuration.js +0 -3
- package/src/metrics/gatewayRunEventBackpressureDisconnectTotal.js +0 -4
- package/src/metrics/gatewayRunsCompletedTotal.js +0 -2
- package/src/metrics/gatewayRunsStartedTotal.js +0 -2
- package/src/metrics/gatewaySignalsTotal.js +0 -2
- package/src/metrics/gatewayWebhooksReceivedTotal.js +0 -2
- package/src/metrics/gatewayWebhooksRejectedTotal.js +0 -2
- package/src/metrics/gatewayWebhooksVerifiedTotal.js +0 -2
- package/src/metrics/heartbeatDataSizeBytes.js +0 -5
- package/src/metrics/heartbeatIntervalMs.js +0 -3
- package/src/metrics/hotReloadDuration.js +0 -3
- package/src/metrics/hotReloadFailures.js +0 -2
- package/src/metrics/hotReloads.js +0 -2
- package/src/metrics/httpRequestDuration.js +0 -3
- package/src/metrics/httpRequests.js +0 -2
- package/src/metrics/index.d.ts +0 -1222
- package/src/metrics/index.js +0 -168
- package/src/metrics/memoryFactReads.js +0 -3
- package/src/metrics/memoryFactWrites.js +0 -3
- package/src/metrics/memoryMessageSaves.js +0 -3
- package/src/metrics/memoryRecallDuration.js +0 -11
- package/src/metrics/memoryRecallQueries.js +0 -3
- package/src/metrics/metricsServiceAdapter.js +0 -181
- package/src/metrics/nodeDuration.js +0 -3
- package/src/metrics/nodeRetriesTotal.js +0 -2
- package/src/metrics/nodesFailed.js +0 -2
- package/src/metrics/nodesFinished.js +0 -2
- package/src/metrics/nodesStarted.js +0 -2
- package/src/metrics/openApiToolCallErrorsTotal.js +0 -3
- package/src/metrics/openApiToolCallsTotal.js +0 -3
- package/src/metrics/openApiToolDuration.js +0 -9
- package/src/metrics/processHeapUsedBytes.js +0 -2
- package/src/metrics/processMemoryRssBytes.js +0 -2
- package/src/metrics/processUptimeSeconds.js +0 -2
- package/src/metrics/promptSizeBytes.js +0 -3
- package/src/metrics/replaysStarted.js +0 -3
- package/src/metrics/responseSizeBytes.js +0 -3
- package/src/metrics/rewindDurationMs.js +0 -3
- package/src/metrics/rewindFramesDeleted.js +0 -3
- package/src/metrics/rewindRollbackTotal.js +0 -2
- package/src/metrics/rewindSandboxesReverted.js +0 -3
- package/src/metrics/rewindTotal.js +0 -2
- package/src/metrics/runDuration.js +0 -3
- package/src/metrics/runForksCreated.js +0 -3
- package/src/metrics/runsAncestryDepth.js +0 -3
- package/src/metrics/runsCancelledTotal.js +0 -2
- package/src/metrics/runsCarriedStateBytes.js +0 -5
- package/src/metrics/runsContinuedTotal.js +0 -2
- package/src/metrics/runsFailedTotal.js +0 -2
- package/src/metrics/runsFinishedTotal.js +0 -2
- package/src/metrics/runsResumedTotal.js +0 -2
- package/src/metrics/runsTotal.js +0 -2
- package/src/metrics/sandboxActive.js +0 -2
- package/src/metrics/sandboxBundleSizeBytes.js +0 -5
- package/src/metrics/sandboxCompletedTotal.js +0 -2
- package/src/metrics/sandboxCreatedTotal.js +0 -2
- package/src/metrics/sandboxDurationMs.js +0 -3
- package/src/metrics/sandboxPatchCount.js +0 -3
- package/src/metrics/sandboxTransportDurationMs.js +0 -5
- package/src/metrics/schedulerConcurrencyUtilization.js +0 -2
- package/src/metrics/schedulerQueueDepth.js +0 -2
- package/src/metrics/schedulerWaitDuration.js +0 -5
- package/src/metrics/scorerDuration.js +0 -9
- package/src/metrics/scorerEventsFailed.js +0 -2
- package/src/metrics/scorerEventsFinished.js +0 -2
- package/src/metrics/scorerEventsStarted.js +0 -2
- package/src/metrics/scorersFailed.js +0 -3
- package/src/metrics/scorersFinished.js +0 -3
- package/src/metrics/scorersStarted.js +0 -3
- package/src/metrics/smithersMetricCatalog.js +0 -893
- package/src/metrics/smithersMetricCatalogByKey.js +0 -2
- package/src/metrics/smithersMetricCatalogByName.js +0 -2
- package/src/metrics/smithersMetricCatalogByPrometheusName.js +0 -4
- package/src/metrics/snapshotDuration.js +0 -9
- package/src/metrics/snapshotsCaptured.js +0 -3
- package/src/metrics/supervisorPollDuration.js +0 -5
- package/src/metrics/supervisorPollsTotal.js +0 -2
- package/src/metrics/supervisorResumeLag.js +0 -5
- package/src/metrics/supervisorResumedTotal.js +0 -2
- package/src/metrics/supervisorSkippedTotal.js +0 -2
- package/src/metrics/supervisorStaleDetected.js +0 -2
- package/src/metrics/taskHeartbeatTimeoutTotal.js +0 -2
- package/src/metrics/taskHeartbeatsTotal.js +0 -2
- package/src/metrics/timerDelayDuration.js +0 -3
- package/src/metrics/timersCancelled.js +0 -2
- package/src/metrics/timersCreated.js +0 -2
- package/src/metrics/timersFired.js +0 -2
- package/src/metrics/timersPending.js +0 -2
- package/src/metrics/toPrometheusMetricName.js +0 -8
- package/src/metrics/tokensCacheReadTotal.js +0 -2
- package/src/metrics/tokensCacheWriteTotal.js +0 -2
- package/src/metrics/tokensContextWindowBucketTotal.js +0 -2
- package/src/metrics/tokensContextWindowPerCall.js +0 -5
- package/src/metrics/tokensInputPerCall.js +0 -3
- package/src/metrics/tokensInputTotal.js +0 -2
- package/src/metrics/tokensOutputPerCall.js +0 -3
- package/src/metrics/tokensOutputTotal.js +0 -2
- package/src/metrics/tokensReasoningTotal.js +0 -2
- package/src/metrics/toolCallErrorsTotal.js +0 -2
- package/src/metrics/toolCallsTotal.js +0 -2
- package/src/metrics/toolDuration.js +0 -3
- package/src/metrics/toolOutputTruncatedTotal.js +0 -2
- package/src/metrics/trackEvent.js +0 -608
- package/src/metrics/updateAsyncExternalWaitPending.js +0 -18
- package/src/metrics/updateProcessMetrics.js +0 -20
- package/src/metrics/vcsDuration.js +0 -3
- package/src/normalizeStructuredEvent.js +0 -15
- package/src/prometheusContentType.js +0 -1
- package/src/renderPrometheusMetrics.js +0 -212
- package/src/resolveAgentTraceCapabilities.js +0 -59
- package/src/resolveSmithersObservabilityOptions.js +0 -109
- package/src/smithersMetrics.js +0 -2
- package/src/smithersSpanNames.js +0 -6
- package/src/unsupportedKindsForCapabilities.js +0 -32
- package/src/withSmithersSpan.js +0 -17
- package/tempo/tempo.yml +0 -17
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Effect metric registry for flows runtime signals.
|
|
3
|
+
*
|
|
4
|
+
* @since 0.1.0
|
|
5
|
+
*/
|
|
6
|
+
import * as Metric from "effect/Metric";
|
|
7
|
+
/**
|
|
8
|
+
* Counts flow runs that reached a terminal state.
|
|
9
|
+
*
|
|
10
|
+
* @category metrics
|
|
11
|
+
* @since 0.1.0
|
|
12
|
+
*/
|
|
13
|
+
export declare const runThroughput: Metric.Counter<number>;
|
|
14
|
+
/**
|
|
15
|
+
* The number of execution seats currently held.
|
|
16
|
+
*
|
|
17
|
+
* @category metrics
|
|
18
|
+
* @since 0.1.0
|
|
19
|
+
*/
|
|
20
|
+
export declare const activeSeats: Metric.Gauge<number>;
|
|
21
|
+
/**
|
|
22
|
+
* Counts runs parked because a quota was exhausted.
|
|
23
|
+
*
|
|
24
|
+
* @category metrics
|
|
25
|
+
* @since 0.1.0
|
|
26
|
+
*/
|
|
27
|
+
export declare const quotaParks: Metric.Counter<number>;
|
|
28
|
+
/**
|
|
29
|
+
* Counts agent answers refused by their declared output schema.
|
|
30
|
+
*
|
|
31
|
+
* @category metrics
|
|
32
|
+
* @since 1.0.0-rc.1
|
|
33
|
+
*/
|
|
34
|
+
export declare const structuredOutputRejections: Metric.Counter<number>;
|
|
35
|
+
/**
|
|
36
|
+
* Counts agent steps that failed after spending every output correction.
|
|
37
|
+
*
|
|
38
|
+
* @category metrics
|
|
39
|
+
* @since 1.0.0-rc.1
|
|
40
|
+
*/
|
|
41
|
+
export declare const structuredOutputExhausted: Metric.Counter<number>;
|
|
42
|
+
/**
|
|
43
|
+
* Counts operational log records lost before durable delivery.
|
|
44
|
+
*
|
|
45
|
+
* Advances once per record dropped by a saturated forwarding queue, once per
|
|
46
|
+
* journal delivery failure, and once per defect the forwarding worker recovers
|
|
47
|
+
* from, so telemetry loss is distinguishable from an idle logger.
|
|
48
|
+
*
|
|
49
|
+
* @category metrics
|
|
50
|
+
* @since 1.0.0-rc.0
|
|
51
|
+
*/
|
|
52
|
+
export declare const droppedLogRecords: Metric.Counter<number>;
|
|
53
|
+
/**
|
|
54
|
+
* All metrics declared by this package.
|
|
55
|
+
*
|
|
56
|
+
* @category registry
|
|
57
|
+
* @since 0.1.0
|
|
58
|
+
*/
|
|
59
|
+
export declare const registry: {
|
|
60
|
+
readonly runThroughput: Metric.Counter<number>;
|
|
61
|
+
readonly activeSeats: Metric.Gauge<number>;
|
|
62
|
+
readonly quotaParks: Metric.Counter<number>;
|
|
63
|
+
readonly structuredOutputRejections: Metric.Counter<number>;
|
|
64
|
+
readonly structuredOutputExhausted: Metric.Counter<number>;
|
|
65
|
+
readonly droppedLogRecords: Metric.Counter<number>;
|
|
66
|
+
};
|
|
67
|
+
//# sourceMappingURL=Metric.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Metric.d.ts","sourceRoot":"","sources":["../../src/Metric.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAIvC;;;;;GAKG;AACH,eAAO,MAAM,aAAa,wBAExB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,sBAEtB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,UAAU,wBAErB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,wBAErC,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,wBAEpC,CAAA;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,wBAE5B,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;;;;;;;CAOX,CAAA"}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
var Metric_exports = {};
|
|
30
|
+
__export(Metric_exports, {
|
|
31
|
+
activeSeats: () => activeSeats,
|
|
32
|
+
droppedLogRecords: () => droppedLogRecords,
|
|
33
|
+
quotaParks: () => quotaParks,
|
|
34
|
+
registry: () => registry,
|
|
35
|
+
runThroughput: () => runThroughput,
|
|
36
|
+
structuredOutputExhausted: () => structuredOutputExhausted,
|
|
37
|
+
structuredOutputRejections: () => structuredOutputRejections
|
|
38
|
+
});
|
|
39
|
+
module.exports = __toCommonJS(Metric_exports);
|
|
40
|
+
var Metric = __toESM(require("effect/Metric"), 1);
|
|
41
|
+
const prefix = "flows_";
|
|
42
|
+
const runThroughput = Metric.counter(`${prefix}run_throughput`, {
|
|
43
|
+
description: "Completed flow runs"
|
|
44
|
+
});
|
|
45
|
+
const activeSeats = Metric.gauge(`${prefix}seat_active`, {
|
|
46
|
+
description: "Currently active execution seats"
|
|
47
|
+
});
|
|
48
|
+
const quotaParks = Metric.counter(`${prefix}quota_park`, {
|
|
49
|
+
description: "Runs parked by quota enforcement"
|
|
50
|
+
});
|
|
51
|
+
const structuredOutputRejections = Metric.counter(`${prefix}agent_structured_output_rejections`, {
|
|
52
|
+
description: "Agent answers refused by their declared output schema"
|
|
53
|
+
});
|
|
54
|
+
const structuredOutputExhausted = Metric.counter(`${prefix}agent_structured_output_exhausted`, {
|
|
55
|
+
description: "Agent steps whose output corrections were exhausted"
|
|
56
|
+
});
|
|
57
|
+
const droppedLogRecords = Metric.counter(`${prefix}observability_log_dropped`, {
|
|
58
|
+
description: "Operational log records dropped before durable delivery"
|
|
59
|
+
});
|
|
60
|
+
const registry = {
|
|
61
|
+
runThroughput,
|
|
62
|
+
activeSeats,
|
|
63
|
+
quotaParks,
|
|
64
|
+
structuredOutputRejections,
|
|
65
|
+
structuredOutputExhausted,
|
|
66
|
+
droppedLogRecords
|
|
67
|
+
};
|
|
68
|
+
//# sourceMappingURL=Metric.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/Metric.ts"],
|
|
4
|
+
"sourcesContent": ["/**\n * Effect metric registry for flows runtime signals.\n *\n * @since 0.1.0\n */\n\nimport * as Metric from \"effect/Metric\"\n\nconst prefix = \"flows_\"\n\n/**\n * Counts flow runs that reached a terminal state.\n *\n * @category metrics\n * @since 0.1.0\n */\nexport const runThroughput = Metric.counter(`${prefix}run_throughput`, {\n description: \"Completed flow runs\"\n})\n\n/**\n * The number of execution seats currently held.\n *\n * @category metrics\n * @since 0.1.0\n */\nexport const activeSeats = Metric.gauge(`${prefix}seat_active`, {\n description: \"Currently active execution seats\"\n})\n\n/**\n * Counts runs parked because a quota was exhausted.\n *\n * @category metrics\n * @since 0.1.0\n */\nexport const quotaParks = Metric.counter(`${prefix}quota_park`, {\n description: \"Runs parked by quota enforcement\"\n})\n\n/**\n * Counts agent answers refused by their declared output schema.\n *\n * @category metrics\n * @since 1.0.0-rc.1\n */\nexport const structuredOutputRejections = Metric.counter(`${prefix}agent_structured_output_rejections`, {\n description: \"Agent answers refused by their declared output schema\"\n})\n\n/**\n * Counts agent steps that failed after spending every output correction.\n *\n * @category metrics\n * @since 1.0.0-rc.1\n */\nexport const structuredOutputExhausted = Metric.counter(`${prefix}agent_structured_output_exhausted`, {\n description: \"Agent steps whose output corrections were exhausted\"\n})\n\n/**\n * Counts operational log records lost before durable delivery.\n *\n * Advances once per record dropped by a saturated forwarding queue, once per\n * journal delivery failure, and once per defect the forwarding worker recovers\n * from, so telemetry loss is distinguishable from an idle logger.\n *\n * @category metrics\n * @since 1.0.0-rc.0\n */\nexport const droppedLogRecords = Metric.counter(`${prefix}observability_log_dropped`, {\n description: \"Operational log records dropped before durable delivery\"\n})\n\n/**\n * All metrics declared by this package.\n *\n * @category registry\n * @since 0.1.0\n */\nexport const registry = {\n runThroughput,\n activeSeats,\n quotaParks,\n structuredOutputRejections,\n structuredOutputExhausted,\n droppedLogRecords\n} as const\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,aAAwB;AAExB,MAAM,SAAS;AAQR,MAAM,gBAAgB,OAAO,QAAQ,GAAG,MAAM,kBAAkB;AAAA,EACrE,aAAa;AACf,CAAC;AAQM,MAAM,cAAc,OAAO,MAAM,GAAG,MAAM,eAAe;AAAA,EAC9D,aAAa;AACf,CAAC;AAQM,MAAM,aAAa,OAAO,QAAQ,GAAG,MAAM,cAAc;AAAA,EAC9D,aAAa;AACf,CAAC;AAQM,MAAM,6BAA6B,OAAO,QAAQ,GAAG,MAAM,sCAAsC;AAAA,EACtG,aAAa;AACf,CAAC;AAQM,MAAM,4BAA4B,OAAO,QAAQ,GAAG,MAAM,qCAAqC;AAAA,EACpG,aAAa;AACf,CAAC;AAYM,MAAM,oBAAoB,OAAO,QAAQ,GAAG,MAAM,6BAA6B;AAAA,EACpF,aAAa;AACf,CAAC;AAQM,MAAM,WAAW;AAAA,EACtB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Node-only OTLP/HTTP OpenTelemetry setup.
|
|
3
|
+
*
|
|
4
|
+
* @since 0.1.0
|
|
5
|
+
*/
|
|
6
|
+
import type * as Duration from "effect/Duration";
|
|
7
|
+
import * as Layer from "effect/Layer";
|
|
8
|
+
import * as Endpoint from "./Endpoint.ts";
|
|
9
|
+
import * as Resource from "./Resource.ts";
|
|
10
|
+
import type { Configuration as ResourceConfiguration } from "./Resource.ts";
|
|
11
|
+
/**
|
|
12
|
+
* Node OTLP/HTTP layer options.
|
|
13
|
+
*
|
|
14
|
+
* @category models
|
|
15
|
+
* @since 0.1.0
|
|
16
|
+
*/
|
|
17
|
+
export interface Options {
|
|
18
|
+
/**
|
|
19
|
+
* The collector base URL. It must be an absolute `http:` or `https:` URL
|
|
20
|
+
* without credentials and free of spaces and control characters; anything
|
|
21
|
+
* else fails layer acquisition with
|
|
22
|
+
* {@link Endpoint.InvalidExporterEndpoint}.
|
|
23
|
+
*/
|
|
24
|
+
readonly endpoint: string;
|
|
25
|
+
readonly resource: ResourceConfiguration;
|
|
26
|
+
readonly shutdownTimeout?: Duration.Input | undefined;
|
|
27
|
+
readonly exportIntervalMillis?: number | undefined;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Builds a scoped Node OTLP/HTTP layer for all three telemetry signals.
|
|
31
|
+
* Exporter objects are created only when this layer is built.
|
|
32
|
+
* Resource metadata is explicit: ambient OTEL resource configuration cannot
|
|
33
|
+
* enlarge it after validation. The OpenTelemetry exporters still read the
|
|
34
|
+
* standard `OTEL_EXPORTER_OTLP_*` transport variables (headers, timeout,
|
|
35
|
+
* compression, TLS files) from the process environment and send them to the
|
|
36
|
+
* explicit endpoint, which always wins over `OTEL_EXPORTER_OTLP_ENDPOINT`.
|
|
37
|
+
*
|
|
38
|
+
* @category layers
|
|
39
|
+
* @since 0.1.0
|
|
40
|
+
*/
|
|
41
|
+
export declare const layerOtel: (options: Options) => Layer.Layer<never, Resource.InvalidResourceConfiguration | Endpoint.InvalidExporterEndpoint>;
|
|
42
|
+
//# sourceMappingURL=NodeOtel.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"NodeOtel.d.ts","sourceRoot":"","sources":["../../src/NodeOtel.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAUH,OAAO,KAAK,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAEhD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AACzC,OAAO,KAAK,EAAE,aAAa,IAAI,qBAAqB,EAAE,MAAM,eAAe,CAAA;AAE3E;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAA;IACxC,QAAQ,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAA;IACrD,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACnD;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,GACpB,SAAS,OAAO,KACf,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,4BAA4B,GAAG,QAAQ,CAAC,uBAAuB,CAmC3F,CAAA"}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
var NodeOtel_exports = {};
|
|
30
|
+
__export(NodeOtel_exports, {
|
|
31
|
+
layerOtel: () => layerOtel
|
|
32
|
+
});
|
|
33
|
+
module.exports = __toCommonJS(NodeOtel_exports);
|
|
34
|
+
var NodeSdk = __toESM(require("@effect/opentelemetry/NodeSdk"), 1);
|
|
35
|
+
var import_exporter_logs_otlp_http = require("@opentelemetry/exporter-logs-otlp-http");
|
|
36
|
+
var import_exporter_metrics_otlp_http = require("@opentelemetry/exporter-metrics-otlp-http");
|
|
37
|
+
var import_exporter_trace_otlp_http = require("@opentelemetry/exporter-trace-otlp-http");
|
|
38
|
+
var import_sdk_logs = require("@opentelemetry/sdk-logs");
|
|
39
|
+
var import_sdk_metrics = require("@opentelemetry/sdk-metrics");
|
|
40
|
+
var import_sdk_trace_base = require("@opentelemetry/sdk-trace-base");
|
|
41
|
+
var ConfigProvider = __toESM(require("effect/ConfigProvider"), 1);
|
|
42
|
+
var Effect = __toESM(require("effect/Effect"), 1);
|
|
43
|
+
var Layer = __toESM(require("effect/Layer"), 1);
|
|
44
|
+
var Endpoint = __toESM(require("./Endpoint.js"), 1);
|
|
45
|
+
var Resource = __toESM(require("./Resource.js"), 1);
|
|
46
|
+
const layerOtel = (options) => Layer.unwrap(
|
|
47
|
+
Effect.map(
|
|
48
|
+
Effect.all([Resource.decode(options.resource), Endpoint.decode(options.endpoint, "endpoint")]),
|
|
49
|
+
([decoded, endpoint]) => NodeSdk.layer(() => {
|
|
50
|
+
const resource = Resource.toOpenTelemetryConfiguration(decoded);
|
|
51
|
+
const spanProcessor = new import_sdk_trace_base.BatchSpanProcessor(
|
|
52
|
+
new import_exporter_trace_otlp_http.OTLPTraceExporter({ url: Endpoint.signalUrl(endpoint, "traces") })
|
|
53
|
+
);
|
|
54
|
+
const logRecordProcessor = new import_sdk_logs.BatchLogRecordProcessor({
|
|
55
|
+
exporter: new import_exporter_logs_otlp_http.OTLPLogExporter({ url: Endpoint.signalUrl(endpoint, "logs") })
|
|
56
|
+
});
|
|
57
|
+
const metricReader = options.exportIntervalMillis === void 0 ? new import_sdk_metrics.PeriodicExportingMetricReader({
|
|
58
|
+
exporter: new import_exporter_metrics_otlp_http.OTLPMetricExporter({ url: Endpoint.signalUrl(endpoint, "metrics") })
|
|
59
|
+
}) : new import_sdk_metrics.PeriodicExportingMetricReader({
|
|
60
|
+
exporter: new import_exporter_metrics_otlp_http.OTLPMetricExporter({ url: Endpoint.signalUrl(endpoint, "metrics") }),
|
|
61
|
+
exportIntervalMillis: options.exportIntervalMillis
|
|
62
|
+
});
|
|
63
|
+
return {
|
|
64
|
+
resource,
|
|
65
|
+
spanProcessor,
|
|
66
|
+
logRecordProcessor,
|
|
67
|
+
metricReader,
|
|
68
|
+
shutdownTimeout: options.shutdownTimeout
|
|
69
|
+
};
|
|
70
|
+
}).pipe(
|
|
71
|
+
// NodeSdk merges Resource.layerFromEnv after our admission check.
|
|
72
|
+
// Isolate that lookup so only the validated explicit resource and
|
|
73
|
+
// the SDK metadata already included in its budget reach exporters.
|
|
74
|
+
Layer.provide(ConfigProvider.layer(ConfigProvider.fromUnknown({})))
|
|
75
|
+
)
|
|
76
|
+
)
|
|
77
|
+
);
|
|
78
|
+
//# sourceMappingURL=NodeOtel.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/NodeOtel.ts"],
|
|
4
|
+
"sourcesContent": ["/**\n * Node-only OTLP/HTTP OpenTelemetry setup.\n *\n * @since 0.1.0\n */\n\nimport * as NodeSdk from \"@effect/opentelemetry/NodeSdk\"\nimport { OTLPLogExporter } from \"@opentelemetry/exporter-logs-otlp-http\"\nimport { OTLPMetricExporter } from \"@opentelemetry/exporter-metrics-otlp-http\"\nimport { OTLPTraceExporter } from \"@opentelemetry/exporter-trace-otlp-http\"\nimport { BatchLogRecordProcessor } from \"@opentelemetry/sdk-logs\"\nimport { PeriodicExportingMetricReader } from \"@opentelemetry/sdk-metrics\"\nimport { BatchSpanProcessor } from \"@opentelemetry/sdk-trace-base\"\nimport * as ConfigProvider from \"effect/ConfigProvider\"\nimport type * as Duration from \"effect/Duration\"\nimport * as Effect from \"effect/Effect\"\nimport * as Layer from \"effect/Layer\"\nimport * as Endpoint from \"./Endpoint.ts\"\nimport * as Resource from \"./Resource.ts\"\nimport type { Configuration as ResourceConfiguration } from \"./Resource.ts\"\n\n/**\n * Node OTLP/HTTP layer options.\n *\n * @category models\n * @since 0.1.0\n */\nexport interface Options {\n /**\n * The collector base URL. It must be an absolute `http:` or `https:` URL\n * without credentials and free of spaces and control characters; anything\n * else fails layer acquisition with\n * {@link Endpoint.InvalidExporterEndpoint}.\n */\n readonly endpoint: string\n readonly resource: ResourceConfiguration\n readonly shutdownTimeout?: Duration.Input | undefined\n readonly exportIntervalMillis?: number | undefined\n}\n\n/**\n * Builds a scoped Node OTLP/HTTP layer for all three telemetry signals.\n * Exporter objects are created only when this layer is built.\n * Resource metadata is explicit: ambient OTEL resource configuration cannot\n * enlarge it after validation. The OpenTelemetry exporters still read the\n * standard `OTEL_EXPORTER_OTLP_*` transport variables (headers, timeout,\n * compression, TLS files) from the process environment and send them to the\n * explicit endpoint, which always wins over `OTEL_EXPORTER_OTLP_ENDPOINT`.\n *\n * @category layers\n * @since 0.1.0\n */\nexport const layerOtel = (\n options: Options\n): Layer.Layer<never, Resource.InvalidResourceConfiguration | Endpoint.InvalidExporterEndpoint> =>\n Layer.unwrap(\n Effect.map(\n Effect.all([Resource.decode(options.resource), Endpoint.decode(options.endpoint, \"endpoint\")]),\n ([decoded, endpoint]) =>\n NodeSdk.layer(() => {\n const resource = Resource.toOpenTelemetryConfiguration(decoded)\n const spanProcessor = new BatchSpanProcessor(\n new OTLPTraceExporter({ url: Endpoint.signalUrl(endpoint, \"traces\") })\n )\n const logRecordProcessor = new BatchLogRecordProcessor({\n exporter: new OTLPLogExporter({ url: Endpoint.signalUrl(endpoint, \"logs\") })\n })\n const metricReader = options.exportIntervalMillis === undefined\n ? new PeriodicExportingMetricReader({\n exporter: new OTLPMetricExporter({ url: Endpoint.signalUrl(endpoint, \"metrics\") })\n })\n : new PeriodicExportingMetricReader({\n exporter: new OTLPMetricExporter({ url: Endpoint.signalUrl(endpoint, \"metrics\") }),\n exportIntervalMillis: options.exportIntervalMillis\n })\n return {\n resource,\n spanProcessor,\n logRecordProcessor,\n metricReader,\n shutdownTimeout: options.shutdownTimeout\n }\n }).pipe(\n // NodeSdk merges Resource.layerFromEnv after our admission check.\n // Isolate that lookup so only the validated explicit resource and\n // the SDK metadata already included in its budget reach exporters.\n Layer.provide(ConfigProvider.layer(ConfigProvider.fromUnknown({})))\n )\n )\n )\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,cAAyB;AACzB,qCAAgC;AAChC,wCAAmC;AACnC,sCAAkC;AAClC,sBAAwC;AACxC,yBAA8C;AAC9C,4BAAmC;AACnC,qBAAgC;AAEhC,aAAwB;AACxB,YAAuB;AACvB,eAA0B;AAC1B,eAA0B;AAkCnB,MAAM,YAAY,CACvB,YAEA,MAAM;AAAA,EACJ,OAAO;AAAA,IACL,OAAO,IAAI,CAAC,SAAS,OAAO,QAAQ,QAAQ,GAAG,SAAS,OAAO,QAAQ,UAAU,UAAU,CAAC,CAAC;AAAA,IAC7F,CAAC,CAAC,SAAS,QAAQ,MACjB,QAAQ,MAAM,MAAM;AAClB,YAAM,WAAW,SAAS,6BAA6B,OAAO;AAC9D,YAAM,gBAAgB,IAAI;AAAA,QACxB,IAAI,kDAAkB,EAAE,KAAK,SAAS,UAAU,UAAU,QAAQ,EAAE,CAAC;AAAA,MACvE;AACA,YAAM,qBAAqB,IAAI,wCAAwB;AAAA,QACrD,UAAU,IAAI,+CAAgB,EAAE,KAAK,SAAS,UAAU,UAAU,MAAM,EAAE,CAAC;AAAA,MAC7E,CAAC;AACD,YAAM,eAAe,QAAQ,yBAAyB,SAClD,IAAI,iDAA8B;AAAA,QAClC,UAAU,IAAI,qDAAmB,EAAE,KAAK,SAAS,UAAU,UAAU,SAAS,EAAE,CAAC;AAAA,MACnF,CAAC,IACC,IAAI,iDAA8B;AAAA,QAClC,UAAU,IAAI,qDAAmB,EAAE,KAAK,SAAS,UAAU,UAAU,SAAS,EAAE,CAAC;AAAA,QACjF,sBAAsB,QAAQ;AAAA,MAChC,CAAC;AACH,aAAO;AAAA,QACL;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,iBAAiB,QAAQ;AAAA,MAC3B;AAAA,IACF,CAAC,EAAE;AAAA;AAAA;AAAA;AAAA,MAID,MAAM,QAAQ,eAAe,MAAM,eAAe,YAAY,CAAC,CAAC,CAAC,CAAC;AAAA,IACpE;AAAA,EACJ;AACF;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Provider-neutral composition for injected OpenTelemetry providers.
|
|
3
|
+
*
|
|
4
|
+
* @since 0.1.0
|
|
5
|
+
*/
|
|
6
|
+
import * as OtelMetrics from "@effect/opentelemetry/OtelMetrics";
|
|
7
|
+
import type * as Api from "@opentelemetry/api";
|
|
8
|
+
import type { LoggerProvider } from "@opentelemetry/sdk-logs";
|
|
9
|
+
import type { MetricReader } from "@opentelemetry/sdk-metrics";
|
|
10
|
+
import * as Layer from "effect/Layer";
|
|
11
|
+
import { type Configuration as ResourceConfiguration, type InvalidResourceConfiguration, Resource } from "./Resource.ts";
|
|
12
|
+
/**
|
|
13
|
+
* Injected providers used by the provider-neutral OTEL layer.
|
|
14
|
+
*
|
|
15
|
+
* @category models
|
|
16
|
+
* @since 0.1.0
|
|
17
|
+
*/
|
|
18
|
+
export interface Options {
|
|
19
|
+
/** Validated resource for metrics, tracer scope, and provider factories. */
|
|
20
|
+
readonly resource: ResourceConfiguration;
|
|
21
|
+
/**
|
|
22
|
+
* Borrowed: the layer bridges onto this provider and never flushes or shuts
|
|
23
|
+
* it down, including a provider a factory returns. Existing providers retain
|
|
24
|
+
* their resource. Factories must pass the supplied resource to the SDK.
|
|
25
|
+
*/
|
|
26
|
+
readonly tracerProvider?: Api.TracerProvider | ((resource: typeof Resource.Service) => Api.TracerProvider) | undefined;
|
|
27
|
+
/** Borrowed on the same terms as `tracerProvider`. */
|
|
28
|
+
readonly loggerProvider?: LoggerProvider | ((resource: typeof Resource.Service) => LoggerProvider) | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* Owned: the factory runs once during layer acquisition, after resource
|
|
31
|
+
* validation, and every reader it returns is shut down when the scope
|
|
32
|
+
* closes. Build the readers inside the factory rather than returning one a
|
|
33
|
+
* longer-lived composition still exports through, which that shutdown would
|
|
34
|
+
* disable. An empty array registers no reader at all.
|
|
35
|
+
*/
|
|
36
|
+
readonly metricReader?: (() => MetricReader | ReadonlyArray<MetricReader>) | undefined;
|
|
37
|
+
readonly loggerMergeWithExisting?: boolean | undefined;
|
|
38
|
+
readonly metricTemporality?: OtelMetrics.TemporalityPreference | undefined;
|
|
39
|
+
}
|
|
40
|
+
/**
|
|
41
|
+
* Composes Effect tracer, logger, and metric bridges from already-created
|
|
42
|
+
* OpenTelemetry providers or provider factories, and from metric readers this
|
|
43
|
+
* layer acquires. Factories run during layer acquisition after resource
|
|
44
|
+
* validation, and the provider factories receive the metric resource.
|
|
45
|
+
* Already-created providers keep the resource captured at construction; the
|
|
46
|
+
* resource option only sets metrics and tracer instrumentation scope for them.
|
|
47
|
+
* Ownership splits: callers own provider flushing and shutdown, including
|
|
48
|
+
* factory-built providers, while the layer scope shuts down every reader the
|
|
49
|
+
* `metricReader` factory returned. No exporter is allocated by this module.
|
|
50
|
+
*
|
|
51
|
+
* @category layers
|
|
52
|
+
* @since 0.1.0
|
|
53
|
+
*/
|
|
54
|
+
export declare const layerOtel: (options: Options) => Layer.Layer<never, InvalidResourceConfiguration>;
|
|
55
|
+
/**
|
|
56
|
+
* A no-op OTEL layer for callers that want an explicit optional slot.
|
|
57
|
+
*
|
|
58
|
+
* @category layers
|
|
59
|
+
* @since 0.1.0
|
|
60
|
+
*/
|
|
61
|
+
export declare const layerNoop: Layer.Layer<never>;
|
|
62
|
+
//# sourceMappingURL=Otel.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"Otel.d.ts","sourceRoot":"","sources":["../../src/Otel.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,WAAW,MAAM,mCAAmC,CAAA;AAEhE,OAAO,KAAK,KAAK,GAAG,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AAE9D,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,EACL,KAAK,aAAa,IAAI,qBAAqB,EAC3C,KAAK,4BAA4B,EAEjC,QAAQ,EACT,MAAM,eAAe,CAAA;AAEtB;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB,4EAA4E;IAC5E,QAAQ,CAAC,QAAQ,EAAE,qBAAqB,CAAA;IACxC;;;;OAIG;IACH,QAAQ,CAAC,cAAc,CAAC,EACpB,GAAG,CAAC,cAAc,GAClB,CAAC,CAAC,QAAQ,EAAE,OAAO,QAAQ,CAAC,OAAO,KAAK,GAAG,CAAC,cAAc,CAAC,GAC3D,SAAS,CAAA;IACb,sDAAsD;IACtD,QAAQ,CAAC,cAAc,CAAC,EACpB,cAAc,GACd,CAAC,CAAC,QAAQ,EAAE,OAAO,QAAQ,CAAC,OAAO,KAAK,cAAc,CAAC,GACvD,SAAS,CAAA;IACb;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC,MAAM,YAAY,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC,GAAG,SAAS,CAAA;IACtF,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,WAAW,CAAC,qBAAqB,GAAG,SAAS,CAAA;CAC3E;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,SAAS,GAAI,SAAS,OAAO,KAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,4BAA4B,CAsC3F,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAe,CAAA"}
|
package/dist/cjs/Otel.js
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
var Otel_exports = {};
|
|
30
|
+
__export(Otel_exports, {
|
|
31
|
+
layerNoop: () => layerNoop,
|
|
32
|
+
layerOtel: () => layerOtel
|
|
33
|
+
});
|
|
34
|
+
module.exports = __toCommonJS(Otel_exports);
|
|
35
|
+
var OtelLogger = __toESM(require("@effect/opentelemetry/OtelLogger"), 1);
|
|
36
|
+
var OtelMetrics = __toESM(require("@effect/opentelemetry/OtelMetrics"), 1);
|
|
37
|
+
var OtelTracer = __toESM(require("@effect/opentelemetry/OtelTracer"), 1);
|
|
38
|
+
var Effect = __toESM(require("effect/Effect"), 1);
|
|
39
|
+
var Layer = __toESM(require("effect/Layer"), 1);
|
|
40
|
+
var import_Resource = require("./Resource.js");
|
|
41
|
+
const layerOtel = (options) => {
|
|
42
|
+
const resource = (0, import_Resource.layer)(options.resource);
|
|
43
|
+
const tracerProvider = options.tracerProvider;
|
|
44
|
+
const loggerProvider = options.loggerProvider;
|
|
45
|
+
const tracer = tracerProvider === void 0 ? Layer.empty : Layer.provide(
|
|
46
|
+
OtelTracer.layer,
|
|
47
|
+
Layer.effect(
|
|
48
|
+
OtelTracer.OtelTracerProvider,
|
|
49
|
+
Effect.map(
|
|
50
|
+
import_Resource.Resource,
|
|
51
|
+
(resource2) => typeof tracerProvider === "function" ? tracerProvider(resource2) : tracerProvider
|
|
52
|
+
)
|
|
53
|
+
)
|
|
54
|
+
);
|
|
55
|
+
const logger = loggerProvider === void 0 ? Layer.empty : Layer.provide(
|
|
56
|
+
OtelLogger.layer({ mergeWithExisting: options.loggerMergeWithExisting }),
|
|
57
|
+
Layer.effect(
|
|
58
|
+
OtelLogger.OtelLoggerProvider,
|
|
59
|
+
Effect.map(
|
|
60
|
+
import_Resource.Resource,
|
|
61
|
+
(resource2) => typeof loggerProvider === "function" ? loggerProvider(resource2) : loggerProvider
|
|
62
|
+
)
|
|
63
|
+
)
|
|
64
|
+
);
|
|
65
|
+
const acquireMetricReader = options.metricReader;
|
|
66
|
+
const metrics = acquireMetricReader === void 0 ? Layer.empty : OtelMetrics.layer(
|
|
67
|
+
() => acquireMetricReader(),
|
|
68
|
+
{
|
|
69
|
+
temporality: options.metricTemporality
|
|
70
|
+
}
|
|
71
|
+
);
|
|
72
|
+
return Layer.mergeAll(tracer, logger, metrics).pipe(Layer.provideMerge(resource));
|
|
73
|
+
};
|
|
74
|
+
const layerNoop = Layer.empty;
|
|
75
|
+
//# sourceMappingURL=Otel.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../../src/Otel.ts"],
|
|
4
|
+
"sourcesContent": ["/**\n * Provider-neutral composition for injected OpenTelemetry providers.\n *\n * @since 0.1.0\n */\n\nimport * as OtelLogger from \"@effect/opentelemetry/OtelLogger\"\nimport * as OtelMetrics from \"@effect/opentelemetry/OtelMetrics\"\nimport * as OtelTracer from \"@effect/opentelemetry/OtelTracer\"\nimport type * as Api from \"@opentelemetry/api\"\nimport type { LoggerProvider } from \"@opentelemetry/sdk-logs\"\nimport type { MetricReader } from \"@opentelemetry/sdk-metrics\"\nimport * as Effect from \"effect/Effect\"\nimport * as Layer from \"effect/Layer\"\nimport {\n type Configuration as ResourceConfiguration,\n type InvalidResourceConfiguration,\n layer as resourceLayer,\n Resource\n} from \"./Resource.ts\"\n\n/**\n * Injected providers used by the provider-neutral OTEL layer.\n *\n * @category models\n * @since 0.1.0\n */\nexport interface Options {\n /** Validated resource for metrics, tracer scope, and provider factories. */\n readonly resource: ResourceConfiguration\n /**\n * Borrowed: the layer bridges onto this provider and never flushes or shuts\n * it down, including a provider a factory returns. Existing providers retain\n * their resource. Factories must pass the supplied resource to the SDK.\n */\n readonly tracerProvider?:\n | Api.TracerProvider\n | ((resource: typeof Resource.Service) => Api.TracerProvider)\n | undefined\n /** Borrowed on the same terms as `tracerProvider`. */\n readonly loggerProvider?:\n | LoggerProvider\n | ((resource: typeof Resource.Service) => LoggerProvider)\n | undefined\n /**\n * Owned: the factory runs once during layer acquisition, after resource\n * validation, and every reader it returns is shut down when the scope\n * closes. Build the readers inside the factory rather than returning one a\n * longer-lived composition still exports through, which that shutdown would\n * disable. An empty array registers no reader at all.\n */\n readonly metricReader?: (() => MetricReader | ReadonlyArray<MetricReader>) | undefined\n readonly loggerMergeWithExisting?: boolean | undefined\n readonly metricTemporality?: OtelMetrics.TemporalityPreference | undefined\n}\n\n/**\n * Composes Effect tracer, logger, and metric bridges from already-created\n * OpenTelemetry providers or provider factories, and from metric readers this\n * layer acquires. Factories run during layer acquisition after resource\n * validation, and the provider factories receive the metric resource.\n * Already-created providers keep the resource captured at construction; the\n * resource option only sets metrics and tracer instrumentation scope for them.\n * Ownership splits: callers own provider flushing and shutdown, including\n * factory-built providers, while the layer scope shuts down every reader the\n * `metricReader` factory returned. No exporter is allocated by this module.\n *\n * @category layers\n * @since 0.1.0\n */\nexport const layerOtel = (options: Options): Layer.Layer<never, InvalidResourceConfiguration> => {\n const resource = resourceLayer(options.resource)\n const tracerProvider = options.tracerProvider\n const loggerProvider = options.loggerProvider\n const tracer = tracerProvider === undefined\n ? Layer.empty\n : Layer.provide(\n OtelTracer.layer,\n Layer.effect(\n OtelTracer.OtelTracerProvider,\n Effect.map(\n Resource,\n (resource) => typeof tracerProvider === \"function\" ? tracerProvider(resource) : tracerProvider\n )\n )\n )\n const logger = loggerProvider === undefined\n ? Layer.empty\n : Layer.provide(\n OtelLogger.layer({ mergeWithExisting: options.loggerMergeWithExisting }),\n Layer.effect(\n OtelLogger.OtelLoggerProvider,\n Effect.map(\n Resource,\n (resource) => typeof loggerProvider === \"function\" ? loggerProvider(resource) : loggerProvider\n )\n )\n )\n const acquireMetricReader = options.metricReader\n const metrics = acquireMetricReader === undefined\n ? Layer.empty\n : OtelMetrics.layer(\n () => acquireMetricReader() as unknown as MetricReader | readonly [MetricReader, ...Array<MetricReader>],\n {\n temporality: options.metricTemporality\n }\n )\n return Layer.mergeAll(tracer, logger, metrics).pipe(Layer.provideMerge(resource))\n}\n\n/**\n * A no-op OTEL layer for callers that want an explicit optional slot.\n *\n * @category layers\n * @since 0.1.0\n */\nexport const layerNoop: Layer.Layer<never> = Layer.empty\n"],
|
|
5
|
+
"mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,iBAA4B;AAC5B,kBAA6B;AAC7B,iBAA4B;AAI5B,aAAwB;AACxB,YAAuB;AACvB,sBAKO;AAmDA,MAAM,YAAY,CAAC,YAAuE;AAC/F,QAAM,eAAW,gBAAAA,OAAc,QAAQ,QAAQ;AAC/C,QAAM,iBAAiB,QAAQ;AAC/B,QAAM,iBAAiB,QAAQ;AAC/B,QAAM,SAAS,mBAAmB,SAC9B,MAAM,QACN,MAAM;AAAA,IACN,WAAW;AAAA,IACX,MAAM;AAAA,MACJ,WAAW;AAAA,MACX,OAAO;AAAA,QACL;AAAA,QACA,CAACC,cAAa,OAAO,mBAAmB,aAAa,eAAeA,SAAQ,IAAI;AAAA,MAClF;AAAA,IACF;AAAA,EACF;AACF,QAAM,SAAS,mBAAmB,SAC9B,MAAM,QACN,MAAM;AAAA,IACN,WAAW,MAAM,EAAE,mBAAmB,QAAQ,wBAAwB,CAAC;AAAA,IACvE,MAAM;AAAA,MACJ,WAAW;AAAA,MACX,OAAO;AAAA,QACL;AAAA,QACA,CAACA,cAAa,OAAO,mBAAmB,aAAa,eAAeA,SAAQ,IAAI;AAAA,MAClF;AAAA,IACF;AAAA,EACF;AACF,QAAM,sBAAsB,QAAQ;AACpC,QAAM,UAAU,wBAAwB,SACpC,MAAM,QACN,YAAY;AAAA,IACZ,MAAM,oBAAoB;AAAA,IAC1B;AAAA,MACE,aAAa,QAAQ;AAAA,IACvB;AAAA,EACF;AACF,SAAO,MAAM,SAAS,QAAQ,QAAQ,OAAO,EAAE,KAAK,MAAM,aAAa,QAAQ,CAAC;AAClF;AAQO,MAAM,YAAgC,MAAM;",
|
|
6
|
+
"names": ["resourceLayer", "resource"]
|
|
7
|
+
}
|
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Default OTLP export wiring for flows telemetry.
|
|
3
|
+
*
|
|
4
|
+
* The store packages already open spans through Effect's tracer and update
|
|
5
|
+
* `Metric` counters on their hot paths; what they deliberately do not do is
|
|
6
|
+
* ship an exporter. This module is that exporter: one layer that installs
|
|
7
|
+
* Effect's own OTLP logger, metrics exporter, and tracer
|
|
8
|
+
* (`effect/unstable/observability/Otlp`) against a collector endpoint, with
|
|
9
|
+
* the flows service identity filled in. Nothing beyond `effect` is involved;
|
|
10
|
+
* no OpenTelemetry SDK dependency.
|
|
11
|
+
*
|
|
12
|
+
* Browser support is met by construction rather than by a no-op variant:
|
|
13
|
+
* export happens over Effect's `HttpClient`, and {@link layerFetch} binds the
|
|
14
|
+
* `fetch` implementation the host already has, so no entry point here ever
|
|
15
|
+
* resolves a `node:` built-in. See the
|
|
16
|
+
* {@link https://smithers.sh/docs/reference/api/observability | observability API contract}.
|
|
17
|
+
*
|
|
18
|
+
* @since 0.1.0
|
|
19
|
+
*/
|
|
20
|
+
import type * as Duration from "effect/Duration";
|
|
21
|
+
import * as Layer from "effect/Layer";
|
|
22
|
+
import * as Headers from "effect/unstable/http/Headers";
|
|
23
|
+
import * as HttpClient from "effect/unstable/http/HttpClient";
|
|
24
|
+
import * as Endpoint from "./Endpoint.ts";
|
|
25
|
+
import * as Resource from "./Resource.ts";
|
|
26
|
+
/**
|
|
27
|
+
* The `service.name` resource attribute installed when the caller supplies
|
|
28
|
+
* none: the flows distribution itself. Override it per application with
|
|
29
|
+
* {@link Options.serviceName}.
|
|
30
|
+
*
|
|
31
|
+
* @category resource
|
|
32
|
+
* @since 0.1.0
|
|
33
|
+
*/
|
|
34
|
+
export declare const defaultServiceName = "flows";
|
|
35
|
+
/**
|
|
36
|
+
* The `service.version` resource attribute installed when the caller supplies
|
|
37
|
+
* none. Mirrors the release version in this package's `package.json`.
|
|
38
|
+
*
|
|
39
|
+
* A published package cannot read its own manifest on every runtime it
|
|
40
|
+
* supports, so the version lives here as a literal.
|
|
41
|
+
* `scripts/set-release-version.mjs` rewrites this declaration with the
|
|
42
|
+
* manifests, and its `--check` mode reports drift, so a release bump cannot
|
|
43
|
+
* leave it behind.
|
|
44
|
+
*
|
|
45
|
+
* @category resource
|
|
46
|
+
* @since 0.1.0
|
|
47
|
+
*/
|
|
48
|
+
export declare const defaultServiceVersion = "1.0.0-rc.3";
|
|
49
|
+
/**
|
|
50
|
+
* Maximum encoded export request size, in bytes.
|
|
51
|
+
* @category transport
|
|
52
|
+
* @since 1.0.0-rc.0
|
|
53
|
+
*/
|
|
54
|
+
export declare const maxRequestBytes: number;
|
|
55
|
+
/**
|
|
56
|
+
* Reserved bytes for request wrappers and the escaped instrumentation scope.
|
|
57
|
+
* @category transport
|
|
58
|
+
* @since 1.0.0-rc.0
|
|
59
|
+
*/
|
|
60
|
+
export declare const maximumEnvelopeBytes: number;
|
|
61
|
+
/**
|
|
62
|
+
* Bytes of every export request kept free for the signal batch itself.
|
|
63
|
+
*
|
|
64
|
+
* The transport discards a request over 1 MiB, and the resource rides in every
|
|
65
|
+
* request, so the largest resource `Resource.decode` admits
|
|
66
|
+
* (`Resource.maximumResourceBytes`, 128 KiB) and the envelope that repeats the
|
|
67
|
+
* service name (under 8 KiB) come off the top. The 888 KiB left gives each
|
|
68
|
+
* record of a full 1,000-record logger or tracer batch about 900 bytes, three
|
|
69
|
+
* to four times a bare log record or span, and gives the metrics snapshot room
|
|
70
|
+
* for several thousand series. Every resource the decoder accepts therefore
|
|
71
|
+
* leaves an ordinary batch of any signal exportable; what this reserve does
|
|
72
|
+
* not bound is a single application record or a registry large enough to
|
|
73
|
+
* exceed it on its own.
|
|
74
|
+
*
|
|
75
|
+
* @category transport
|
|
76
|
+
* @since 1.0.0-rc.0
|
|
77
|
+
*/
|
|
78
|
+
export declare const reservedBatchBytes: number;
|
|
79
|
+
/**
|
|
80
|
+
* Configuration for the default OTLP wiring.
|
|
81
|
+
*
|
|
82
|
+
* @category models
|
|
83
|
+
* @since 0.1.0
|
|
84
|
+
*/
|
|
85
|
+
export interface Options {
|
|
86
|
+
/**
|
|
87
|
+
* The collector base URL, for example `http://localhost:4318`. Signals are
|
|
88
|
+
* posted below it at `/v1/logs`, `/v1/metrics`, and `/v1/traces`. It must be
|
|
89
|
+
* an absolute `http://` or `https://` URL without credentials, a query,
|
|
90
|
+
* fragment, backslashes, spaces, or controls. A base path is allowed. Invalid
|
|
91
|
+
* values fail acquisition with {@link Endpoint.InvalidExporterEndpoint}.
|
|
92
|
+
* Use {@link Options.headers} for authentication.
|
|
93
|
+
*/
|
|
94
|
+
readonly baseUrl: string;
|
|
95
|
+
/** Overrides {@link defaultServiceName} as the `service.name` attribute. */
|
|
96
|
+
readonly serviceName?: string | undefined;
|
|
97
|
+
/** Overrides {@link defaultServiceVersion} as the `service.version` attribute. */
|
|
98
|
+
readonly serviceVersion?: string | undefined;
|
|
99
|
+
/**
|
|
100
|
+
* Additional resource attributes attached to every exported signal, decoded
|
|
101
|
+
* by `Resource.Attributes`. The whole resource must encode to at most
|
|
102
|
+
* `Resource.maximumResourceBytes`; a larger one fails acquisition with
|
|
103
|
+
* {@link Resource.InvalidResourceConfiguration} rather than making every
|
|
104
|
+
* request oversized.
|
|
105
|
+
*/
|
|
106
|
+
readonly attributes?: Record<string, unknown> | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* Headers sent with every export request, for example vendor auth. A header
|
|
109
|
+
* whose name names a credential (`authorization`, `x-api-key`, anything
|
|
110
|
+
* `Redaction.isSensitiveKey` recognizes, plus `x-honeycomb-team`) requires
|
|
111
|
+
* an `https://` baseUrl unless the host is loopback; otherwise acquisition
|
|
112
|
+
* fails with
|
|
113
|
+
* {@link Endpoint.InvalidExporterEndpoint}.
|
|
114
|
+
*/
|
|
115
|
+
readonly headers?: Headers.Input | undefined;
|
|
116
|
+
/** Export cadence for all three signals; each signal's Effect default applies when omitted. */
|
|
117
|
+
readonly exportInterval?: Duration.Input | undefined;
|
|
118
|
+
/** Upper bound on the shutdown flush when the layer's scope closes. */
|
|
119
|
+
readonly shutdownTimeout?: Duration.Input | undefined;
|
|
120
|
+
}
|
|
121
|
+
/**
|
|
122
|
+
* Creates the OTLP logs, metrics, and traces layer with flows resource
|
|
123
|
+
* defaults, JSON-serialized. Exports share a four-request limit with no waiting
|
|
124
|
+
* queue. Requests larger than 1 MiB or stalled for ten seconds are discarded;
|
|
125
|
+
* `flows_observability_otlp_dropped` counts discarded batches, and at most
|
|
126
|
+
* once a minute a `Warn` record with code `otlp_export_discarded` names the
|
|
127
|
+
* reason, the request size, and the running total through the loggers that
|
|
128
|
+
* were installed when the layer was acquired, never through this exporter.
|
|
129
|
+
*
|
|
130
|
+
* **Details**
|
|
131
|
+
*
|
|
132
|
+
* The layer still requires an `HttpClient`, which is how it stays
|
|
133
|
+
* platform-neutral: a Node host may hand it `@effect/platform-node`'s Undici
|
|
134
|
+
* client (re-exported by `@smthrs/platform-node`), a browser or test
|
|
135
|
+
* hands it something else. Use {@link layerFetch} when the host's global
|
|
136
|
+
* `fetch` is good enough. On Node 26 and every browser it is.
|
|
137
|
+
* Fetch redirects are refused. Supply `FetchHttpClient.RequestInit` around
|
|
138
|
+
* the whole exporting effect to retain other fetch options; options scoped
|
|
139
|
+
* only to the supplied client's layer are replaced by the redirect policy.
|
|
140
|
+
* Other HTTP transports must independently refuse automatic redirects.
|
|
141
|
+
*
|
|
142
|
+
* @category layers
|
|
143
|
+
* @since 0.1.0
|
|
144
|
+
*/
|
|
145
|
+
export declare const layer: (options: Options) => Layer.Layer<never, Resource.InvalidResourceConfiguration | Endpoint.InvalidExporterEndpoint, HttpClient.HttpClient>;
|
|
146
|
+
/**
|
|
147
|
+
* Provides {@link layer} over the host's global `fetch`, the default wiring
|
|
148
|
+
* for a Node host, and browser-safe by construction because it never touches
|
|
149
|
+
* a `node:` built-in.
|
|
150
|
+
*
|
|
151
|
+
* **Example**
|
|
152
|
+
*
|
|
153
|
+
* ```ts
|
|
154
|
+
* import * as Otlp from "@smthrs/observability/Otlp"
|
|
155
|
+
*
|
|
156
|
+
* const Telemetry = Otlp.layerFetch({ baseUrl: "http://localhost:4318" })
|
|
157
|
+
* ```
|
|
158
|
+
*
|
|
159
|
+
* @category layers
|
|
160
|
+
* @since 0.1.0
|
|
161
|
+
*/
|
|
162
|
+
export declare const layerFetch: (options: Options) => Layer.Layer<never, Resource.InvalidResourceConfiguration | Endpoint.InvalidExporterEndpoint>;
|
|
163
|
+
/**
|
|
164
|
+
* Why an OTLP layer refused to start.
|
|
165
|
+
*
|
|
166
|
+
* @category errors
|
|
167
|
+
* @since 1.0.0
|
|
168
|
+
*/
|
|
169
|
+
export type LayerError = Resource.InvalidResourceConfiguration | Endpoint.InvalidExporterEndpoint;
|
|
170
|
+
/**
|
|
171
|
+
* Parses `OTEL_EXPORTER_OTLP_HEADERS`: comma-separated `key=value` pairs whose
|
|
172
|
+
* values are percent-decoded, as the OpenTelemetry exporter specification
|
|
173
|
+
* defines. A pair without `=` or with an empty key is skipped.
|
|
174
|
+
*
|
|
175
|
+
* @category environment
|
|
176
|
+
* @since 1.0.0
|
|
177
|
+
*/
|
|
178
|
+
export declare const parseHeaders: (value: string | undefined) => Record<string, string>;
|
|
179
|
+
/**
|
|
180
|
+
* {@link layerFetch} when the environment names a collector, otherwise
|
|
181
|
+
* {@link layerNoop}.
|
|
182
|
+
*
|
|
183
|
+
* `OTEL_EXPORTER_OTLP_ENDPOINT` is the collector base URL and
|
|
184
|
+
* `OTEL_EXPORTER_OTLP_HEADERS` the headers sent with every export. An unset or
|
|
185
|
+
* empty endpoint installs no exporter at all.
|
|
186
|
+
*
|
|
187
|
+
* @category layers
|
|
188
|
+
* @since 1.0.0
|
|
189
|
+
*/
|
|
190
|
+
export declare const layerEnvironment: (environment: Readonly<Record<string, string | undefined>>, options?: Omit<Options, "baseUrl" | "headers">) => Layer.Layer<never, LayerError>;
|
|
191
|
+
/**
|
|
192
|
+
* Exports nothing. The explicit stand-in for hosts with no collector, such as
|
|
193
|
+
* a development shell, a test, or a browser deployment that has not opted in, so
|
|
194
|
+
* wiring code can switch layers rather than branch.
|
|
195
|
+
*
|
|
196
|
+
* @category layers
|
|
197
|
+
* @since 0.1.0
|
|
198
|
+
*/
|
|
199
|
+
export declare const layerNoop: Layer.Layer<never>;
|
|
200
|
+
//# sourceMappingURL=Otlp.d.ts.map
|