|
| 1 | +import { |
| 2 | + OtelCollectorContainer, |
| 3 | + type StartedOtelCollectorContainer, |
| 4 | +} from "@internal/testcontainers"; |
| 5 | + |
| 6 | +import { metrics } from "@opentelemetry/api"; |
| 7 | +import { ExportResultCode } from "@opentelemetry/core"; |
| 8 | +import { |
| 9 | + MetricReader, |
| 10 | + type PushMetricExporter, |
| 11 | + type ResourceMetrics, |
| 12 | +} from "@opentelemetry/sdk-metrics"; |
| 13 | +import { afterAll, beforeAll, describe, expect, it } from "vitest"; |
| 14 | +import { TracingSDK } from "./tracingSDK.js"; |
| 15 | + |
| 16 | +class NoopMetricExporter implements PushMetricExporter { |
| 17 | + forceFlushCount = 0; |
| 18 | + |
| 19 | + export(_metrics: ResourceMetrics, resultCallback: (result: { code: number }) => void): void { |
| 20 | + resultCallback({ code: ExportResultCode.SUCCESS }); |
| 21 | + } |
| 22 | + |
| 23 | + async forceFlush(): Promise<void> { |
| 24 | + this.forceFlushCount++; |
| 25 | + } |
| 26 | + |
| 27 | + async shutdown(): Promise<void> {} |
| 28 | +} |
| 29 | + |
| 30 | +describe("TracingSDK with an external metric exporter", () => { |
| 31 | + let collector: StartedOtelCollectorContainer; |
| 32 | + let tracingSDK: TracingSDK; |
| 33 | + |
| 34 | + beforeAll(async () => { |
| 35 | + collector = await new OtelCollectorContainer().start(); |
| 36 | + |
| 37 | + process.env.TRIGGER_OTEL_METRICS_COLLECTION_INTERVAL_MILLIS = "600000"; |
| 38 | + |
| 39 | + tracingSDK = new TracingSDK({ |
| 40 | + url: collector.getOtlpHttpUrl(), |
| 41 | + forceFlushTimeoutMillis: 30_000, |
| 42 | + diagLogLevel: "none", |
| 43 | + metricExporters: [new NoopMetricExporter()], |
| 44 | + hostMetrics: true, |
| 45 | + hostMetricGroups: ["process.cpu", "process.memory"], |
| 46 | + nodejsRuntimeMetrics: true, |
| 47 | + }); |
| 48 | + }, 180_000); |
| 49 | + |
| 50 | + afterAll(async () => { |
| 51 | + await tracingSDK?.shutdown(); |
| 52 | + await collector?.stop(); |
| 53 | + delete process.env.TRIGGER_OTEL_METRICS_COLLECTION_INTERVAL_MILLIS; |
| 54 | + }); |
| 55 | + |
| 56 | + it("flushes without the collector rejecting a batch containing a NaN reading", async () => { |
| 57 | + const gauge = metrics.getMeter("test").createObservableGauge("test.utilization"); |
| 58 | + gauge.addCallback((result) => result.observe(NaN)); |
| 59 | + |
| 60 | + await expect(tracingSDK.flush()).resolves.toBeUndefined(); |
| 61 | + }); |
| 62 | + |
| 63 | + it("collects from each metric reader one at a time", async () => { |
| 64 | + let inFlight = 0; |
| 65 | + let maxInFlight = 0; |
| 66 | + |
| 67 | + const gauge = metrics.getMeter("test").createObservableGauge("test.concurrency"); |
| 68 | + gauge.addCallback(async (result) => { |
| 69 | + inFlight++; |
| 70 | + maxInFlight = Math.max(maxInFlight, inFlight); |
| 71 | + await new Promise((resolve) => setTimeout(resolve, 5)); |
| 72 | + result.observe(1); |
| 73 | + inFlight--; |
| 74 | + }); |
| 75 | + |
| 76 | + await tracingSDK.flush(); |
| 77 | + |
| 78 | + expect(maxInFlight).toBe(1); |
| 79 | + }); |
| 80 | +}); |
| 81 | + |
| 82 | +class FailingMetricReader extends MetricReader { |
| 83 | + protected async onForceFlush(): Promise<void> { |
| 84 | + throw new Error("reader flush failed"); |
| 85 | + } |
| 86 | + |
| 87 | + protected async onShutdown(): Promise<void> {} |
| 88 | +} |
| 89 | + |
| 90 | +class FailingShutdownMetricReader extends MetricReader { |
| 91 | + protected async onForceFlush(): Promise<void> {} |
| 92 | + |
| 93 | + protected async onShutdown(): Promise<void> { |
| 94 | + throw new Error("reader shutdown failed"); |
| 95 | + } |
| 96 | +} |
| 97 | + |
| 98 | +class RecordingMetricReader extends MetricReader { |
| 99 | + forceFlushCount = 0; |
| 100 | + shutdownCount = 0; |
| 101 | + |
| 102 | + protected async onForceFlush(): Promise<void> { |
| 103 | + this.forceFlushCount++; |
| 104 | + } |
| 105 | + |
| 106 | + protected async onShutdown(): Promise<void> { |
| 107 | + this.shutdownCount++; |
| 108 | + } |
| 109 | +} |
| 110 | + |
| 111 | +function captureConsoleErrors(): { lines: string[]; restore: () => void } { |
| 112 | + const lines: string[] = []; |
| 113 | + const original = console.error; |
| 114 | + |
| 115 | + console.error = (...args: unknown[]) => { |
| 116 | + lines.push(args.map(String).join(" ")); |
| 117 | + }; |
| 118 | + |
| 119 | + return { lines, restore: () => (console.error = original) }; |
| 120 | +} |
| 121 | + |
| 122 | +describe("TracingSDK when one metric reader fails to flush", () => { |
| 123 | + let recordingReader: RecordingMetricReader; |
| 124 | + let tracingSDK: TracingSDK; |
| 125 | + |
| 126 | + beforeAll(() => { |
| 127 | + recordingReader = new RecordingMetricReader(); |
| 128 | + |
| 129 | + tracingSDK = new TracingSDK({ |
| 130 | + url: "http://localhost:1", |
| 131 | + forceFlushTimeoutMillis: 5_000, |
| 132 | + diagLogLevel: "none", |
| 133 | + metricReaders: [new FailingMetricReader(), recordingReader], |
| 134 | + }); |
| 135 | + }); |
| 136 | + |
| 137 | + it("still flushes the readers after it", async () => { |
| 138 | + await tracingSDK.flush().catch(() => {}); |
| 139 | + |
| 140 | + expect(recordingReader.forceFlushCount).toBeGreaterThan(0); |
| 141 | + }); |
| 142 | + |
| 143 | + it("still reports the failure to the caller", async () => { |
| 144 | + await expect(tracingSDK.flush()).rejects.toThrow("reader flush failed"); |
| 145 | + }); |
| 146 | + |
| 147 | + it("logs the failure as it happens", async () => { |
| 148 | + const console = captureConsoleErrors(); |
| 149 | + |
| 150 | + await tracingSDK.flush().catch(() => {}); |
| 151 | + console.restore(); |
| 152 | + |
| 153 | + expect(console.lines.join("\n")).toContain("reader flush failed"); |
| 154 | + }); |
| 155 | +}); |
| 156 | + |
| 157 | +class OverlapRecordingMetricReader extends MetricReader { |
| 158 | + static inFlight = 0; |
| 159 | + static maxInFlight = 0; |
| 160 | + |
| 161 | + protected async onForceFlush(): Promise<void> {} |
| 162 | + |
| 163 | + protected async onShutdown(): Promise<void> { |
| 164 | + OverlapRecordingMetricReader.inFlight++; |
| 165 | + OverlapRecordingMetricReader.maxInFlight = Math.max( |
| 166 | + OverlapRecordingMetricReader.maxInFlight, |
| 167 | + OverlapRecordingMetricReader.inFlight |
| 168 | + ); |
| 169 | + await new Promise((resolve) => setTimeout(resolve, 5)); |
| 170 | + OverlapRecordingMetricReader.inFlight--; |
| 171 | + } |
| 172 | +} |
| 173 | + |
| 174 | +describe("TracingSDK shutdown", () => { |
| 175 | + it("shuts down each metric reader one at a time", async () => { |
| 176 | + OverlapRecordingMetricReader.inFlight = 0; |
| 177 | + OverlapRecordingMetricReader.maxInFlight = 0; |
| 178 | + |
| 179 | + const tracingSDK = new TracingSDK({ |
| 180 | + url: "http://localhost:1", |
| 181 | + forceFlushTimeoutMillis: 5_000, |
| 182 | + diagLogLevel: "none", |
| 183 | + metricReaders: [new OverlapRecordingMetricReader(), new OverlapRecordingMetricReader()], |
| 184 | + }); |
| 185 | + |
| 186 | + await tracingSDK.shutdown().catch(() => {}); |
| 187 | + |
| 188 | + expect(OverlapRecordingMetricReader.maxInFlight).toBe(1); |
| 189 | + }); |
| 190 | + |
| 191 | + it("still shuts down the readers after one that fails", async () => { |
| 192 | + const recordingReader = new RecordingMetricReader(); |
| 193 | + |
| 194 | + const tracingSDK = new TracingSDK({ |
| 195 | + url: "http://localhost:1", |
| 196 | + forceFlushTimeoutMillis: 5_000, |
| 197 | + diagLogLevel: "none", |
| 198 | + metricReaders: [new FailingShutdownMetricReader(), recordingReader], |
| 199 | + }); |
| 200 | + |
| 201 | + await tracingSDK.shutdown().catch(() => {}); |
| 202 | + |
| 203 | + expect(recordingReader.shutdownCount).toBeGreaterThan(0); |
| 204 | + }); |
| 205 | +}); |
0 commit comments