@agoric/telemetry 0.6.3-other-dev-3eb1a1d.0 → 0.6.3-other-dev-d15096d.0.d15096d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/telemetry",
-  "version": "0.6.3-other-dev-3eb1a1d.0+3eb1a1d",
+  "version": "0.6.3-other-dev-d15096d.0.d15096d",
   "description": "Agoric's telemetry implementation",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -8,12 +8,12 @@
   "scripts": {
     "build": "exit 0",
     "test": "ava",
-    "test:c8": "c8 --all $C8_OPTIONS ava",
+    "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,38 +22,39 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/internal": "0.3.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@agoric/store": "0.9.3-other-dev-3eb1a1d.0+3eb1a1d",
-    "@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.3.3-other-dev-d15096d.0.d15096d",
+    "@agoric/store": "0.9.3-other-dev-d15096d.0.d15096d",
+    "@endo/errors": "^1.2.13",
+    "@endo/init": "^1.1.12",
+    "@endo/marshal": "^1.8.0",
+    "@endo/promise-kit": "^1.1.13",
+    "@endo/stream": "^1.2.13",
+    "@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",
+    "better-sqlite3": "^10.1.0",
     "tmp": "^0.2.1"
   },
   "devDependencies": {
-    "@endo/lockdown": "^1.0.13",
-    "@endo/ses-ava": "^1.2.8",
+    "@endo/lockdown": "^1.0.18",
+    "@endo/ses-ava": "^1.3.2",
     "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": 89.28
   },
-  "gitHead": "3eb1a1d2d75b2b4a94807cd3bf759bc9fc531f05"
+  "gitHead": "d15096dc4ff8b96e9b6cd11954c20d3a9efbb393"
 }

package/src/context-aware-slog-file.js

@@ -5,7 +5,12 @@ import { makeContextualSlogProcessor } from './context-aware-slog.js';
 import { serializeSlogObj } from './serialize-slog-obj.js';
 
 /**
- * @param {import('./index.js').MakeSlogSenderOptions} options
+ * @import {MakeSlogSenderOptions} from './index.js';
+ * @import {Slog} from './context-aware-slog.js';
+ */
+
+/**
+ * @param {MakeSlogSenderOptions} options
  */
 export const makeSlogSender = async options => {
   const { CHAIN_ID, CONTEXTUAL_SLOGFILE } = options.env || {};
@@ -26,7 +31,7 @@ export const makeSlogSender = async options => {
   });
 
   /**
-   * @param {import('./context-aware-slog.js').Slog} slog
+   * @param {Slog} slog
    */
   const slogSender = slog => {
     const contextualizedSlog = contextualSlogProcessor(slog);

package/src/context-aware-slog.js

@@ -135,9 +135,9 @@ export const makeContextualSlogProcessor = (
 
   /**
    * @param {Slog} slog
-   * @returns {{ attributes: T & LogAttributes, body: Partial<Slog>; timestamp: Slog['time'] }}
+   * @returns {{ attributes: T & LogAttributes, body: Partial<Slog>; time: Slog['time'] }}
    */
-  const slogProcessor = ({ monotime, time: timestamp, ...body }) => {
+  const slogProcessor = ({ monotime, time, ...body }) => {
     const finalBody = { ...body };
 
     /** @type {{'crank.syscallNum'?: Slog['syscallNum']}} */
@@ -219,7 +219,7 @@ export const makeContextualSlogProcessor = (
 
         triggerContext = {
           'run.num': undefined,
-          'run.id': `${triggerType}-${finalBody.inboundNum}`,
+          'run.id': `${triggerType}-${finalBody.blockHeight}`,
           'run.trigger.type': triggerType,
           'run.trigger.time': finalBody.blockTime,
           'run.trigger.blockHeight': finalBody.blockHeight,
@@ -321,13 +321,13 @@ export const makeContextualSlogProcessor = (
 
     const logAttributes = {
       ...staticContext,
-      'process.uptime': monotime,
       ...initContext, // Optional prelude
       ...blockContext, // Block is the first level of execution nesting
       ...triggerContext, // run and trigger info is nested next
       ...crankContext, // Finally cranks are the last level of nesting
       ...replayContext, // Replay is a substitute for crank context during vat page in
       ...eventLogAttributes,
+      'process.uptime': monotime,
     };
 
     /**
@@ -356,7 +356,11 @@ export const makeContextualSlogProcessor = (
       // eslint-disable-next-line no-restricted-syntax
       case SLOG_TYPES.COSMIC_SWINGSET.RUN.FINISH: {
         assert(!!triggerContext);
-        persistContext(finalBody.remainingBeans ? {} : triggerContext);
+        persistContext(
+          finalBody.remainingBeans && finalBody.remainingBeans > 0
+            ? {}
+            : triggerContext,
+        );
         triggerContext = null;
         break;
       }
@@ -373,9 +377,9 @@ export const makeContextualSlogProcessor = (
     }
 
     return {
-      attributes: /** @type {T & LogAttributes} */ (logAttributes),
       body: finalBody,
-      timestamp,
+      attributes: /** @type {T & LogAttributes} */ (logAttributes),
+      time,
     };
   };
 

package/src/flight-recorder.js

@@ -2,12 +2,16 @@
 /* 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';
 import { serializeSlogObj } from './serialize-slog-obj.js';
 
+/**
+ * @import {EReturn} from '@endo/far';
+ * @import {MakeSlogSender} from './index.js';
+ */
+
 export const DEFAULT_CBUF_SIZE = 100 * 1024 * 1024;
 export const DEFAULT_CBUF_FILE = 'flight-recorder.bin';
 export const SLOG_MAGIC = 0x41472d534c4f4721n; // 'AG-SLOG!'
@@ -35,6 +39,9 @@ const initializeCircularBuffer = async (bufferFile, circularBufferSize) => {
     }
     throw e;
   });
+
+  // Use the default size if not provided and file doesn't exist.
+  circularBufferSize = circularBufferSize || stbuf?.size || DEFAULT_CBUF_SIZE;
   const arenaSize = BigInt(circularBufferSize - I_ARENA_START);
 
   if (stbuf && stbuf.size >= I_ARENA_START) {
@@ -63,7 +70,7 @@ const initializeCircularBuffer = async (bufferFile, circularBufferSize) => {
   return arenaSize;
 };
 
-/** @typedef {Awaited<ReturnType<typeof makeSimpleCircularBuffer>>} CircularBuffer */
+/** @typedef {EReturn<typeof makeSimpleCircularBuffer>} CircularBuffer */
 
 /**
  *
@@ -72,8 +79,8 @@ 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) {
-  const readCircBuf = (outbuf, offset = 0) => {
+function makeCircBufMethods(arenaSize, header, readRecord, writeRecord) {
+  const readCircBuf = async (outbuf, offset = 0) => {
     offset + outbuf.byteLength <= arenaSize ||
       Fail`Reading past end of circular buffer`;
 
@@ -95,7 +102,7 @@ function finishCircularBuffer(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 };
   };
 
@@ -139,9 +146,10 @@ function finishCircularBuffer(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;
       }
@@ -217,20 +225,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');
     }
   };
 
@@ -265,25 +275,35 @@ 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 }) => {
-  /** @type {Promise<void>} */
+export const makeSlogSenderFromBuffer = ({ fileHandle, writeCircBuf }) => {
+  /** @type {Promise<void> | undefined} */
   let toWrite = Promise.resolve();
   const writeJSON = (obj, serialized = serializeSlogObj(obj)) => {
     // Prepend a newline so that the file can be more easily manipulated.
     const data = new TextEncoder().encode(`\n${serialized}`);
     // console.log('have obj', obj, data);
-    toWrite = toWrite.then(() => writeCircBuf(data));
+    toWrite = toWrite?.then(() => writeCircBuf(data));
   };
   return Object.assign(writeJSON, {
     forceFlush: async () => {
       await toWrite;
+      await fileHandle.datasync();
+    },
+    shutdown: async () => {
+      const lastWritten = toWrite;
+      toWrite = undefined;
+      await lastWritten;
+      await fileHandle.close();
     },
     usesJsonObject: true,
   });
@@ -292,9 +312,9 @@ export const makeSlogSenderFromBuffer = ({ writeCircBuf }) => {
 /**
  * Loaded dynamically by makeSlogSender()
  *
- * @type {import('./index.js').MakeSlogSender}
+ * @type {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/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/index.js

@@ -4,6 +4,12 @@ import { PrometheusExporter } from '@opentelemetry/exporter-prometheus';
 import { Resource } from '@opentelemetry/resources';
 import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
 
+/**
+ * @import {MakeSlogSenderOptions} from './index.js';
+ * @import {ResourceAttributes} from '@opentelemetry/resources';
+ * @import {View} from '@opentelemetry/sdk-metrics';
+ */
+
 export * from './make-slog-sender.js';
 
 /**
@@ -14,7 +20,7 @@ export * from './make-slog-sender.js';
  * }} SlogSender
  */
 /**
- * @typedef {(opts: import('./index.js').MakeSlogSenderOptions) => SlogSender | undefined} MakeSlogSender
+ * @typedef {(opts: MakeSlogSenderOptions) => Promise<SlogSender | undefined>} MakeSlogSender
  */
 /**
  * @typedef {MakeSlogSenderCommonOptions & Record<string, unknown>} MakeSlogSenderOptions
@@ -34,7 +40,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 +53,7 @@ export const tryFlushSlogSender = async (
     if (env.SLOGSENDER_FAIL_ON_ERROR) {
       throw err;
     }
-  });
+  }
 };
 
 export const getResourceAttributes = ({
@@ -53,7 +62,7 @@ export const getResourceAttributes = ({
 }) => {
   const { OTEL_RESOURCE_ATTRIBUTES, SDK_REVISION } = env;
 
-  /** @type {import('@opentelemetry/resources').ResourceAttributes} */
+  /** @type {ResourceAttributes} */
   const resourceAttributes = {};
   if (SDK_REVISION) {
     // Detect testnet-load-generator target revision.
@@ -81,43 +90,37 @@ export const getResourceAttributes = ({
 
 /**
  * @typedef {object} Powers
- * @property {{ warn: Console['warn'] }} console
+ * @property {Pick<Console, 'warn'>} console
  * @property {NodeJS.ProcessEnv} env
- * @property {import('@opentelemetry/sdk-metrics').View[]} views
+ * @property {View[]} views
  * @property {string} [serviceName]
  */
 
 /**
- * @param {Partial<Powers>} param0
+ * @param {Partial<Powers>} powers
  */
-const getPrometheusMeterProvider = ({
+export const getPrometheusMeterProvider = ({
   console = globalThis.console,
   env = process.env,
   views,
   ...rest
 } = {}) => {
-  const { OTEL_EXPORTER_PROMETHEUS_PORT } = env;
-  if (!OTEL_EXPORTER_PROMETHEUS_PORT) {
-    // No Prometheus config, so don't install.
-    return undefined;
-  }
+  const { OTEL_EXPORTER_PROMETHEUS_HOST, OTEL_EXPORTER_PROMETHEUS_PORT } = env;
+
+  // The opt-in signal is a non-empty OTEL_EXPORTER_PROMETHEUS_PORT.
+  if (!OTEL_EXPORTER_PROMETHEUS_PORT) return;
 
   const resource = new Resource(getResourceAttributes({ env, ...rest }));
 
-  const port =
-    parseInt(OTEL_EXPORTER_PROMETHEUS_PORT || '', 10) ||
-    PrometheusExporter.DEFAULT_OPTIONS.port;
+  const { DEFAULT_OPTIONS } = PrometheusExporter;
+  const host = OTEL_EXPORTER_PROMETHEUS_HOST || DEFAULT_OPTIONS.host;
+  const port = +OTEL_EXPORTER_PROMETHEUS_PORT || DEFAULT_OPTIONS.port;
+  const url = `http://${host || '0.0.0.0'}:${port}${DEFAULT_OPTIONS.endpoint}`;
 
-  const exporter = new PrometheusExporter(
-    {
-      port,
-    },
-    () => {
-      console.warn(
-        `Prometheus scrape endpoint: http://0.0.0.0:${port}${PrometheusExporter.DEFAULT_OPTIONS.endpoint}`,
-      );
-    },
-  );
+  const options = { host, port, appendTimestamp: true };
+  const exporter = new PrometheusExporter(options, () => {
+    console.warn(`Prometheus scrape endpoint: ${url}`);
+  });
 
   const provider = new MeterProvider({ resource, views });
   provider.addMetricReader(exporter);