@prairielearn/opentelemetry 1.5.2 → 1.7.0

package/src/metrics.test.ts

@@ -0,0 +1,86 @@
+import {
+  InMemoryMetricExporter,
+  AggregationTemporality,
+  MeterProvider,
+  PeriodicExportingMetricReader,
+  Histogram,
+} from '@opentelemetry/sdk-metrics';
+import { Meter } from '@opentelemetry/api';
+import chai, { assert } from 'chai';
+import chaiAsPromised from 'chai-as-promised';
+
+import { instrumentedWithMetrics } from './metrics';
+
+chai.use(chaiAsPromised);
+
+async function waitForMetricsExport(exporter: InMemoryMetricExporter) {
+  while (exporter.getMetrics().length === 0) {
+    await new Promise((resolve) => setTimeout(resolve, 50));
+  }
+}
+
+describe('instrumentedWithMetrics', () => {
+  let exporter: InMemoryMetricExporter;
+  let metricReader: PeriodicExportingMetricReader;
+  let meter: Meter;
+
+  beforeEach(async () => {
+    const meterProvider = new MeterProvider();
+    meter = meterProvider.getMeter('test');
+    exporter = new InMemoryMetricExporter(AggregationTemporality.DELTA);
+    metricReader = new PeriodicExportingMetricReader({
+      exporter: exporter,
+      exportIntervalMillis: 50,
+    });
+    meterProvider.addMetricReader(metricReader);
+  });
+
+  afterEach(async () => {
+    await exporter.shutdown();
+    await metricReader.shutdown();
+  });
+
+  it('records a histogram for the function duration', async () => {
+    await instrumentedWithMetrics(meter, 'test', async () => {});
+
+    await waitForMetricsExport(exporter);
+    const exportedMetrics = exporter.getMetrics();
+    const { scope, metrics } = exportedMetrics[0].scopeMetrics[0];
+    const [counterMetric, histogramMetric] = metrics;
+
+    assert.equal(scope.name, 'test');
+
+    assert.ok(counterMetric);
+    assert.equal(counterMetric.descriptor.name, 'test.error');
+    assert.lengthOf(counterMetric.dataPoints, 0);
+
+    assert.ok(histogramMetric);
+    assert.equal(histogramMetric.descriptor.name, 'test.duration');
+    assert.equal((histogramMetric.dataPoints[0].value as Histogram).count, 1);
+  });
+
+  it('records an error count', async () => {
+    await assert.isRejected(
+      instrumentedWithMetrics(meter, 'test', async () => {
+        throw new Error('error for test');
+      }),
+      'error for test'
+    );
+
+    await waitForMetricsExport(exporter);
+    const exportedMetrics = exporter.getMetrics();
+    const { metrics, scope } = exportedMetrics[0].scopeMetrics[0];
+    const [counterMetric, histogramMetric] = metrics;
+
+    assert.ok(scope);
+    assert.equal(scope.name, 'test');
+
+    assert.ok(counterMetric);
+    assert.equal(counterMetric.descriptor.name, 'test.error');
+    assert.equal(counterMetric.dataPoints[0].value, 1);
+
+    assert.ok(histogramMetric);
+    assert.equal(histogramMetric.descriptor.name, 'test.duration');
+    assert.equal((histogramMetric.dataPoints[0].value as Histogram).count, 1);
+  });
+});

package/src/metrics.ts

@@ -0,0 +1,93 @@
+import {
+  Meter,
+  ValueType,
+  MetricOptions,
+  Histogram,
+  Counter,
+  UpDownCounter,
+  ObservableCounter,
+  ObservableUpDownCounter,
+  ObservableGauge,
+} from '@opentelemetry/api';
+
+const histogramCache = new WeakMap<Meter, Map<string, Histogram>>();
+const counterCache = new WeakMap<Meter, Map<string, Counter>>();
+const upDownCounterCache = new WeakMap<Meter, Map<string, UpDownCounter>>();
+const observableCounterCache = new WeakMap<Meter, Map<string, ObservableCounter>>();
+const observableUpDownCounterCache = new WeakMap<Meter, Map<string, ObservableUpDownCounter>>();
+const observableGaugeCache = new WeakMap<Meter, Map<string, ObservableGauge>>();
+
+function getCachedMetric<T>(
+  cache: WeakMap<Meter, Map<string, T>>,
+  meter: Meter,
+  name: string,
+  create: () => T
+): T {
+  let meterCache = cache.get(meter);
+  if (!meterCache) {
+    meterCache = new Map();
+    cache.set(meter, meterCache);
+  }
+
+  let metric = meterCache.get(name);
+  if (!metric) {
+    metric = create();
+    meterCache.set(name, metric);
+  }
+
+  return metric;
+}
+
+export function getHistogram(meter: Meter, name: string, options?: MetricOptions): Histogram {
+  return getCachedMetric(histogramCache, meter, name, () => meter.createHistogram(name, options));
+}
+
+export function getCounter(meter: Meter, name: string, options?: MetricOptions) {
+  return getCachedMetric(counterCache, meter, name, () => meter.createCounter(name, options));
+}
+
+export function getUpDownCounter(meter: Meter, name: string, options?: MetricOptions) {
+  return getCachedMetric(upDownCounterCache, meter, name, () =>
+    meter.createUpDownCounter(name, options)
+  );
+}
+
+export function getObservableCounter(meter: Meter, name: string, options?: MetricOptions) {
+  return getCachedMetric(observableCounterCache, meter, name, () =>
+    meter.createObservableCounter(name, options)
+  );
+}
+
+export function getObservableUpDownCounter(meter: Meter, name: string, options?: MetricOptions) {
+  return getCachedMetric(observableUpDownCounterCache, meter, name, () =>
+    meter.createObservableUpDownCounter(name, options)
+  );
+}
+
+export function getObservableGauge(meter: Meter, name: string, options?: MetricOptions) {
+  return getCachedMetric(observableGaugeCache, meter, name, () =>
+    meter.createObservableGauge(name, options)
+  );
+}
+
+export async function instrumentedWithMetrics<T>(
+  meter: Meter,
+  name: string,
+  fn: () => Promise<T> | T
+): Promise<T> {
+  const error = getCounter(meter, `${name}.error`, { valueType: ValueType.INT });
+  const histogram = getHistogram(meter, `${name}.duration`, {
+    unit: 'milliseconds',
+    valueType: ValueType.DOUBLE,
+  });
+
+  const start = performance.now();
+  try {
+    return await fn();
+  } catch (e) {
+    error.add(1);
+    throw e;
+  } finally {
+    histogram.record(performance.now() - start);
+  }
+}

package/src/tracing.ts

@@ -0,0 +1,25 @@
+import { Span, SpanStatusCode, trace } from '@opentelemetry/api';
+
+export async function instrumented<T>(
+  name: string,
+  fn: (span: Span) => Promise<T> | T
+): Promise<T> {
+  return trace
+    .getTracer('default')
+    .startActiveSpan<(span: Span) => Promise<T>>(name, async (span) => {
+      try {
+        const result = await fn(span);
+        span.setStatus({ code: SpanStatusCode.OK });
+        return result;
+      } catch (e: any) {
+        span.setStatus({
+          code: SpanStatusCode.ERROR,
+          message: e.message,
+        });
+        span.recordException(e);
+        throw e;
+      } finally {
+        span.end();
+      }
+    });
+}

package/dist/index.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,sDAAkD;AAClD,+BAA8B;AAE9B,mCAA6E;AAC7E,4EAA8E;AAE9E,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,cAAwC,CAAC;IAC7C,IAAI,QAAQ,GAAG,IAAI,kBAAO,CAAC,oBAAoB,EAAE,CAAC;IAElD,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,IAAA,YAAI,EAAC;YACT,oBAAoB,EAAE,IAAI;YAC1B,qBAAqB,EAAE,QAAQ;YAC/B,wBAAwB,EAAE,WAAW;YACrC,0BAA0B,EAAE,QAAQ;SACrC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,cAAc,GAAG,IAAI,8CAAwB,EAAE,CAAC;QAChD,eAAO,CAAC,uBAAuB,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,QAAQ,CAAC,KAAK,EAAE,CAAC;QACjB,eAAO,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,GAAG,GAAG,MAAM,IAAA,oBAAY,EAAC,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QACpD,aAAM,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,IAAA,oBAAY,EAAC,cAAc,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC;QAEhD,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,aAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1B,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC5C,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAc,CAAC,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,IAAI,UAAU,GAAiB,IAAI,CAAC;QAEpC,IAAI;YACF,MAAM,IAAA,oBAAY,EAAC,cAAc,EAAE,GAAG,EAAE;gBACtC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;SACJ;QAAC,OAAO,GAAQ,EAAE;YACjB,UAAU,GAAG,GAAG,CAAC;SAClB;QAED,sDAAsD;QACtD,aAAM,CAAC,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAEzC,wCAAwC;QACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,gBAAgB,EAAE,CAAC;QAC1C,aAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC1B,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAC5C,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,sBAAc,CAAC,KAAK,CAAC,CAAC;QACzD,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC7C,aAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,MAAM,GAAG,aAAK,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC1C,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAClD,MAAM,aAAa,GAAG,aAAK,CAAC,OAAO,CAAC,eAAO,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;QAElE,MAAM,IAAA,oBAAY,EAAC,MAAM,EAAE,KAAK,IAAI,EAAE;YACpC,MAAM,YAAY,GAAG,eAAO,CAAC,MAAM,EAAE,CAAC;YACtC,aAAM,CAAC,cAAc,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}