@pixel-brewery/archipel-platform-telemetry
Classes
| Class | Description |
|---|---|
| MeasurementSinkPort | Destination for individual numeric measurements. |
| MeasurementsInterceptor | Records completed HTTP request values through the direct measurement path. |
| MeasurementsModule | Installs one direct measurement sink and optional HTTP instrumentation. |
| MeasurementsService | Records individual numeric values without imposing an aggregation model. |
| MetricsService | Records application metrics through OpenTelemetry instruments. |
| NoopMeasurementSink | Explicit no-op sink for individual numeric measurements. |
| NoopTelemetryFacade | - |
| OtelMetricClient | Owns OpenTelemetry metric instruments and their recording semantics. |
| OtelMetricsInterceptor | Records completed HTTP requests through OpenTelemetry instruments. |
| OtelSdkHolder | Holds a reference to the selected OpenTelemetry SDK components and performs a graceful shutdown when the application terminates. |
| TelemetryCacheMetricsRecorder | Generic cache metrics recorder that forwards cache lifecycle events into the telemetry facade (which may be a noop when disabled). |
| TelemetryFacade | - |
| TelemetryHealthIndicator | Health indicator for the telemetry infrastructure. Checks whether the OpenTelemetry SDK has been initialized via OtelSdkHolder. |
| TelemetryLoggerService | - |
| TelemetryModule | - |
| TelemetryRuleEngine | - |
| VercelMeasurementSink | Sends each observation to Vercel Custom Metrics for the current Function invocation. |
Interfaces
| Interface | Description |
|---|---|
| IMeasurementsModuleOptions | Configuration for one direct numeric measurement sink. |
| IMetricInstruments | Built-in OpenTelemetry instruments used by telemetry operations. |
| IMetricReaderOptions | Collection interval for an OpenTelemetry push metric reader. |
| ITelemetryFacade | - |
| ITelemetryMetricsOptions | - |
| ITelemetryModuleOptions | Telemetry SDK options with explicitly selected OpenTelemetry metric readers. |
| ITelemetryOptions | - |
| ITelemetryTracesOptions | - |
Type Aliases
| Type Alias | Description |
|---|---|
| MetricKind | OpenTelemetry instrument kinds supported by MetricsService. |
Variables
| Variable | Description |
|---|---|
| CONSOLE_CONFIG_ENTRIES | Console output requires no configuration entries. |
| defaultTelemetryOptions | - |
| EMPTY_CONFIG_ENTRIES | The disabled measurement sink needs no configuration entries. |
| OTLP_GRPC_CONFIG_ENTRIES | This reader uses the standard OTEL_EXPORTER_OTLP_* settings. |
| OTLP_HTTP_CONFIG_ENTRIES | This reader uses the standard OTEL_EXPORTER_OTLP_* settings. |
| PROMETHEUS_CONFIG_ENTRIES | The Prometheus scrape port is passed explicitly to the reader factory. |
| TELEMETRY_ENABLED | - |
| TELEMETRY_FACADE | - |
| TELEMETRY_OPTIONS | - |
| VERCEL_CONFIG_ENTRIES | Vercel Custom Metrics use the current Function invocation and need no configuration entries. |
Functions
| Function | Description |
|---|---|
| createConsoleMetricReader | Creates a console reader for local diagnostics. |
| createOtlpGrpcMetricReader | Creates an OTLP/gRPC reader using the standard OpenTelemetry exporter configuration. |
| createOtlpHttpMetricReader | Creates an OTLP/HTTP reader using the standard OpenTelemetry exporter configuration. |
| createPrometheusMetricReader | Creates an OpenTelemetry scrape reader for long-running Prometheus targets. |
| validateTelemetryOptions | Validates telemetry options and throws on invalid values. |