@agoric/telemetry 0.6.3-upgrade-18a-dev-4ee0508.0 → 0.6.3-upgrade-19-dev-aa5fa27.0

package/CHANGELOG.md

@@ -3,55 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.6.3-u18a.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u18.4...@agoric/telemetry@0.6.3-u18a.0) (2025-02-07)
-
-**Note:** Version bump only for package @agoric/telemetry
-
-
-
-
-
-### [0.6.3-u18.4](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u18.3...@agoric/telemetry@0.6.3-u18.4) (2024-12-24)
-
-
-### Bug Fixes
-
-* **telemetry:** add missing slog type ([1aec8d0](https://github.com/Agoric/agoric-sdk/commit/1aec8d05036f6b3c3e3730339d1829da6b4a9051))
-* **telemetry:** Empty context persisted when remaining beans are negative after run finish ([#10635](https://github.com/Agoric/agoric-sdk/issues/10635)) ([ad4e83e](https://github.com/Agoric/agoric-sdk/commit/ad4e83e0b6dff9716da91fd65d367d3acad1772e))
-* **telemetry:** event name typo ([9e19321](https://github.com/Agoric/agoric-sdk/commit/9e19321ea8fed32d445d44169b32f5d94a93d61e))
-* **telemetry:** timer-poll run.id ([#10672](https://github.com/Agoric/agoric-sdk/issues/10672)) ([3b478fb](https://github.com/Agoric/agoric-sdk/commit/3b478fb9e3fe7ded8dec1e83bab68760571f9071)), closes [#10357](https://github.com/Agoric/agoric-sdk/issues/10357) [#10357](https://github.com/Agoric/agoric-sdk/issues/10357)
-
-
-
-### [0.6.3-u18.3](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u18.2...@agoric/telemetry@0.6.3-u18.3) (2024-12-13)
+### [0.6.3-u19.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u19.0...@agoric/telemetry@0.6.3-u19.1) (2025-03-03)
 
 
 ### Bug Fixes
 
-* **telemetry:** timer-poll run.id ([#10672](https://github.com/Agoric/agoric-sdk/issues/10672)) ([4185e77](https://github.com/Agoric/agoric-sdk/commit/4185e77aec0babcb00057ff35ea7d8ec3f631976)), closes [#10357](https://github.com/Agoric/agoric-sdk/issues/10357) [#10357](https://github.com/Agoric/agoric-sdk/issues/10357)
+* Properly synchronize slog sender termination ([2fc342c](https://github.com/Agoric/agoric-sdk/commit/2fc342c180e296208d077a1d4799da139d3b7848))
 
 
 
-### [0.6.3-u18.2](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u18.1...@agoric/telemetry@0.6.3-u18.2) (2024-12-09)
-
-
-### Bug Fixes
-
-* **telemetry:** Empty context persisted when remaining beans are negative after run finish ([#10635](https://github.com/Agoric/agoric-sdk/issues/10635)) ([3988aa0](https://github.com/Agoric/agoric-sdk/commit/3988aa0f0708e367629aca30fe5d09f760ed3ef1))
-* **telemetry:** event name typo ([070b154](https://github.com/Agoric/agoric-sdk/commit/070b154b273748fcc087a012009f70457b4a5d2d))
-
-
-
-### [0.6.3-u18.1](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.3-u18.0...@agoric/telemetry@0.6.3-u18.1) (2024-11-19)
-
-
-### Bug Fixes
-
-* **telemetry:** add missing slog type ([6c500d4](https://github.com/Agoric/agoric-sdk/commit/6c500d4c0c5a329ffbf8a35d6e3754b58578075c))
-
-
-
-### [0.6.3-u18.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.2...@agoric/telemetry@0.6.3-u18.0) (2024-10-31)
+### [0.6.3-u19.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.2...@agoric/telemetry@0.6.3-u19.0) (2025-02-24)
 
 
 ### Features
@@ -67,11 +28,15 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 ### Bug Fixes
 
 * ensure script main rejections exit with error ([abdab87](https://github.com/Agoric/agoric-sdk/commit/abdab879014a5c3124ebd0e9246995ac6b1ce6e5))
+* **telemetry:** add missing slog type ([1aec8d0](https://github.com/Agoric/agoric-sdk/commit/1aec8d05036f6b3c3e3730339d1829da6b4a9051))
 * **telemetry:** avoid polluting stdout in ingest-slog ([d4b8dfa](https://github.com/Agoric/agoric-sdk/commit/d4b8dfa91155789f7ceda5cc3cef06019b9527e7))
+* **telemetry:** Empty context persisted when remaining beans are negative after run finish ([#10635](https://github.com/Agoric/agoric-sdk/issues/10635)) ([ad4e83e](https://github.com/Agoric/agoric-sdk/commit/ad4e83e0b6dff9716da91fd65d367d3acad1772e))
+* **telemetry:** event name typo ([9e19321](https://github.com/Agoric/agoric-sdk/commit/9e19321ea8fed32d445d44169b32f5d94a93d61e))
 * **telemetry:** handle new trigger slog events ([d32cb7e](https://github.com/Agoric/agoric-sdk/commit/d32cb7e9f406c25399321dc32e827b5018c38b69))
 * **telemetry:** ingest-slog avoid writing progress file for stdin ([62589ca](https://github.com/Agoric/agoric-sdk/commit/62589ca7b6d4aaa9eb7042f95ec7aec633db27f9))
 * **telemetry:** otel correctly pop upgrade span ([0ffdf00](https://github.com/Agoric/agoric-sdk/commit/0ffdf001bc8cbdc94081fedfeb4d2376902f4ffc)), closes [#8272](https://github.com/Agoric/agoric-sdk/issues/8272) [#9569](https://github.com/Agoric/agoric-sdk/issues/9569)
 * **telemetry:** silence slogfile write errors ([91089d7](https://github.com/Agoric/agoric-sdk/commit/91089d7273ef3d41555b34d84471120d45602497))
+* **telemetry:** timer-poll run.id ([#10672](https://github.com/Agoric/agoric-sdk/issues/10672)) ([3b478fb](https://github.com/Agoric/agoric-sdk/commit/3b478fb9e3fe7ded8dec1e83bab68760571f9071)), closes [#10357](https://github.com/Agoric/agoric-sdk/issues/10357) [#10357](https://github.com/Agoric/agoric-sdk/issues/10357)
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/telemetry",
-  "version": "0.6.3-upgrade-18a-dev-4ee0508.0+4ee0508",
+  "version": "0.6.3-upgrade-19-dev-aa5fa27.0+aa5fa27",
   "description": "Agoric's telemetry implementation",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -22,29 +22,29 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/internal": "0.4.0-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@agoric/store": "0.9.3-upgrade-18a-dev-4ee0508.0+4ee0508",
-    "@endo/errors": "^1.2.8",
-    "@endo/init": "^1.1.7",
-    "@endo/marshal": "^1.6.2",
-    "@endo/stream": "^1.2.8",
-    "@opentelemetry/api": "~1.3.0",
-    "@opentelemetry/api-logs": "0.53.0",
-    "@opentelemetry/exporter-logs-otlp-http": "0.53.0",
-    "@opentelemetry/exporter-prometheus": "~0.35.0",
-    "@opentelemetry/exporter-trace-otlp-http": "~0.35.0",
-    "@opentelemetry/resources": "~1.9.0",
-    "@opentelemetry/sdk-logs": "0.53.0",
-    "@opentelemetry/sdk-metrics": "~1.9.0",
-    "@opentelemetry/sdk-trace-base": "~1.9.0",
-    "@opentelemetry/semantic-conventions": "~1.27.0",
+    "@agoric/internal": "0.4.0-upgrade-19-dev-aa5fa27.0+aa5fa27",
+    "@agoric/store": "0.9.3-upgrade-19-dev-aa5fa27.0+aa5fa27",
+    "@endo/errors": "^1.2.9",
+    "@endo/init": "^1.1.8",
+    "@endo/marshal": "^1.6.3",
+    "@endo/stream": "^1.2.9",
+    "@opentelemetry/api": "~1.9.0",
+    "@opentelemetry/api-logs": "0.57.1",
+    "@opentelemetry/exporter-logs-otlp-http": "0.57.1",
+    "@opentelemetry/exporter-prometheus": "~0.57.1",
+    "@opentelemetry/exporter-trace-otlp-http": "0.57.1",
+    "@opentelemetry/resources": "~1.30.1",
+    "@opentelemetry/sdk-logs": "0.57.1",
+    "@opentelemetry/sdk-metrics": "~1.30.1",
+    "@opentelemetry/sdk-trace-base": "~1.30.1",
+    "@opentelemetry/semantic-conventions": "~1.28.0",
     "anylogger": "^0.21.0",
     "better-sqlite3": "^9.1.1",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@endo/lockdown": "^1.0.13",
-    "@endo/ses-ava": "^1.2.8",
+    "@endo/lockdown": "^1.0.14",
+    "@endo/ses-ava": "^1.2.9",
     "ava": "^5.3.0",
     "c8": "^10.1.2",
     "tmp": "^0.2.1"
@@ -68,5 +68,5 @@
   "typeCoverage": {
     "atLeast": 88.88
   },
-  "gitHead": "4ee05088e5ada989a866a11ff65838d395505ce6"
+  "gitHead": "aa5fa276b7fb72283263b4ab05d7dec3807fa50c"
 }

package/src/flight-recorder.js

@@ -8,6 +8,10 @@ import path from 'node:path';
 import { Fail } from '@endo/errors';
 import { serializeSlogObj } from './serialize-slog-obj.js';
 
+/**
+ * @import {EReturn} from '@endo/far';
+ */
+
 export const DEFAULT_CBUF_SIZE = 100 * 1024 * 1024;
 export const DEFAULT_CBUF_FILE = 'flight-recorder.bin';
 export const SLOG_MAGIC = 0x41472d534c4f4721n; // 'AG-SLOG!'
@@ -63,7 +67,7 @@ const initializeCircularBuffer = async (bufferFile, circularBufferSize) => {
   return arenaSize;
 };
 
-/** @typedef {Awaited<ReturnType<typeof makeSimpleCircularBuffer>>} CircularBuffer */
+/** @typedef {EReturn<typeof makeSimpleCircularBuffer>} CircularBuffer */
 
 /**
  *
@@ -72,7 +76,7 @@ const initializeCircularBuffer = async (bufferFile, circularBufferSize) => {
  * @param {(outbuf: Uint8Array, readStart: number, firstReadLength: number) => void} readRecord
  * @param {(record: Uint8Array, firstWriteLength: number, circEnd: bigint) => Promise<void>} writeRecord
  */
-function finishCircularBuffer(arenaSize, header, readRecord, writeRecord) {
+function makeCircBufMethods(arenaSize, header, readRecord, writeRecord) {
   const readCircBuf = (outbuf, offset = 0) => {
     offset + outbuf.byteLength <= arenaSize ||
       Fail`Reading past end of circular buffer`;
@@ -265,14 +269,17 @@ export const makeSimpleCircularBuffer = async ({
     await file.write(headerBuffer, undefined, undefined, 0);
   };
 
-  return finishCircularBuffer(arenaSize, header, readRecord, writeRecord);
+  return {
+    fileHandle: file,
+    ...makeCircBufMethods(arenaSize, header, readRecord, writeRecord),
+  };
 };
 
 /**
  *
- * @param {Pick<Awaited<ReturnType<typeof makeSimpleCircularBuffer>>, 'writeCircBuf'>} circBuf
+ * @param {Pick<CircularBuffer, 'fileHandle' | 'writeCircBuf'>} circBuf
  */
-export const makeSlogSenderFromBuffer = ({ writeCircBuf }) => {
+export const makeSlogSenderFromBuffer = ({ fileHandle, writeCircBuf }) => {
   /** @type {Promise<void>} */
   let toWrite = Promise.resolve();
   const writeJSON = (obj, serialized = serializeSlogObj(obj)) => {
@@ -285,6 +292,10 @@ export const makeSlogSenderFromBuffer = ({ writeCircBuf }) => {
     forceFlush: async () => {
       await toWrite;
     },
+    shutdown: async () => {
+      await toWrite;
+      await fileHandle.close();
+    },
     usesJsonObject: true,
   });
 };
@@ -295,6 +306,6 @@ export const makeSlogSenderFromBuffer = ({ writeCircBuf }) => {
  * @type {import('./index.js').MakeSlogSender}
  */
 export const makeSlogSender = async opts => {
-  const { writeCircBuf } = await makeSimpleCircularBuffer(opts);
-  return makeSlogSenderFromBuffer({ writeCircBuf });
+  const { fileHandle, writeCircBuf } = await makeSimpleCircularBuffer(opts);
+  return makeSlogSenderFromBuffer({ fileHandle, writeCircBuf });
 };

package/src/index.js

@@ -34,7 +34,10 @@ export const tryFlushSlogSender = async (
   slogSender,
   { env = {}, log } = {},
 ) => {
-  await Promise.resolve(slogSender?.forceFlush?.()).catch(err => {
+  await null;
+  try {
+    await slogSender?.forceFlush?.();
+  } catch (err) {
     log?.('Failed to flush slog sender', err);
     if (err.errors) {
       for (const error of err.errors) {
@@ -44,7 +47,7 @@ export const tryFlushSlogSender = async (
     if (env.SLOGSENDER_FAIL_ON_ERROR) {
       throw err;
     }
-  });
+  }
 };
 
 export const getResourceAttributes = ({
@@ -111,6 +114,7 @@ const getPrometheusMeterProvider = ({
   const exporter = new PrometheusExporter(
     {
       port,
+      appendTimestamp: true,
     },
     () => {
       console.warn(

package/src/make-slog-sender.js

@@ -158,15 +158,15 @@ export const makeSlogSender = async (opts = {}) => {
       }
     };
     return Object.assign(slogSender, {
-      forceFlush: async () =>
-        PromiseAllOrErrors([
+      forceFlush: async () => {
+        await PromiseAllOrErrors([
           ...senders.map(sender => sender.forceFlush?.()),
           ...sendErrors.splice(0).map(err => Promise.reject(err)),
-        ]).then(() => {}),
-      shutdown: async () =>
-        PromiseAllOrErrors(senders.map(sender => sender.shutdown?.())).then(
-          () => {},
-        ),
+        ]);
+      },
+      shutdown: async () => {
+        await PromiseAllOrErrors(senders.map(sender => sender.shutdown?.()));
+      },
       usesJsonObject: hasSenderUsingJsonObj,
     });
   }

package/src/otel-trace.js

@@ -22,16 +22,26 @@ export const SPAN_EXPORT_DELAY_MS = 1_000;
 export const makeOtelTracingProvider = opts => {
   const { env = process.env } = opts || {};
 
+  // https://opentelemetry.io/docs/concepts/signals/
+  // https://opentelemetry.io/docs/specs/otel/protocol/exporter/#endpoint-urls-for-otlphttp
+  // https://github.com/open-telemetry/opentelemetry-js/blob/experimental/v0.57.1/experimental/packages/exporter-trace-otlp-http/README.md#configuration-options-as-environment-variables
   const { OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT } =
     env;
   if (!OTEL_EXPORTER_OTLP_ENDPOINT && !OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) {
+    console.debug(
+      'Not enabling OTLP Traces Exporter; enable with OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=<target URL> or OTEL_EXPORTER_OTLP_ENDPOINT=<target URL prefix>',
+    );
     return undefined;
   }
 
   const resource = new Resource(getResourceAttributes(opts));
 
   const exporter = new OTLPTraceExporter();
-  console.info('Enabling OTLP Traces Exporter to', exporter.getDefaultUrl({}));
+  console.info(
+    'Enabling OTLP Traces Exporter to',
+    OTEL_EXPORTER_OTLP_TRACES_ENDPOINT ||
+      `${OTEL_EXPORTER_OTLP_ENDPOINT}/v1/traces`,
+  );
 
   const provider = new BasicTracerProvider({ resource });
   provider.addSpanProcessor(

package/test/flight-recorder.test.js

@@ -1,4 +1,5 @@
 import fs from 'node:fs';
+import { promisify } from 'node:util';
 import tmp from 'tmp';
 import { test } from './prepare-test-env-ava.js';
 
@@ -17,12 +18,21 @@ const bufferTests = test.macro(
   async (t, input) => {
     const BUFFER_SIZE = 512;
 
-    const { name: tmpFile, removeCallback } = tmp.fileSync();
+    const {
+      name: tmpFile,
+      fd,
+      removeCallback,
+    } = tmp.fileSync({ detachDescriptor: true });
+    t.teardown(removeCallback);
+    const fileHandle = /** @type {import('fs/promises').FileHandle} */ ({
+      close: promisify(fs.close.bind(fs, fd)),
+    });
     const { readCircBuf, writeCircBuf } = await input.makeBuffer({
       circularBufferSize: BUFFER_SIZE,
       circularBufferFilename: tmpFile,
     });
-    const slogSender = makeSlogSenderFromBuffer({ writeCircBuf });
+    const slogSender = makeSlogSenderFromBuffer({ fileHandle, writeCircBuf });
+    t.teardown(slogSender.shutdown);
     slogSender({ type: 'start' });
     await slogSender.forceFlush();
     t.is(fs.readFileSync(tmpFile, { encoding: 'utf8' }).length, BUFFER_SIZE);
@@ -73,8 +83,6 @@ const bufferTests = test.macro(
     slogSender(null, 'PRE-SERIALIZED');
     await slogSender.forceFlush();
     t.truthy(fs.readFileSync(tmpFile).includes('PRE-SERIALIZED'));
-    // console.log({ tmpFile });
-    removeCallback();
   },
 );