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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/telemetry",
-  "version": "0.6.3-other-dev-fbe72e7.0.fbe72e7",
+  "version": "0.6.3-other-dev-d15096d.0.d15096d",
   "description": "Agoric's telemetry implementation",
   "type": "module",
   "repository": "https://github.com/Agoric/agoric-sdk",
@@ -22,8 +22,8 @@
   "author": "Agoric",
   "license": "Apache-2.0",
   "dependencies": {
-    "@agoric/internal": "0.3.3-other-dev-fbe72e7.0.fbe72e7",
-    "@agoric/store": "0.9.3-other-dev-fbe72e7.0.fbe72e7",
+    "@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",
@@ -69,5 +69,5 @@
   "typeCoverage": {
     "atLeast": 89.28
   },
-  "gitHead": "fbe72e72107f9997f788674e668c660d92ec4492"
+  "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/flight-recorder.js

@@ -9,6 +9,7 @@ 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;
@@ -311,7 +312,7 @@ export const makeSlogSenderFromBuffer = ({ fileHandle, writeCircBuf }) => {
 /**
  * Loaded dynamically by makeSlogSender()
  *
- * @type {import('./index.js').MakeSlogSender}
+ * @type {MakeSlogSender}
  */
 export const makeSlogSender = async opts => {
   const { fileHandle, writeCircBuf } = await makeSimpleCircularBuffer(opts);

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
@@ -56,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.
@@ -86,7 +92,7 @@ export const getResourceAttributes = ({
  * @typedef {object} Powers
  * @property {Pick<Console, 'warn'>} console
  * @property {NodeJS.ProcessEnv} env
- * @property {import('@opentelemetry/sdk-metrics').View[]} views
+ * @property {View[]} views
  * @property {string} [serviceName]
  */
 

package/src/make-slog-sender.js

@@ -9,7 +9,10 @@ export const DEFAULT_SLOGSENDER_MODULE =
 export const SLOGFILE_SENDER_MODULE = '@agoric/telemetry/src/slog-file.js';
 export const PROMETHEUS_SENDER_MODULE = '@agoric/telemetry/src/prometheus.js';
 
-/** @import {SlogSender} from './index.js' */
+/**
+ * @import {SlogSender} from './index.js'
+ * @import {MakeSlogSender} from './index.js';
+ */
 
 /**
  * @template T
@@ -36,7 +39,7 @@ const filterTruthy = arr => /** @type {any[]} */ (arr.filter(Boolean));
  * When there are no subordinates, the return value will be `undefined` rather
  * than a slog sender function.
  *
- * @type {import('./index.js').MakeSlogSender}
+ * @type {MakeSlogSender}
  */
 export const makeSlogSender = async (opts = {}) => {
   const { env = {}, stateDir: stateDirOption, ...otherOpts } = opts;
@@ -102,7 +105,7 @@ export const makeSlogSender = async (opts = {}) => {
     console.warn('Loading slog sender modules:', ...slogSenderModules);
   }
 
-  /** @type {Map<import('./index.js').MakeSlogSender, string>} */
+  /** @type {Map<MakeSlogSender, string>} */
   const makerMap = new Map();
   await Promise.all(
     [...slogSenderModules].map(async moduleIdentifier => {

package/src/otel-and-flight-recorder.js

@@ -2,7 +2,11 @@ import { NonNullish } from '@agoric/internal';
 import { makeSlogSender as makeSlogSenderFromEnv } from './make-slog-sender.js';
 
 /**
- * @param {import('./index.js').MakeSlogSenderOptions} opts
+ * @import {MakeSlogSenderOptions} from './index.js';
+ */
+
+/**
+ * @param {MakeSlogSenderOptions} opts
  */
 export const makeSlogSender = async opts => {
   const { SLOGFILE: _1, SLOGSENDER: _2, ...otherEnv } = opts.env || {};

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

@@ -11,6 +11,12 @@ import { makeContextualSlogProcessor } from './context-aware-slog.js';
 import { getResourceAttributes } from './index.js';
 import { serializeSlogObj } from './serialize-slog-obj.js';
 
+/**
+ * @import {Context} from './context-aware-slog.js';
+ * @import {MakeSlogSenderOptions} from './index.js';
+ * @import {Slog} from './context-aware-slog.js';
+ */
+
 const DEFAULT_CONTEXT_FILE = 'slog-context.json';
 const FILE_ENCODING = 'utf8';
 
@@ -22,7 +28,7 @@ export const getContextFilePersistenceUtils = filePath => {
 
   return {
     /**
-     * @param {import('./context-aware-slog.js').Context} context
+     * @param {Context} context
      */
     persistContext: context => {
       try {
@@ -33,7 +39,7 @@ export const getContextFilePersistenceUtils = filePath => {
     },
 
     /**
-     * @returns {import('./context-aware-slog.js').Context | null}
+     * @returns {Context | null}
      */
     restoreContext: () => {
       try {
@@ -47,7 +53,7 @@ export const getContextFilePersistenceUtils = filePath => {
 };
 
 /**
- * @param {import('./index.js').MakeSlogSenderOptions} options
+ * @param {MakeSlogSenderOptions} options
  */
 export const makeSlogSender = async options => {
   const { CHAIN_ID, OTEL_EXPORTER_OTLP_ENDPOINT } = options.env || {};
@@ -79,7 +85,7 @@ export const makeSlogSender = async options => {
   );
 
   /**
-   * @param {import('./context-aware-slog.js').Slog} slog
+   * @param {Slog} slog
    */
   const slogSender = slog => {
     const { time, ...logRecord } = contextualSlogProcessor(slog);

package/src/otel-metrics.js

@@ -13,11 +13,12 @@ import {
  * @import {MetricOptions, ObservableCounter, ObservableUpDownCounter} from '@opentelemetry/api';
  * @import {MeterProvider} from '@opentelemetry/sdk-metrics';
  * @import {TotalMap} from '@agoric/internal';
+ * @import {MakeSlogSenderOptions} from './index.js';
  */
 
 const knownActionTypes = new Set(Object.values(ActionType.QueuedActionType));
 
-/** @param {import('./index.js').MakeSlogSenderOptions & {otelMeterName: string, otelMeterProvider?: MeterProvider}} opts */
+/** @param {MakeSlogSenderOptions & {otelMeterName: string, otelMeterProvider?: MeterProvider}} opts */
 export const makeSlogSender = async (opts = /** @type {any} */ ({})) => {
   const { otelMeterName, otelMeterProvider } = opts;
   if (!otelMeterName) throw Fail`OTel meter name is required`;

package/src/prometheus.js

@@ -3,7 +3,11 @@ import { Fail } from '@endo/errors';
 import { getPrometheusMeterProvider } from './index.js';
 import { makeSlogSender as makeOtelMetricsSender } from './otel-metrics.js';
 
-/** @param {import('./index.js').MakeSlogSenderOptions & {otelMeterName?: string}} opts */
+/**
+ * @import {MakeSlogSenderOptions} from './index.js';
+ */
+
+/** @param {MakeSlogSenderOptions & {otelMeterName?: string}} opts */
 export const makeSlogSender = async (opts = {}) => {
   const { env, otelMeterName, serviceName } = opts;
   if (!otelMeterName) throw Fail`OTel meter name is required`;

package/src/slog-file.js

@@ -1,7 +1,11 @@
 import { makeFsStreamWriter } from '@agoric/internal/src/node/fs-stream.js';
 import { serializeSlogObj } from './serialize-slog-obj.js';
 
-/** @param {import('./index.js').MakeSlogSenderOptions} opts */
+/**
+ * @import {MakeSlogSenderOptions} from './index.js';
+ */
+
+/** @param {MakeSlogSenderOptions} opts */
 export const makeSlogSender = async ({ env: { SLOGFILE } = {} } = {}) => {
   const stream = await makeFsStreamWriter(SLOGFILE);
 

package/src/slog-sender-pipe-entrypoint.js

@@ -15,13 +15,21 @@ import { makeShutdown } from '@agoric/internal/src/node/shutdown.js';
 
 import { makeSlogSender } from './make-slog-sender.js';
 
+/**
+ * @import {PipeAPIReply} from './slog-sender-pipe.js';
+ * @import {MakeSlogSenderOptions} from './index.js';
+ * @import {SlogSender} from './index.js';
+ */
+
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore TODO remove when anylogger has types
 const logger = anylogger('slog-sender-pipe-entrypoint');
 
-/** @type {(msg: import('./slog-sender-pipe.js').PipeAPIReply) => void} */
+/** @type {(msg: PipeAPIReply) => void} */
 const send = Function.prototype.bind.call(process.send, process);
 
 /**
- * @typedef {{type: 'init', options: import('./index.js').MakeSlogSenderOptions }} InitMessage
+ * @typedef {{type: 'init', options: MakeSlogSenderOptions }} InitMessage
  * @typedef {{type: 'flush' }} FlushMessage
  * @typedef {{type: 'send', obj: Record<string, unknown> }} SendMessage
  *
@@ -31,7 +39,7 @@ const send = Function.prototype.bind.call(process.send, process);
  */
 
 const main = async () => {
-  /** @type {import('./index.js').SlogSender | undefined} */
+  /** @type {SlogSender | undefined} */
   let slogSender;
 
   const sendErrors = [];
@@ -44,7 +52,7 @@ const main = async () => {
     process.disconnect?.();
   });
 
-  /** @param {import('./index.js').MakeSlogSenderOptions} opts */
+  /** @param {MakeSlogSenderOptions} opts */
   const init = async ({ env, ...otherOpts } = {}) => {
     !slogSender || Fail`Already initialized`;
 

package/src/slog-sender-pipe.js

@@ -17,8 +17,17 @@ import { makeQueue } from '@endo/stream';
 
 import { makeShutdown } from '@agoric/internal/src/node/shutdown.js';
 
+/**
+ * @import {AsyncQueue} from '@endo/stream';
+ * @import {InitMessage} from './slog-sender-pipe-entrypoint.js';
+ * @import {FlushMessage} from './slog-sender-pipe-entrypoint.js';
+ * @import {MakeSlogSenderOptions} from './index.js';
+ */
+
 const dirname = path.dirname(new URL(import.meta.url).pathname);
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore TODO remove when anylogger has types
 const logger = anylogger('slog-sender-pipe');
 
 const sink = () => {};
@@ -29,7 +38,7 @@ const sink = () => {};
  * @param {(...args: T) => Promise<R>} operation
  */
 const withMutex = operation => {
-  /** @type {import('@endo/stream').AsyncQueue<void>} */
+  /** @type {AsyncQueue<void>} */
   const mutex = makeQueue();
   mutex.put(Promise.resolve());
   /** @param {T} args */
@@ -49,11 +58,11 @@ const withMutex = operation => {
 /**
  * @typedef {{
  *   init: {
- *     message: import('./slog-sender-pipe-entrypoint.js').InitMessage;
+ *     message: InitMessage;
  *     reply: PipeReply<{ hasSender: boolean }>;
  *   };
  *   flush: {
- *     message: import('./slog-sender-pipe-entrypoint.js').FlushMessage;
+ *     message: FlushMessage;
  *     reply: PipeReply<{}>;
  *   };
  * }} SlogSenderPipeAPI
@@ -62,7 +71,7 @@ const withMutex = operation => {
  * @typedef {SlogSenderPipeAPI[PipeAPICommand]["reply"]} PipeAPIReply
  */
 
-/** @param {import('.').MakeSlogSenderOptions} options */
+/** @param {MakeSlogSenderOptions} options */
 export const makeSlogSender = async options => {
   const { env = {} } = options;
   const { registerShutdown } = makeShutdown();
@@ -87,7 +96,7 @@ export const makeSlogSender = async options => {
   const rawSend = promisify(cp.send.bind(cp));
   const pipeSend = withMutex(rawSend);
 
-  /** @type {import('@endo/stream').AsyncQueue<PipeAPIReply>} */
+  /** @type {AsyncQueue<PipeAPIReply>} */
   const sendWaitQueue = makeQueue();
   /** @type {PipeAPICommand | undefined} */
   let sendWaitType;

package/src/slog-to-otel.js

@@ -14,7 +14,13 @@ import {
 
 // diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.VERBOSE);
 
-/** @import {Span, Link as SpanLink} from '@opentelemetry/api' */
+/**
+ * @import {Span, Link as SpanLink} from '@opentelemetry/api'
+ * @import {Tracer} from '@opentelemetry/api';
+ * @import {SwingSetCapData} from '@agoric/swingset-vat';
+ * @import {Message} from '@agoric/swingset-vat';
+ * @import {KernelSyscallObject} from '@agoric/swingset-vat';
+ */
 /** @import {SpanContext, SpanOptions} from '@opentelemetry/api' */
 
 const { assign } = Object;
@@ -76,7 +82,7 @@ export const floatSecondsToHiRes = sFloat => {
 };
 
 /**
- * @param {import('@opentelemetry/api').Tracer} tracer
+ * @param {Tracer} tracer
  * @param {Record<string, any>} [overrideAttrs]
  */
 export const makeSlogToOtelKit = (tracer, overrideAttrs = {}) => {
@@ -140,7 +146,7 @@ export const makeSlogToOtelKit = (tracer, overrideAttrs = {}) => {
   });
 
   /**
-   * @param {import('@agoric/swingset-vat').SwingSetCapData} data
+   * @param {SwingSetCapData} data
    * @returns {any}
    */
   const unserialize = data => {
@@ -156,12 +162,12 @@ export const makeSlogToOtelKit = (tracer, overrideAttrs = {}) => {
   /**
    * @typedef {{
    *   method: string;
-   *   args: import('@agoric/swingset-vat').SwingSetCapData;
+   *   args: SwingSetCapData;
    *   result?: string | undefined | null,
    * }} OldMessage
    */
   /** @typedef {ReturnType<typeof parseMsg>} ParsedMessage */
-  /** @param {import('@agoric/swingset-vat').Message | OldMessage} msg */
+  /** @param {Message | OldMessage} msg */
   const parseMsg = msg => {
     /** @type {string | symbol | null} */
     let method = null;
@@ -699,7 +705,7 @@ export const makeSlogToOtelKit = (tracer, overrideAttrs = {}) => {
         if (isReplaying) {
           break;
         }
-        /** @type {{ksc: import('@agoric/swingset-vat').KernelSyscallObject } & Record<string, unknown>} */
+        /** @type {{ksc: KernelSyscallObject } & Record<string, unknown>} */
         const { ksc, vsc: _1, ...attrs } = slogAttrs;
         if (!ksc) {
           break;