@toa.io/extensions.telemetry 1.0.0-alpha.239 → 1.0.0-alpha.246

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -4,3 +4,7 @@ export interface Logs {
4
4
  error: (message: string, ...args: any[]) => void;
5
5
  debug: (message: string, ...args: any[]) => void;
6
6
  }
7
+ export interface Span {
8
+ <T>(name: string, task: () => T | Promise<T>): Promise<T>;
9
+ <T>(name: string, attributes: object, task: () => T | Promise<T>): Promise<T>;
10
+ }
@@ -1,7 +1,7 @@
1
1
  import { type ReadyAnnotation } from './Ready';
2
2
  import type { Connector, Locator, extensions } from '@toa.io/core';
3
3
  import type { Dependency } from '@toa.io/operations';
4
- import type { Channel } from 'openspan';
4
+ import type { ExportersConfig, LevelName } from 'openspan';
5
5
  export declare class Factory implements extensions.Factory {
6
6
  private readonly logsOptions;
7
7
  private readonly ready;
@@ -13,10 +13,16 @@ export declare class Factory implements extensions.Factory {
13
13
  export declare function deployment(_: unknown, annotation?: Annotation): Dependency;
14
14
  interface Annotation {
15
15
  logs?: LogsAnnotation & Record<string, LogsAnnotation>;
16
+ traces?: TracesAnnotation;
16
17
  ready?: ReadyAnnotation;
17
18
  }
18
19
  interface LogsAnnotation {
19
- level: Channel;
20
+ level: LevelName;
21
+ }
22
+ interface TracesAnnotation {
23
+ sample?: number;
24
+ rate?: number;
25
+ exporters?: ExportersConfig;
20
26
  }
21
27
  export declare const ID = "telemetry";
22
28
  export {};
@@ -1,40 +1,45 @@
1
1
  "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
2
5
  Object.defineProperty(exports, "__esModule", { value: true });
3
6
  exports.ID = exports.deployment = exports.Factory = void 0;
7
+ const node_assert_1 = __importDefault(require("node:assert"));
4
8
  const openspan_1 = require("openspan");
5
9
  const generic_1 = require("@toa.io/generic");
6
10
  const Logs_1 = require("./Logs");
11
+ const Span_1 = require("./Span");
7
12
  const Ready_1 = require("./Ready");
8
13
  class Factory {
9
14
  logsOptions;
10
15
  ready;
11
16
  constructor() {
12
17
  const globEnv = process.env[LOGS_PREFIX];
13
- const level = process.env.TOA_DEV === '1' ? 'debug' : 'info';
18
+ const level = process.env.TOA_DEV === '1' ? 'trace' : 'info';
14
19
  this.logsOptions = globEnv === undefined ? { level } : (0, generic_1.decode)(globEnv);
15
20
  this.logsOptions.level ??= level;
16
21
  openspan_1.console.configure({ level: this.logsOptions.level });
22
+ const tracesEnv = process.env[TRACES_ENV];
23
+ (0, openspan_1.traces)(tracesEnv === undefined ? {} : (0, generic_1.decode)(tracesEnv));
17
24
  this.ready = Ready_1.Ready.create();
18
25
  }
19
26
  aspect(locator) {
20
27
  const logs = this.createLogs(locator);
21
- return [logs];
28
+ const span = new Span_1.Span(locator);
29
+ return [logs, span];
22
30
  }
23
31
  manage(composition) {
24
32
  if (this.ready === null)
25
33
  return composition;
26
34
  const ready = this.ready;
35
+ // the composition manages the probe server lifecycle (listen on connect, close on disconnect)
36
+ composition.depends(ready);
27
37
  const connect = composition.connect.bind(composition);
28
- const disconnect = composition.disconnect.bind(composition);
38
+ // readiness is a post-connect phase, not expressible as a dependency
29
39
  composition.connect = async () => {
30
- await ready.listen();
31
40
  await connect();
32
41
  await ready.complete();
33
42
  };
34
- composition.disconnect = async (interrupt) => {
35
- await ready.disconnect(interrupt);
36
- await disconnect(interrupt);
37
- };
38
43
  return composition;
39
44
  }
40
45
  createLogs(locator) {
@@ -49,6 +54,8 @@ function deployment(_, annotation) {
49
54
  const variables = { global: [] };
50
55
  if (annotation?.logs !== undefined)
51
56
  addLogsVariables(annotation.logs, variables);
57
+ if (annotation?.traces !== undefined)
58
+ addTracesVariables(annotation.traces, variables);
52
59
  const ready = (0, Ready_1.normalizeAnnotation)(annotation?.ready);
53
60
  if (ready === false) {
54
61
  variables.global.push({ name: Ready_1.READY_ENV, value: (0, generic_1.encode)(false) });
@@ -77,7 +84,18 @@ function addLogsVariables(annotation, variables) {
77
84
  });
78
85
  }
79
86
  }
87
+ function addTracesVariables(annotation, variables) {
88
+ const { sample, rate, exporters } = annotation;
89
+ if (sample !== undefined)
90
+ node_assert_1.default.ok(typeof sample === 'number' && sample >= 0 && sample <= 1, 'telemetry.traces.sample must be a number within [0, 1]');
91
+ if (rate !== undefined)
92
+ node_assert_1.default.ok(typeof rate === 'number' && rate > 0, 'telemetry.traces.rate must be a positive number');
93
+ if (exporters?.otlp !== undefined)
94
+ node_assert_1.default.ok(typeof exporters.otlp.endpoint === 'string', 'telemetry.traces.exporters.otlp.endpoint is required');
95
+ variables.global.push({ name: TRACES_ENV, value: (0, generic_1.encode)({ sample, rate, exporters }) });
96
+ }
80
97
  const ENV_PREFIX = 'TOA_TELEMETRY';
81
98
  const LOGS_PREFIX = ENV_PREFIX + '_LOGS';
99
+ const TRACES_ENV = ENV_PREFIX + '_TRACES';
82
100
  exports.ID = 'telemetry';
83
101
  //# sourceMappingURL=extension.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"extension.js","sourceRoot":"","sources":["../source/extension.ts"],"names":[],"mappings":";;;AAAA,uCAAkC;AAClC,6CAAgD;AAChD,iCAA6B;AAC7B,mCAMgB;AAMhB,MAAa,OAAO;IACD,WAAW,CAAa;IACxB,KAAK,CAAc;IAEpC;QACE,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;QAE5D,IAAI,CAAC,WAAW,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAA;QACtE,IAAI,CAAC,WAAW,CAAC,KAAK,KAAK,KAAK,CAAA;QAEhC,kBAAO,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAA;QAEpD,IAAI,CAAC,KAAK,GAAG,aAAK,CAAC,MAAM,EAAE,CAAA;IAC7B,CAAC;IAEM,MAAM,CAAE,OAAgB;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QAErC,OAAO,CAAC,IAAI,CAAC,CAAA;IACf,CAAC;IAEM,MAAM,CAAE,WAAsB;QACnC,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;YACrB,OAAO,WAAW,CAAA;QAEpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACxB,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACrD,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAE3D,WAAW,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE;YAC/B,MAAM,KAAK,CAAC,MAAM,EAAE,CAAA;YACpB,MAAM,OAAO,EAAE,CAAA;YACf,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAA;QACxB,CAAC,CAAA;QAED,WAAW,CAAC,UAAU,GAAG,KAAK,EAAE,SAAmB,EAAE,EAAE;YACrD,MAAM,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;YACjC,MAAM,UAAU,CAAC,SAAS,CAAC,CAAA;QAC7B,CAAC,CAAA;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAEO,UAAU,CAAE,OAAgB;QAClC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,WAAW,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAEpE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;QAE/D,OAAO,IAAI,WAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IACrC,CAAC;CACF;AApDD,0BAoDC;AAED,SAAgB,UAAU,CAAE,CAAU,EAAE,UAAuB;IAC7D,MAAM,SAAS,GAAc,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IAE3C,IAAI,UAAU,EAAE,IAAI,KAAK,SAAS;QAChC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;IAE9C,MAAM,KAAK,GAAG,IAAA,2BAAmB,EAAC,UAAU,EAAE,KAAK,CAAC,CAAA;IAEpD,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;QACpB,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,iBAAS,EAAE,KAAK,EAAE,IAAA,gBAAM,EAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAEhE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAA;IACpC,CAAC;IAED,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,iBAAS,EAAE,KAAK,EAAE,IAAA,gBAAM,EAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAEhE,MAAM,KAAK,GAAU;QACnB,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,0BAAkB,CAAC,IAAI;QAC3C,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,0BAAkB,CAAC,IAAI;QAC3C,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,0BAAkB,CAAC,KAAK;KAC/C,CAAA;IAED,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;AAC7B,CAAC;AAvBD,gCAuBC;AAED,SAAS,gBAAgB,CAAE,UAA0B,EAAE,SAAoB;IACzE,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,GAAG,UAAU,CAAA;IAC3C,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,CAAA;IAExB,IAAI,KAAK,KAAK,SAAS;QACrB,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAA,gBAAM,EAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAErE,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACxD,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;QAEjD,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,GAAG,WAAW,IAAI,SAAS,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACvE,KAAK,EAAE,IAAA,gBAAM,EAAC,KAAK,CAAC;SACrB,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAWD,MAAM,UAAU,GAAG,eAAe,CAAA;AAClC,MAAM,WAAW,GAAG,UAAU,GAAG,OAAO,CAAA;AAC3B,QAAA,EAAE,GAAG,WAAW,CAAA"}
1
+ {"version":3,"file":"extension.js","sourceRoot":"","sources":["../source/extension.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAgC;AAChC,uCAA0C;AAC1C,6CAAgD;AAChD,iCAA6B;AAC7B,iCAA6B;AAC7B,mCAMgB;AAMhB,MAAa,OAAO;IACD,WAAW,CAAa;IACxB,KAAK,CAAc;IAEpC;QACE,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;QACxC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;QAE5D,IAAI,CAAC,WAAW,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAA;QACtE,IAAI,CAAC,WAAW,CAAC,KAAK,KAAK,KAAK,CAAA;QAEhC,kBAAO,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAA;QAEpD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QAEzC,IAAA,iBAAM,EAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,gBAAM,EAAC,SAAS,CAAC,CAAC,CAAA;QAExD,IAAI,CAAC,KAAK,GAAG,aAAK,CAAC,MAAM,EAAE,CAAA;IAC7B,CAAC;IAEM,MAAM,CAAE,OAAgB;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QACrC,MAAM,IAAI,GAAG,IAAI,WAAI,CAAC,OAAO,CAAC,CAAA;QAE9B,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACrB,CAAC;IAEM,MAAM,CAAE,WAAsB;QACnC,IAAI,IAAI,CAAC,KAAK,KAAK,IAAI;YACrB,OAAO,WAAW,CAAA;QAEpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QAExB,8FAA8F;QAC9F,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAE1B,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QAErD,qEAAqE;QACrE,WAAW,CAAC,OAAO,GAAG,KAAK,IAAI,EAAE;YAC/B,MAAM,OAAO,EAAE,CAAA;YACf,MAAM,KAAK,CAAC,QAAQ,EAAE,CAAA;QACxB,CAAC,CAAA;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAEO,UAAU,CAAE,OAAgB;QAClC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,WAAW,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;QAClE,MAAM,QAAQ,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAA,gBAAM,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAEpE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;QAE/D,OAAO,IAAI,WAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IACrC,CAAC;CACF;AAvDD,0BAuDC;AAED,SAAgB,UAAU,CAAE,CAAU,EAAE,UAAuB;IAC7D,MAAM,SAAS,GAAc,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IAE3C,IAAI,UAAU,EAAE,IAAI,KAAK,SAAS;QAChC,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAA;IAE9C,IAAI,UAAU,EAAE,MAAM,KAAK,SAAS;QAClC,kBAAkB,CAAC,UAAU,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IAElD,MAAM,KAAK,GAAG,IAAA,2BAAmB,EAAC,UAAU,EAAE,KAAK,CAAC,CAAA;IAEpD,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;QACpB,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,iBAAS,EAAE,KAAK,EAAE,IAAA,gBAAM,EAAC,KAAK,CAAC,EAAE,CAAC,CAAA;QAEhE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAA;IACpC,CAAC;IAED,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,iBAAS,EAAE,KAAK,EAAE,IAAA,gBAAM,EAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAEhE,MAAM,KAAK,GAAU;QACnB,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,0BAAkB,CAAC,IAAI;QAC3C,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,0BAAkB,CAAC,IAAI;QAC3C,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,0BAAkB,CAAC,KAAK;KAC/C,CAAA;IAED,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;AAC7B,CAAC;AA1BD,gCA0BC;AAED,SAAS,gBAAgB,CAAE,UAA0B,EAAE,SAAoB;IACzE,MAAM,EAAE,KAAK,EAAE,GAAG,UAAU,EAAE,GAAG,UAAU,CAAA;IAC3C,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,CAAA;IAExB,IAAI,KAAK,KAAK,SAAS;QACrB,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,IAAA,gBAAM,EAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IAErE,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QACxD,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACvC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;QAEjD,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC;YACpB,IAAI,EAAE,GAAG,WAAW,IAAI,SAAS,CAAC,WAAW,EAAE,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACvE,KAAK,EAAE,IAAA,gBAAM,EAAC,KAAK,CAAC;SACrB,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAED,SAAS,kBAAkB,CAAE,UAA4B,EAAE,SAAoB;IAC7E,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,UAAU,CAAA;IAE9C,IAAI,MAAM,KAAK,SAAS;QACtB,qBAAM,CAAC,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,EAChE,wDAAwD,CAAC,CAAA;IAE7D,IAAI,IAAI,KAAK,SAAS;QACpB,qBAAM,CAAC,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,GAAG,CAAC,EAC5C,iDAAiD,CAAC,CAAA;IAEtD,IAAI,SAAS,EAAE,IAAI,KAAK,SAAS;QAC/B,qBAAM,CAAC,EAAE,CAAC,OAAO,SAAS,CAAC,IAAI,CAAC,QAAQ,KAAK,QAAQ,EACnD,sDAAsD,CAAC,CAAA;IAE3D,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,IAAA,gBAAM,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC,CAAA;AACzF,CAAC;AAkBD,MAAM,UAAU,GAAG,eAAe,CAAA;AAClC,MAAM,WAAW,GAAG,UAAU,GAAG,OAAO,CAAA;AACxC,MAAM,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;AAC5B,QAAA,EAAE,GAAG,WAAW,CAAA"}