@noego/telemetry 0.0.1

package/dist/storage.types-BTCGVxOM.d.ts

@@ -0,0 +1,76 @@
+import { E as ExtractedMetricSample, a as MetricExtractionFailure, M as MetricDefinition, T as TimelineQuery, b as TimelineQueryResponse, c as TelemetryQueryError, d as MetricQuery, e as MetricQueryResponse } from './query.types-DySoqYop.js';
+import { T as TelemetryResult } from './result.types-171Huujb.js';
+import { d as TelemetryBatch, f as TelemetryDropCounter, e as TelemetryAcknowledgement, g as TelemetryDeliveryMode } from './transport.types-DDnZoKWi.js';
+
+type TelemetryStorageCapabilities = Readonly<{
+    rawPersistence: boolean;
+    metricSamples: boolean;
+    rollups: boolean;
+    queries: boolean;
+    retention: boolean;
+    maintenance: boolean;
+}>;
+type StoragePersistRequest = Readonly<{
+    batch: TelemetryBatch;
+    samples: readonly ExtractedMetricSample[];
+    extractionFailures: readonly MetricExtractionFailure[];
+}>;
+type StorageTargetStatus = Readonly<{
+    targetId: string;
+    state: 'created' | 'starting' | 'ready' | 'failed' | 'stopped';
+    detail: string | null;
+    writerLeaseHeld: boolean;
+    committedDropCounters?: readonly TelemetryDropCounter[];
+}>;
+interface TelemetryStorageTransport {
+    readonly targetId: string;
+    readonly capabilities: TelemetryStorageCapabilities;
+    start(definitions: readonly MetricDefinition[]): Promise<TelemetryResult<void, string>>;
+    persist(request: StoragePersistRequest): Promise<TelemetryAcknowledgement>;
+    timeline(query: TimelineQuery): Promise<TelemetryResult<TimelineQueryResponse, TelemetryQueryError>>;
+    metrics(query: MetricQuery): Promise<TelemetryResult<MetricQueryResponse, TelemetryQueryError>>;
+    materializeRollups(nowMs: number, maxWorkMs: number): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    enforceRetention(nowMs: number, shouldContinue?: () => boolean): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    checkpoint(): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    reclaim(maxPages: number): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    compact(deadlineMs: number): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    recordMaintenance?(record: MaintenanceRunRecord): Promise<TelemetryResult<void, string>>;
+    status(): StorageTargetStatus;
+    stop(deadlineMs: number): Promise<void>;
+}
+type TelemetryStorageTarget = Readonly<{
+    targetId: string;
+    delivery: TelemetryDeliveryMode;
+    transport: TelemetryStorageTransport;
+    matches: (batch: TelemetryBatch) => boolean;
+}>;
+type TelemetryStorageRouterOptions = Readonly<{
+    routerId: string;
+    targets: readonly TelemetryStorageTarget[];
+    defaultTargetId: string | null;
+    volatile: boolean;
+    now: () => number;
+    maxRememberedBatches?: number;
+}>;
+type MaintenanceStageResult = Readonly<{
+    stage: 'rollup' | 'retention' | 'checkpoint' | 'reclaim' | 'compaction';
+    affectedRows: number;
+    affectedPages: number;
+    elapsedMs: number;
+    detail: string | null;
+    deletionRounds?: number;
+    completed?: boolean;
+    interrupted?: boolean;
+}>;
+type MaintenanceRunRecord = Readonly<{
+    runId: string;
+    kind: 'scheduled' | 'compaction';
+    state: 'started' | 'completed' | 'failed';
+    startedAtMs: number;
+    completedAtMs: number | null;
+    stages: readonly MaintenanceStageResult[];
+    failedStage: MaintenanceStageResult['stage'] | null;
+    error: string | null;
+}>;
+
+export type { MaintenanceStageResult as M, StoragePersistRequest as S, TelemetryStorageTransport as T, TelemetryStorageCapabilities as a, StorageTargetStatus as b, MaintenanceRunRecord as c, TelemetryStorageRouterOptions as d, TelemetryStorageTarget as e };

package/dist/storage.types-DjuUMinz.d.cts

@@ -0,0 +1,76 @@
+import { E as ExtractedMetricSample, a as MetricExtractionFailure, M as MetricDefinition, T as TimelineQuery, b as TimelineQueryResponse, c as TelemetryQueryError, d as MetricQuery, e as MetricQueryResponse } from './query.types-Bntwh6KF.cjs';
+import { T as TelemetryResult } from './result.types-171Huujb.cjs';
+import { d as TelemetryBatch, f as TelemetryDropCounter, e as TelemetryAcknowledgement, g as TelemetryDeliveryMode } from './transport.types-BAl_TRtU.cjs';
+
+type TelemetryStorageCapabilities = Readonly<{
+    rawPersistence: boolean;
+    metricSamples: boolean;
+    rollups: boolean;
+    queries: boolean;
+    retention: boolean;
+    maintenance: boolean;
+}>;
+type StoragePersistRequest = Readonly<{
+    batch: TelemetryBatch;
+    samples: readonly ExtractedMetricSample[];
+    extractionFailures: readonly MetricExtractionFailure[];
+}>;
+type StorageTargetStatus = Readonly<{
+    targetId: string;
+    state: 'created' | 'starting' | 'ready' | 'failed' | 'stopped';
+    detail: string | null;
+    writerLeaseHeld: boolean;
+    committedDropCounters?: readonly TelemetryDropCounter[];
+}>;
+interface TelemetryStorageTransport {
+    readonly targetId: string;
+    readonly capabilities: TelemetryStorageCapabilities;
+    start(definitions: readonly MetricDefinition[]): Promise<TelemetryResult<void, string>>;
+    persist(request: StoragePersistRequest): Promise<TelemetryAcknowledgement>;
+    timeline(query: TimelineQuery): Promise<TelemetryResult<TimelineQueryResponse, TelemetryQueryError>>;
+    metrics(query: MetricQuery): Promise<TelemetryResult<MetricQueryResponse, TelemetryQueryError>>;
+    materializeRollups(nowMs: number, maxWorkMs: number): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    enforceRetention(nowMs: number, shouldContinue?: () => boolean): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    checkpoint(): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    reclaim(maxPages: number): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    compact(deadlineMs: number): Promise<TelemetryResult<MaintenanceStageResult, string>>;
+    recordMaintenance?(record: MaintenanceRunRecord): Promise<TelemetryResult<void, string>>;
+    status(): StorageTargetStatus;
+    stop(deadlineMs: number): Promise<void>;
+}
+type TelemetryStorageTarget = Readonly<{
+    targetId: string;
+    delivery: TelemetryDeliveryMode;
+    transport: TelemetryStorageTransport;
+    matches: (batch: TelemetryBatch) => boolean;
+}>;
+type TelemetryStorageRouterOptions = Readonly<{
+    routerId: string;
+    targets: readonly TelemetryStorageTarget[];
+    defaultTargetId: string | null;
+    volatile: boolean;
+    now: () => number;
+    maxRememberedBatches?: number;
+}>;
+type MaintenanceStageResult = Readonly<{
+    stage: 'rollup' | 'retention' | 'checkpoint' | 'reclaim' | 'compaction';
+    affectedRows: number;
+    affectedPages: number;
+    elapsedMs: number;
+    detail: string | null;
+    deletionRounds?: number;
+    completed?: boolean;
+    interrupted?: boolean;
+}>;
+type MaintenanceRunRecord = Readonly<{
+    runId: string;
+    kind: 'scheduled' | 'compaction';
+    state: 'started' | 'completed' | 'failed';
+    startedAtMs: number;
+    completedAtMs: number | null;
+    stages: readonly MaintenanceStageResult[];
+    failedStage: MaintenanceStageResult['stage'] | null;
+    error: string | null;
+}>;
+
+export type { MaintenanceStageResult as M, StoragePersistRequest as S, TelemetryStorageTransport as T, TelemetryStorageCapabilities as a, StorageTargetStatus as b, MaintenanceRunRecord as c, TelemetryStorageRouterOptions as d, TelemetryStorageTarget as e };

package/dist/telemetry_client-BXw8WH_F.d.ts

@@ -0,0 +1,141 @@
+import { T as TelemetryBatchTransport, f as TelemetryDropCounter, e as TelemetryAcknowledgement } from './transport.types-DDnZoKWi.js';
+import { c as TelemetryJsonObject, f as TelemetryLevel, a as TelemetryAdmitInput } from './envelope.types-rOLpWXRC.js';
+
+type MetadataRedactionRule = Readonly<{
+    path: string;
+    replacement: string;
+}>;
+type MetadataSnapshotLimits = Readonly<{
+    maxBytes: number;
+    maxDepth: number;
+    maxProperties: number;
+    maxArrayLength: number;
+    maxStringLength: number;
+    maxErrorStackLength: number;
+    redactions: readonly MetadataRedactionRule[];
+}>;
+type MetadataSnapshotStats = Readonly<{
+    estimatedBytes: number;
+    truncatedValues: number;
+    redactedValues: number;
+    serializationFailures: number;
+}>;
+type MetadataSnapshot = Readonly<{
+    metadata: TelemetryJsonObject;
+    stats: MetadataSnapshotStats;
+}>;
+
+type TelemetryAdmissionPriority = 'low' | 'normal' | 'high';
+type TelemetryAdmissionPolicy = Readonly<{
+    maxQueuedEvents: number;
+    maxQueuedBytes: number;
+    maxBatchEvents: number;
+    maxBatchBytes: number;
+    maxInFlightBatches: number;
+    retryLimit: number;
+    retryBaseDelayMs: number;
+    sampleRates: Readonly<Record<TelemetryAdmissionPriority, number>>;
+}>;
+type TelemetryClientOptions = Readonly<{
+    source: string;
+    processKind: string;
+    transport: TelemetryBatchTransport;
+    admission: TelemetryAdmissionPolicy;
+    metadata: MetadataSnapshotLimits;
+    producerId: string;
+    now: () => number;
+    monotonicNowNs: () => string | null;
+    schedule: (work: () => void) => void;
+    delay: (durationMs: number) => Promise<void>;
+    random: () => number;
+}>;
+type TelemetryAdmissionResult = Readonly<{
+    kind: 'admitted';
+    producerId: string;
+    sequence: number;
+    eventId: string;
+}> | Readonly<{
+    kind: 'dropped';
+    producerId: string;
+    sequence: number;
+    reason: string;
+}>;
+type TelemetryClientStatus = Readonly<{
+    state: 'accepting' | 'draining' | 'stopped';
+    producerId: string;
+    nextSequence: number;
+    queuedEvents: number;
+    queuedBytes: number;
+    inFlightBatches: number;
+    dropCounters: readonly TelemetryDropCounter[];
+    lastAcknowledgement: TelemetryAcknowledgement | null;
+}>;
+
+declare class TelemetryClient {
+    private readonly options;
+    private readonly snapshotter;
+    private readonly batchContract;
+    private readonly queue;
+    private readonly dropCounts;
+    private state;
+    private nextSequence;
+    private queuedBytes;
+    private inFlightBatches;
+    private drainScheduled;
+    private activeDrain;
+    private lastAcknowledgement;
+    constructor(options: TelemetryClientOptions);
+    trace(level: TelemetryLevel, label: string, metadata?: unknown): TelemetryAdmissionResult;
+    debug(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    info(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    warn(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    error(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    fatal(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    emit(level: TelemetryLevel, label: string, metadata: unknown): TelemetryAdmissionResult;
+    admit(input: TelemetryAdmitInput): TelemetryAdmissionResult;
+    status(): TelemetryClientStatus;
+    flush(deadlineMs: number): Promise<void>;
+    stop(deadlineMs: number): Promise<void>;
+    private createEnvelope;
+    private resolveCorrelation;
+    private scheduleDrain;
+    private drainLoop;
+    private prepareBatch;
+    private peekBatchEntries;
+    private findFittingBatch;
+    private deliverWithRetry;
+    private retryDelay;
+    private normalizeAcknowledgement;
+    private acknowledgementError;
+    private committedAcknowledgementError;
+    private retryableAcknowledgementError;
+    private rejectedAcknowledgementError;
+    private conflictAcknowledgementError;
+    private targetStatesError;
+    private isValidTargetState;
+    private invalidAcknowledgement;
+    private detachAcknowledgement;
+    private isRecord;
+    private hasExactKeys;
+    private isBoundedReason;
+    private dropCounterSnapshot;
+    private subtractDropSnapshot;
+    private incrementDrop;
+    private incrementDropBy;
+    private priorityFor;
+    private isSampled;
+    private isValidLabel;
+    private errorMessage;
+    private settleExternalShutdown;
+    private validateOptions;
+    private validateIdentityOptions;
+    private validateOrderedDeliveryOptions;
+    private validateCapacityOptions;
+    private validateBatchEventOptions;
+    private validateBatchByteOptions;
+    private validateMetadataOptions;
+    private validateRetryOptions;
+    private validateSampleRateOptions;
+}
+
+export { type MetadataSnapshotLimits as M, type TelemetryAdmissionPolicy as T, TelemetryClient as a, type TelemetryAdmissionResult as b, type MetadataRedactionRule as c, type MetadataSnapshot as d, type MetadataSnapshotStats as e, type TelemetryAdmissionPriority as f, type TelemetryClientOptions as g, type TelemetryClientStatus as h };

package/dist/telemetry_client-CYaPYfOl.d.cts

@@ -0,0 +1,141 @@
+import { T as TelemetryBatchTransport, f as TelemetryDropCounter, e as TelemetryAcknowledgement } from './transport.types-BAl_TRtU.cjs';
+import { c as TelemetryJsonObject, f as TelemetryLevel, a as TelemetryAdmitInput } from './envelope.types-rOLpWXRC.cjs';
+
+type MetadataRedactionRule = Readonly<{
+    path: string;
+    replacement: string;
+}>;
+type MetadataSnapshotLimits = Readonly<{
+    maxBytes: number;
+    maxDepth: number;
+    maxProperties: number;
+    maxArrayLength: number;
+    maxStringLength: number;
+    maxErrorStackLength: number;
+    redactions: readonly MetadataRedactionRule[];
+}>;
+type MetadataSnapshotStats = Readonly<{
+    estimatedBytes: number;
+    truncatedValues: number;
+    redactedValues: number;
+    serializationFailures: number;
+}>;
+type MetadataSnapshot = Readonly<{
+    metadata: TelemetryJsonObject;
+    stats: MetadataSnapshotStats;
+}>;
+
+type TelemetryAdmissionPriority = 'low' | 'normal' | 'high';
+type TelemetryAdmissionPolicy = Readonly<{
+    maxQueuedEvents: number;
+    maxQueuedBytes: number;
+    maxBatchEvents: number;
+    maxBatchBytes: number;
+    maxInFlightBatches: number;
+    retryLimit: number;
+    retryBaseDelayMs: number;
+    sampleRates: Readonly<Record<TelemetryAdmissionPriority, number>>;
+}>;
+type TelemetryClientOptions = Readonly<{
+    source: string;
+    processKind: string;
+    transport: TelemetryBatchTransport;
+    admission: TelemetryAdmissionPolicy;
+    metadata: MetadataSnapshotLimits;
+    producerId: string;
+    now: () => number;
+    monotonicNowNs: () => string | null;
+    schedule: (work: () => void) => void;
+    delay: (durationMs: number) => Promise<void>;
+    random: () => number;
+}>;
+type TelemetryAdmissionResult = Readonly<{
+    kind: 'admitted';
+    producerId: string;
+    sequence: number;
+    eventId: string;
+}> | Readonly<{
+    kind: 'dropped';
+    producerId: string;
+    sequence: number;
+    reason: string;
+}>;
+type TelemetryClientStatus = Readonly<{
+    state: 'accepting' | 'draining' | 'stopped';
+    producerId: string;
+    nextSequence: number;
+    queuedEvents: number;
+    queuedBytes: number;
+    inFlightBatches: number;
+    dropCounters: readonly TelemetryDropCounter[];
+    lastAcknowledgement: TelemetryAcknowledgement | null;
+}>;
+
+declare class TelemetryClient {
+    private readonly options;
+    private readonly snapshotter;
+    private readonly batchContract;
+    private readonly queue;
+    private readonly dropCounts;
+    private state;
+    private nextSequence;
+    private queuedBytes;
+    private inFlightBatches;
+    private drainScheduled;
+    private activeDrain;
+    private lastAcknowledgement;
+    constructor(options: TelemetryClientOptions);
+    trace(level: TelemetryLevel, label: string, metadata?: unknown): TelemetryAdmissionResult;
+    debug(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    info(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    warn(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    error(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    fatal(label: string, metadata?: unknown): TelemetryAdmissionResult;
+    emit(level: TelemetryLevel, label: string, metadata: unknown): TelemetryAdmissionResult;
+    admit(input: TelemetryAdmitInput): TelemetryAdmissionResult;
+    status(): TelemetryClientStatus;
+    flush(deadlineMs: number): Promise<void>;
+    stop(deadlineMs: number): Promise<void>;
+    private createEnvelope;
+    private resolveCorrelation;
+    private scheduleDrain;
+    private drainLoop;
+    private prepareBatch;
+    private peekBatchEntries;
+    private findFittingBatch;
+    private deliverWithRetry;
+    private retryDelay;
+    private normalizeAcknowledgement;
+    private acknowledgementError;
+    private committedAcknowledgementError;
+    private retryableAcknowledgementError;
+    private rejectedAcknowledgementError;
+    private conflictAcknowledgementError;
+    private targetStatesError;
+    private isValidTargetState;
+    private invalidAcknowledgement;
+    private detachAcknowledgement;
+    private isRecord;
+    private hasExactKeys;
+    private isBoundedReason;
+    private dropCounterSnapshot;
+    private subtractDropSnapshot;
+    private incrementDrop;
+    private incrementDropBy;
+    private priorityFor;
+    private isSampled;
+    private isValidLabel;
+    private errorMessage;
+    private settleExternalShutdown;
+    private validateOptions;
+    private validateIdentityOptions;
+    private validateOrderedDeliveryOptions;
+    private validateCapacityOptions;
+    private validateBatchEventOptions;
+    private validateBatchByteOptions;
+    private validateMetadataOptions;
+    private validateRetryOptions;
+    private validateSampleRateOptions;
+}
+
+export { type MetadataSnapshotLimits as M, type TelemetryAdmissionPolicy as T, TelemetryClient as a, type TelemetryAdmissionResult as b, type MetadataRedactionRule as c, type MetadataSnapshot as d, type MetadataSnapshotStats as e, type TelemetryAdmissionPriority as f, type TelemetryClientOptions as g, type TelemetryClientStatus as h };

package/dist/telemetry_configuration_parser-C7Et_gwG.d.ts

@@ -0,0 +1,39 @@
+import { M as MetricDefinitionContract } from './metric_definition_contract-l4i4SaAp.js';
+import { R as ResolvedTelemetryConfiguration } from './query.types-DySoqYop.js';
+
+declare class TelemetryDurationParser {
+    private static readonly MULTIPLIERS;
+    parse(value: string, field: string, allowZero?: boolean): number;
+}
+
+type NodeTelemetryConfigurationParseOptions = Readonly<{
+    sourceName?: string;
+    storageBaseDirectory?: string;
+}>;
+
+declare class TelemetryConfigurationError extends Error {
+    readonly source: string;
+    constructor(message: string, source: string);
+}
+declare class NodeTelemetryConfigurationParser {
+    private readonly durations;
+    private readonly metricContract;
+    constructor(durations?: TelemetryDurationParser, metricContract?: MetricDefinitionContract);
+    parseFile(configurationPath: string, options?: NodeTelemetryConfigurationParseOptions): ResolvedTelemetryConfiguration;
+    parseYaml(source: string, options?: NodeTelemetryConfigurationParseOptions): ResolvedTelemetryConfiguration;
+    private resolveDocument;
+    private validateRole;
+    private resolveTarget;
+    private validateRetention;
+    private validateTargets;
+    private resolveMetric;
+    private validateNormalizedMetric;
+    private isFieldPath;
+    private resolveMeasurement;
+    private metricResolutions;
+    private validateMetricResolutions;
+    private validateMetricIdentities;
+    private errorMessage;
+}
+
+export { NodeTelemetryConfigurationParser as N, TelemetryConfigurationError as T, type NodeTelemetryConfigurationParseOptions as a, TelemetryDurationParser as b };

package/dist/telemetry_configuration_parser-R-niZQRZ.d.cts

@@ -0,0 +1,39 @@
+import { M as MetricDefinitionContract } from './metric_definition_contract-BR6a_GzF.cjs';
+import { R as ResolvedTelemetryConfiguration } from './query.types-Bntwh6KF.cjs';
+
+declare class TelemetryDurationParser {
+    private static readonly MULTIPLIERS;
+    parse(value: string, field: string, allowZero?: boolean): number;
+}
+
+type NodeTelemetryConfigurationParseOptions = Readonly<{
+    sourceName?: string;
+    storageBaseDirectory?: string;
+}>;
+
+declare class TelemetryConfigurationError extends Error {
+    readonly source: string;
+    constructor(message: string, source: string);
+}
+declare class NodeTelemetryConfigurationParser {
+    private readonly durations;
+    private readonly metricContract;
+    constructor(durations?: TelemetryDurationParser, metricContract?: MetricDefinitionContract);
+    parseFile(configurationPath: string, options?: NodeTelemetryConfigurationParseOptions): ResolvedTelemetryConfiguration;
+    parseYaml(source: string, options?: NodeTelemetryConfigurationParseOptions): ResolvedTelemetryConfiguration;
+    private resolveDocument;
+    private validateRole;
+    private resolveTarget;
+    private validateRetention;
+    private validateTargets;
+    private resolveMetric;
+    private validateNormalizedMetric;
+    private isFieldPath;
+    private resolveMeasurement;
+    private metricResolutions;
+    private validateMetricResolutions;
+    private validateMetricIdentities;
+    private errorMessage;
+}
+
+export { NodeTelemetryConfigurationParser as N, TelemetryConfigurationError as T, type NodeTelemetryConfigurationParseOptions as a, TelemetryDurationParser as b };