@agoric/telemetry 0.6.3-u20.0 → 0.6.3-u21.0.1

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.6.3-u20.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.2...@agoric/telemetry@0.6.3-u20.0) (2025-04-16)
+### [0.6.3-u21.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/telemetry@0.6.2...@agoric/telemetry@0.6.3-u21.0) (2025-06-19)
 
 
 ### Features
@@ -24,9 +24,13 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 * ensure script main rejections exit with error ([abdab87](https://github.com/Agoric/agoric-sdk/commit/abdab879014a5c3124ebd0e9246995ac6b1ce6e5))
 * Properly synchronize slog sender termination ([f83c01d](https://github.com/Agoric/agoric-sdk/commit/f83c01d89d80798e0922acdb498fcc7250560977))
 * **telemetry:** add missing slog type ([1aec8d0](https://github.com/Agoric/agoric-sdk/commit/1aec8d05036f6b3c3e3730339d1829da6b4a9051))
+* **telemetry:** async flight recorder read ([b7a19dd](https://github.com/Agoric/agoric-sdk/commit/b7a19dd9c106d9b31e6f9188f5d4df0bbb5132bf))
 * **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:** Extend shutdown logic for slog-sender-pipe and otel-metrics ([7b8ccc8](https://github.com/Agoric/agoric-sdk/commit/7b8ccc82e641e5d11ccc6b8aebe524f75af829fe)), closes [#11175](https://github.com/Agoric/agoric-sdk/issues/11175)
+* **telemetry:** flight recorder flush does sync ([d270202](https://github.com/Agoric/agoric-sdk/commit/d2702028d77c06f3b4de91ca711a3c45c685a477))
+* **telemetry:** flight-recorder check second read size ([bfbacb2](https://github.com/Agoric/agoric-sdk/commit/bfbacb2b9f8de36f8f66b8cba8a88603fb7225e2))
 * **telemetry:** flight-recorder ignores write after shutdown ([3d2bcb3](https://github.com/Agoric/agoric-sdk/commit/3d2bcb3c56ac24a0f991200b223e6af8514dc5b8))
 * **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))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/telemetry",
-  "version": "0.6.3-u20.0",
+  "version": "0.6.3-u21.0.1",
   "description": "Agoric's telemetry implementation",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -11,9 +11,9 @@
     "test:c8": "c8 --all $C8_OPTIONS ava",
     "test:xs": "exit 0",
     "lint-fix": "yarn lint:eslint --fix",
-    "lint": "run-s --continue-on-error lint:*",
-    "lint:types": "tsc",
-    "lint:eslint": "eslint ."
+    "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
+    "lint:types": "yarn run -T tsc",
+    "lint:eslint": "yarn run -T eslint ."
   },
   "bin": {
     "frcat": "./src/frcat-entrypoint.js"
@@ -22,11 +22,12 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/internal": "^0.4.0-u20.0",
-    "@agoric/store": "^0.9.3-u20.0",
+    "@agoric/internal": "0.4.0-u21.0.1",
+    "@agoric/store": "0.9.3-u21.0.1",
     "@endo/errors": "^1.2.10",
     "@endo/init": "^1.1.9",
     "@endo/marshal": "^1.6.4",
+    "@endo/promise-kit": "^1.1.10",
     "@endo/stream": "^1.2.10",
     "@opentelemetry/api": "~1.9.0",
     "@opentelemetry/api-logs": "0.57.1",
@@ -39,21 +40,21 @@
     "@opentelemetry/sdk-trace-base": "~1.30.1",
     "@opentelemetry/semantic-conventions": "~1.28.0",
     "anylogger": "^0.21.0",
-    "better-sqlite3": "^9.1.1",
+    "better-sqlite3": "^10.1.0",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
     "@endo/lockdown": "^1.0.15",
     "@endo/ses-ava": "^1.2.10",
     "ava": "^5.3.0",
-    "c8": "^10.1.2",
+    "c8": "^10.1.3",
     "tmp": "^0.2.1"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
-    "node": "^18.12 || ^20.9"
+    "node": "^20.9 || ^22.11"
   },
   "ava": {
     "files": [
@@ -66,7 +67,7 @@
     "workerThreads": false
   },
   "typeCoverage": {
-    "atLeast": 88.87
+    "atLeast": 88.83
   },
-  "gitHead": "8e4207fa19dabf76c1f91f8779b5b5b93570ecea"
+  "gitHead": "16519b2de1eb2afda2b4ec866f55eadd4bb18223"
 }

package/src/flight-recorder.js

@@ -2,7 +2,6 @@
 /* eslint-env node */
 /// <reference types="ses" />
 
-import fs from 'node:fs';
 import fsp from 'node:fs/promises';
 import path from 'node:path';
 import { Fail } from '@endo/errors';
@@ -80,7 +79,7 @@ const initializeCircularBuffer = async (bufferFile, circularBufferSize) => {
  * @param {(record: Uint8Array, firstWriteLength: number, circEnd: bigint) => Promise<void>} writeRecord
  */
 function makeCircBufMethods(arenaSize, header, readRecord, writeRecord) {
-  const readCircBuf = (outbuf, offset = 0) => {
+  const readCircBuf = async (outbuf, offset = 0) => {
     offset + outbuf.byteLength <= arenaSize ||
       Fail`Reading past end of circular buffer`;
 
@@ -102,7 +101,7 @@ function makeCircBufMethods(arenaSize, header, readRecord, writeRecord) {
       // The data is contiguous, like ---AAABBB---
       return { done: true, value: undefined };
     }
-    readRecord(outbuf, readStart, firstReadLength);
+    await readRecord(outbuf, readStart, firstReadLength);
     return { done: false, value: outbuf };
   };
 
@@ -146,9 +145,10 @@ function makeCircBufMethods(arenaSize, header, readRecord, writeRecord) {
 
     // Advance the start pointer until we have space to write the record.
     let overlap = BigInt(record.byteLength) - capacity;
+    await null;
     while (overlap > 0n) {
       const startRecordLength = new Uint8Array(RECORD_HEADER_SIZE);
-      const { done } = readCircBuf(startRecordLength);
+      const { done } = await readCircBuf(startRecordLength);
       if (done) {
         break;
       }
@@ -224,20 +224,22 @@ export const makeSimpleCircularBuffer = async ({
   arenaSize === hdrArenaSize ||
     Fail`${filename} arena size mismatch; wanted ${arenaSize}, got ${hdrArenaSize}`;
 
-  /** @type {(outbuf: Uint8Array, readStart: number, firstReadLength: number) => void} */
-  const readRecord = (outbuf, readStart, firstReadLength) => {
-    const bytesRead = fs.readSync(file.fd, outbuf, {
+  /** @type {(outbuf: Uint8Array, readStart: number, firstReadLength: number) => Promise<void>} */
+  const readRecord = async (outbuf, readStart, firstReadLength) => {
+    const { bytesRead } = await file.read(outbuf, {
       length: firstReadLength,
       position: Number(readStart) + I_ARENA_START,
     });
     assert.equal(bytesRead, firstReadLength, 'Too few bytes read');
 
     if (bytesRead < outbuf.byteLength) {
-      fs.readSync(file.fd, outbuf, {
+      const length = outbuf.byteLength - firstReadLength;
+      const { bytesRead: bytesRead2 } = await file.read(outbuf, {
         offset: firstReadLength,
-        length: outbuf.byteLength - firstReadLength,
+        length,
         position: I_ARENA_START,
       });
+      assert.equal(bytesRead2, length, 'Too few bytes read');
     }
   };
 
@@ -294,6 +296,7 @@ export const makeSlogSenderFromBuffer = ({ fileHandle, writeCircBuf }) => {
   return Object.assign(writeJSON, {
     forceFlush: async () => {
       await toWrite;
+      await fileHandle.datasync();
     },
     shutdown: async () => {
       const lastWritten = toWrite;

package/src/frcat-entrypoint.js

@@ -22,7 +22,7 @@ const main = async () => {
     let offset = 0;
     for (;;) {
       const lenBuf = new Uint8Array(BigUint64Array.BYTES_PER_ELEMENT);
-      const { done } = readCircBuf(lenBuf, offset);
+      const { done } = await readCircBuf(lenBuf, offset);
       if (done) {
         break;
       }
@@ -30,7 +30,7 @@ const main = async () => {
       const dv = new DataView(lenBuf.buffer);
       const len = Number(dv.getBigUint64(0));
 
-      const { done: done2, value: buf } = readCircBuf(
+      const { done: done2, value: buf } = await readCircBuf(
         new Uint8Array(len),
         offset,
       );

package/src/otel-metrics.js

@@ -10,7 +10,8 @@ import {
 } from '@agoric/internal/src/metrics.js';
 
 /**
- * @import {MeterProvider, MetricOptions, ObservableCounter, ObservableUpDownCounter} from '@opentelemetry/api';
+ * @import {MetricOptions, ObservableCounter, ObservableUpDownCounter} from '@opentelemetry/api';
+ * @import {MeterProvider} from '@opentelemetry/sdk-metrics';
  * @import {TotalMap} from '@agoric/internal';
  */
 
@@ -22,6 +23,10 @@ export const makeSlogSender = async (opts = /** @type {any} */ ({})) => {
   if (!otelMeterName) throw Fail`OTel meter name is required`;
   if (!otelMeterProvider) return;
 
+  const shutdown = async () => {
+    await otelMeterProvider.shutdown();
+  };
+
   const otelMeter = otelMeterProvider.getMeter(otelMeterName);
 
   const processedInboundActionCounter = otelMeter.createCounter(
@@ -218,6 +223,7 @@ export const makeSlogSender = async (opts = /** @type {any} */ ({})) => {
     }
   };
   return Object.assign(slogSender, {
+    shutdown,
     usesJsonObject: false,
   });
 };

package/src/slog-sender-pipe.js

@@ -12,6 +12,7 @@ import { promisify } from 'util';
 import anylogger from 'anylogger';
 
 import { q, Fail } from '@endo/errors';
+import { makePromiseKit } from '@endo/promise-kit';
 import { makeQueue } from '@endo/stream';
 
 import { makeShutdown } from '@agoric/internal/src/node/shutdown.js';
@@ -72,6 +73,16 @@ export const makeSlogSender = async options => {
     env,
   });
   // logger.log('done fork');
+
+  const exitKit = makePromiseKit();
+  cp.on('error', error => {
+    // An exit event *might* be coming, so wait a tick.
+    setImmediate(() => exitKit.resolve({ error }));
+  });
+  cp.on('exit', (exitCode, signal) => {
+    exitKit.resolve({ exitCode, signal });
+  });
+
   /** @type {(msg: Record<string, unknown> & {type: string}) => Promise<void>} */
   const rawSend = promisify(cp.send.bind(cp));
   const pipeSend = withMutex(rawSend);
@@ -132,6 +143,7 @@ export const makeSlogSender = async options => {
 
     await flush();
     cp.disconnect();
+    await exitKit.promise;
   };
   registerShutdown(shutdown);
 

package/test/flight-recorder.test.js

@@ -1,5 +1,4 @@
 import fs from 'node:fs';
-import { promisify } from 'node:util';
 import tmp from 'tmp';
 import { test } from './prepare-test-env-ava.js';
 
@@ -13,21 +12,16 @@ const bufferTests = test.macro(
   /**
    *
    * @param {*} t
-   * @param {{makeBuffer: Function}} input
+   * @param {{makeBuffer: typeof makeSimpleCircularBuffer}} input
    */
   async (t, input) => {
     const BUFFER_SIZE = 512;
 
-    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 { name: tmpFile, removeCallback } = tmp.fileSync({
+      discardDescriptor: true,
     });
-    const { readCircBuf, writeCircBuf } = await input.makeBuffer({
+    t.teardown(removeCallback);
+    const { fileHandle, readCircBuf, writeCircBuf } = await input.makeBuffer({
       circularBufferSize: BUFFER_SIZE,
       circularBufferFilename: tmpFile,
     });
@@ -55,11 +49,11 @@ const bufferTests = test.macro(
     t.is(fs.readFileSync(tmpFile, { encoding: 'utf8' }).length, BUFFER_SIZE);
 
     const len0 = new Uint8Array(BigUint64Array.BYTES_PER_ELEMENT);
-    const { done: done0 } = readCircBuf(len0);
+    const { done: done0 } = await readCircBuf(len0);
     t.false(done0, 'readCircBuf should not be done');
     const dv0 = new DataView(len0.buffer);
     const buf0 = new Uint8Array(Number(dv0.getBigUint64(0)));
-    const { done: done0b } = readCircBuf(buf0, len0.byteLength);
+    const { done: done0b } = await readCircBuf(buf0, len0.byteLength);
     t.false(done0b, 'readCircBuf should not be done');
     const buf0Str = new TextDecoder().decode(buf0);
     t.is(buf0Str, `\n{"type":"start"}`, `start compare failed`);
@@ -78,12 +72,12 @@ const bufferTests = test.macro(
     let offset = 0;
     const len1 = new Uint8Array(BigUint64Array.BYTES_PER_ELEMENT);
     for (let i = 490; i < last; i += 1) {
-      const { done: done1 } = readCircBuf(len1, offset);
+      const { done: done1 } = await readCircBuf(len1, offset);
       offset += len1.byteLength;
       t.false(done1, `readCircBuf ${i} should not be done`);
       const dv1 = new DataView(len1.buffer);
       const buf1 = new Uint8Array(Number(dv1.getBigUint64(0)));
-      const { done: done1b } = readCircBuf(buf1, offset);
+      const { done: done1b } = await readCircBuf(buf1, offset);
       offset += buf1.byteLength;
       t.false(done1b, `readCircBuf ${i} should not be done`);
       const buf1Str = new TextDecoder().decode(buf1);
@@ -94,7 +88,7 @@ const bufferTests = test.macro(
       );
     }
 
-    const { done: done2 } = readCircBuf(len1, offset);
+    const { done: done2 } = await readCircBuf(len1, offset);
     t.assert(done2, `readCircBuf ${last} should be done`);
 
     slogSender(null, 'PRE-SERIALIZED');