@runsignal/node 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gokhan Ertogan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,120 @@
-# Temporary Holding Version
+# RunSignal for Node.js
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Monitor Node.js background work that no HTTP status code describes, such as BullMQ queues, job schedulers and
+sync loops, with OpenTelemetry. It emits the same signals and manifest as every other RunSignal SDK, so the
+`runsignal` CLI provisions the same New Relic alerts for Node.js services as for .NET and Go ones. See the
+[main README](../../README.md) for the concepts and the alerts.
+
+```bash
+npm install @runsignal/node @opentelemetry/api   # once published; until then, build from source
+```
+
+Requires Node.js 20 or later. The package is ESM only and ships its own TypeScript types.
+
+## Usage
+
+```ts
+import { defaultRegistry } from '@runsignal/node';
+
+const invoices = defaultRegistry.workload('nightly-invoice', {
+  schedule: '0 2 * * *',
+  maxDuration: '30m',          // or milliseconds
+  minProcessed: 100,
+  severity: 'critical',
+});
+
+// One run: succeeds when fn resolves, is cancelled if the signal was aborted, fails otherwise.
+await invoices.run(async (signal) => {
+  for (const order of await unbilledOrders()) {
+    await createInvoice(order, { signal });
+    invoices.processed();
+  }
+}, { signal: shutdown.signal });
+```
+
+A long-running loop sends heartbeats, so a loop that is alive but stuck is noticed:
+
+```ts
+const sync = defaultRegistry.workload('stock-sync', { expectEvery: '5m' });
+setInterval(async () => {
+  await syncStock();
+  sync.beat();
+}, 60_000);
+```
+
+Manual runs, and failures without an error:
+
+```ts
+const run = imports.start();
+const file = await fetchStatement();
+if (!file) {
+  run.failCode('statement_missing', 'no bank statement today');
+} else {
+  run.succeed();
+}
+```
+
+`error.type` is the error's `errorType` property if it has one, then its `code` if that is a string (such as
+`ECONNREFUSED`), then its class name.
+
+The registry follows the global meter provider. It works even when it is created, for example by an import,
+before the OpenTelemetry SDK starts. Run spans are nested under the active span when a context manager is
+registered, which `NodeSDK` does for you.
+
+### BullMQ
+
+```ts
+import { discoverSchedulers, instrument, workloadOf } from '@runsignal/node/bullmq';
+
+const worker = new Worker('reports', instrument(async (job) => {
+  const rows = await buildReport(job.data);
+  workloadOf(job)?.processed(rows.length);
+}, { workloads: { 'daily-sales-report': { maxDuration: '10m', severity: 'critical' } } }), { connection });
+
+await queue.upsertJobScheduler('Daily Sales Report', { pattern: '0 0 6 * * *' }, { name: 'build' });
+await discoverSchedulers(queue);   // registers schedulers before they first fire
+```
+
+- **What gets recorded:** every job, including success, failure with its error type, cancellation (when BullMQ aborts the job) and duration. Results and errors pass through, so retries work as before.
+- **Naming:** jobs from a job scheduler are named after the scheduler (`Daily Sales Report` becomes `daily-sales-report`). Other jobs are named after their queue and job name (`emails.send-welcome`).
+- **Discovery:** `discoverSchedulers` takes each scheduler's cron pattern as its schedule, so a scheduler that never fires gets a `missed` alert. Schedulers that use `every` get no schedule.
+- **Redis client:** in ESM, BullMQ 6 needs a constructed Redis client, such as `connection: new Redis({ maxRetriesPerRequest: null })` from `ioredis`, instead of connection options.
+
+### Manifest
+
+```ts
+defaultRegistry.writeManifestFromEnv('billing-service'); // writes to RUNSIGNAL_MANIFEST_PATH when it is set
+```
+
+### Exporting to New Relic
+
+Use delta temporality. With cumulative, a stopped workload never looks stopped:
+
+```ts
+new OTLPMetricExporter({
+  url: 'https://otlp.eu01.nr-data.net:4317',        // US: https://otlp.nr-data.net:4317
+  metadata,                                         // a grpc Metadata with api-key = your license key
+  temporalityPreference: AggregationTemporality.DELTA,
+});
+```
+
+A complete program is in [examples/worker](examples/worker).
+
+## Performance
+
+Measured on Apple Silicon with Node.js 26 and the OpenTelemetry metrics SDK attached; the times include its
+aggregation. Run with `npm run bench`.
+
+| Operation | Time |
+|---|---|
+| `start()` + `succeed()` without tracing | ~0.7 µs |
+| `processed()` / `beat()` | ~0.2–0.3 µs |
+
+With tracing, the cost depends on your span processor. For workloads that run thousands of times per second,
+create the registry with `new WorkloadRegistry({ tracing: false })`.
+
+## Development
+
+```bash
+npm test      # needs redis-server on the PATH; the BullMQ tests start their own instance
+```

package/dist/bullmq.d.ts

@@ -0,0 +1,33 @@
+import type { Job, Processor, Queue } from 'bullmq';
+import { type Workload, type WorkloadOptions, type WorkloadRegistry } from './registry.js';
+export interface InstrumentOptions {
+    /** The registry to record on. Defaults to `defaultRegistry`. */
+    registry?: WorkloadRegistry;
+    /** Expectations per workload name, applied when the workload is first created. */
+    workloads?: Record<string, WorkloadOptions>;
+}
+/**
+ * The workload a job runs as: its job scheduler ID for jobs created by `upsertJobScheduler` (so repeatable jobs
+ * keep one name across runs), otherwise the queue and job name, such as `emails.send-welcome`.
+ */
+export declare function workloadNameOf(job: Pick<Job, 'name' | 'queueName' | 'repeatJobKey'>): string;
+/**
+ * Wraps a BullMQ processor so every job is recorded as a run of its workload: success, failure with the job's
+ * error type, cancellation (when BullMQ aborts the job) and duration. The processor's result and errors pass
+ * through unchanged, so retries and failed-job handling work as before. Count items with
+ * `workloadOf(job)?.processed()`.
+ *
+ * ```ts
+ * new Worker('emails', instrument(async (job) => send(job.data)), { connection });
+ * ```
+ */
+export declare function instrument<T, R, N extends string>(processor: Processor<T, R, N>, options?: InstrumentOptions): Processor<T, R, N>;
+/** The workload the job runs as inside an `instrument`ed processor, for counting items. */
+export declare function workloadOf(job: object): Workload | undefined;
+/**
+ * Registers a workload for every job scheduler of `queue`, with its cron pattern as the schedule, so a
+ * repeatable job that never fires is still alerted on. Call it after `upsertJobScheduler` and before writing
+ * the manifest. Schedulers that use `every` instead of a cron pattern get no schedule. Time zones are not
+ * carried over: pass `--time-zone` to the CLI if your patterns use one.
+ */
+export declare function discoverSchedulers(queue: Pick<Queue, 'getJobSchedulers'>, options?: InstrumentOptions): Promise<Workload[]>;

package/dist/bullmq.js

@@ -0,0 +1,57 @@
+import { toWorkloadName } from './naming.js';
+import { defaultRegistry } from './registry.js';
+/**
+ * The workload a job runs as: its job scheduler ID for jobs created by `upsertJobScheduler` (so repeatable jobs
+ * keep one name across runs), otherwise the queue and job name, such as `emails.send-welcome`.
+ */
+export function workloadNameOf(job) {
+    return toWorkloadName(job.repeatJobKey ?? `${job.queueName}.${job.name}`);
+}
+/**
+ * Wraps a BullMQ processor so every job is recorded as a run of its workload: success, failure with the job's
+ * error type, cancellation (when BullMQ aborts the job) and duration. The processor's result and errors pass
+ * through unchanged, so retries and failed-job handling work as before. Count items with
+ * `workloadOf(job)?.processed()`.
+ *
+ * ```ts
+ * new Worker('emails', instrument(async (job) => send(job.data)), { connection });
+ * ```
+ */
+export function instrument(processor, options = {}) {
+    const registry = options.registry ?? defaultRegistry;
+    const cache = new Map();
+    return (job, token, signal) => {
+        const name = workloadNameOf(job);
+        let workload = cache.get(name);
+        if (!workload) {
+            workload = registry.getOrAdd(name, options.workloads?.[name]);
+            cache.set(name, workload);
+        }
+        jobWorkloads.set(job, workload);
+        return workload.run(() => processor(job, token, signal), signal === undefined ? {} : { signal });
+    };
+}
+const jobWorkloads = new WeakMap();
+/** The workload the job runs as inside an `instrument`ed processor, for counting items. */
+export function workloadOf(job) {
+    return jobWorkloads.get(job);
+}
+/**
+ * Registers a workload for every job scheduler of `queue`, with its cron pattern as the schedule, so a
+ * repeatable job that never fires is still alerted on. Call it after `upsertJobScheduler` and before writing
+ * the manifest. Schedulers that use `every` instead of a cron pattern get no schedule. Time zones are not
+ * carried over: pass `--time-zone` to the CLI if your patterns use one.
+ */
+export async function discoverSchedulers(queue, options = {}) {
+    const registry = options.registry ?? defaultRegistry;
+    const found = [];
+    for (const scheduler of await queue.getJobSchedulers()) {
+        const name = toWorkloadName(scheduler.key);
+        found.push(registry.getOrAdd(name, {
+            ...(scheduler.pattern && { schedule: scheduler.pattern }),
+            ...options.workloads?.[name],
+        }));
+    }
+    return found;
+}
+//# sourceMappingURL=bullmq.js.map

package/dist/bullmq.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bullmq.js","sourceRoot":"","sources":["../src/bullmq.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,eAAe,EAA8D,MAAM,eAAe,CAAC;AAS5G;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,GAAqD;IAClF,OAAO,cAAc,CAAC,GAAG,CAAC,YAAY,IAAI,GAAG,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;AAC5E,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,UAAU,CAAyB,SAA6B,EAAE,OAAO,GAAsB,EAAE;IAC/G,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;IACrD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAoB,CAAC;IAE1C,OAAO,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QAC5B,MAAM,IAAI,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9D,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC5B,CAAC;QACD,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAChC,OAAO,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IACnG,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,IAAI,OAAO,EAAoB,CAAC;AAErD,2FAA2F;AAC3F,MAAM,UAAU,UAAU,CAAC,GAAW;IACpC,OAAO,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,KAAsC,EAAE,OAAO,GAAsB,EAAE;IAC9G,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAC;IACrD,MAAM,KAAK,GAAe,EAAE,CAAC;IAC7B,KAAK,MAAM,SAAS,IAAI,MAAM,KAAK,CAAC,gBAAgB,EAAE,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC3C,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE;YACjC,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,OAAO,EAAE,CAAC;YACzD,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC,IAAI,CAAC;SAC7B,CAAC,CAAC,CAAC;IACN,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { defaultRegistry, Run, Workload, WorkloadConfigurationError, WorkloadRegistry, type Duration, type ErrorWithType, type Expectations, type RegistryOptions, type Severity, type WorkloadManifest, type WorkloadOptions, } from './registry.js';
+export { InvalidWorkloadNameError, toWorkloadName } from './naming.js';
+export { Attributes, DURATION_BUCKETS, Metrics, SCOPE_NAME, VERSION } from './telemetry.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export { defaultRegistry, Run, Workload, WorkloadConfigurationError, WorkloadRegistry, } from './registry.js';
+export { InvalidWorkloadNameError, toWorkloadName } from './naming.js';
+export { Attributes, DURATION_BUCKETS, Metrics, SCOPE_NAME, VERSION } from './telemetry.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,GAAG,EACH,QAAQ,EACR,0BAA0B,EAC1B,gBAAgB,GAQjB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,wBAAwB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/naming.d.ts

@@ -0,0 +1,11 @@
+/** Thrown for workload names that are not 1-128 lowercase letters, digits, '.', '_' or '-'. */
+export declare class InvalidWorkloadNameError extends Error {
+    name: string;
+}
+export declare function validateName(name: string): void;
+/**
+ * Turns an arbitrary job identifier, such as `InvoiceJobs.GenerateInvoices` or `Reports/Daily Sales`, into a
+ * valid workload name such as `invoice-jobs.generate-invoices` or `reports-daily-sales`. Every RunSignal SDK
+ * derives names the same way (spec/conformance/workload-names.json).
+ */
+export declare function toWorkloadName(identifier: string): string;

package/dist/naming.js

@@ -0,0 +1,61 @@
+const NAME_PATTERN = /^[a-z0-9][a-z0-9._-]{0,127}$/;
+/** Thrown for workload names that are not 1-128 lowercase letters, digits, '.', '_' or '-'. */
+export class InvalidWorkloadNameError extends Error {
+    name = 'InvalidWorkloadNameError';
+}
+export function validateName(name) {
+    if (!NAME_PATTERN.test(name)) {
+        throw new InvalidWorkloadNameError(`Workload name '${name}' is invalid. Use 1-128 lowercase letters, digits, '.', '_' or '-', starting with a letter or digit.`);
+    }
+}
+// Letters that do not decompose into a base letter and a combining mark.
+const TRANSLITERATIONS = {
+    ı: 'i', ß: 'ss', ø: 'o', Ø: 'O', æ: 'ae', Æ: 'Ae', đ: 'd', Đ: 'D', ł: 'l', Ł: 'L',
+};
+const isLower = (c) => c !== undefined && c >= 'a' && c <= 'z';
+const isUpper = (c) => c !== undefined && c >= 'A' && c <= 'Z';
+const isDigit = (c) => c !== undefined && c >= '0' && c <= '9';
+/**
+ * Turns an arbitrary job identifier, such as `InvoiceJobs.GenerateInvoices` or `Reports/Daily Sales`, into a
+ * valid workload name such as `invoice-jobs.generate-invoices` or `reports-daily-sales`. Every RunSignal SDK
+ * derives names the same way (spec/conformance/workload-names.json).
+ */
+export function toWorkloadName(identifier) {
+    if (identifier.trim() === '') {
+        throw new InvalidWorkloadNameError('The identifier is empty.');
+    }
+    // "e-Arşiv gönderimi" -> "e-Arsiv gonderimi", so names stay readable instead of losing letters.
+    const ascii = [...identifier.normalize('NFD').replace(/\p{Mn}/gu, '')]
+        .map((c) => TRANSLITERATIONS[c] ?? c)
+        .join('');
+    const chars = [...ascii];
+    let out = '';
+    chars.forEach((c, i) => {
+        if (isUpper(c)) {
+            // Break camel case: "GenerateInvoices" -> "generate-invoices", "HTTPSync" -> "http-sync".
+            const prev = chars[i - 1];
+            const next = chars[i + 1];
+            const last = out.at(-1);
+            if (out.length > 0 && last !== '-' && last !== '.' && last !== '_' &&
+                (isLower(prev) || isDigit(prev) || (isUpper(prev) && isLower(next)))) {
+                out += '-';
+            }
+            out += c.toLowerCase();
+        }
+        else if (isLower(c) || isDigit(c) || c === '.' || c === '_') {
+            out += c;
+        }
+        else if (out.length > 0 && out.at(-1) !== '-') {
+            out += '-';
+        }
+    });
+    let name = out.replace(/^[-._]+|[-._]+$/g, '');
+    if (name.length > 128) {
+        name = name.slice(0, 128).replace(/[-._]+$/, '');
+    }
+    if (name === '') {
+        throw new InvalidWorkloadNameError(`'${identifier}' contains no letters or digits to name a workload after.`);
+    }
+    return name;
+}
+//# sourceMappingURL=naming.js.map

package/dist/naming.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming.js","sourceRoot":"","sources":["../src/naming.ts"],"names":[],"mappings":"AAAA,MAAM,YAAY,GAAG,8BAA8B,CAAC;AAEpD,+FAA+F;AAC/F,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IACxC,IAAI,GAAG,0BAA0B,CAAC;CAC5C;AAED,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,MAAM,IAAI,wBAAwB,CAChC,kBAAkB,IAAI,sGAAsG,CAC7H,CAAC;IACJ,CAAC;AACH,CAAC;AAED,yEAAyE;AACzE,MAAM,gBAAgB,GAA2B;IAC/C,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG;CAClF,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,CAAqB,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;AACnF,MAAM,OAAO,GAAG,CAAC,CAAqB,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;AACnF,MAAM,OAAO,GAAG,CAAC,CAAqB,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC;AAEnF;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,UAAkB;IAC/C,IAAI,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAC7B,MAAM,IAAI,wBAAwB,CAAC,0BAA0B,CAAC,CAAC;IACjE,CAAC;IAED,gGAAgG;IAChG,MAAM,KAAK,GAAG,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;SACnE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;SACpC,IAAI,CAAC,EAAE,CAAC,CAAC;IACZ,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAEzB,IAAI,GAAG,GAAG,EAAE,CAAC;IACb,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACrB,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;YACf,0FAA0F;YAC1F,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG;gBAC9D,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;gBACzE,GAAG,IAAI,GAAG,CAAC;YACb,CAAC;YACD,GAAG,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QACzB,CAAC;aAAM,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;YAC9D,GAAG,IAAI,CAAC,CAAC;QACX,CAAC;aAAM,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;YAChD,GAAG,IAAI,GAAG,CAAC;QACb,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;IAC/C,IAAI,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACtB,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;IACD,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;QAChB,MAAM,IAAI,wBAAwB,CAAC,IAAI,UAAU,2DAA2D,CAAC,CAAC;IAChH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/registry.d.ts

@@ -0,0 +1,172 @@
+import { type Attributes as OtelAttributes, type Counter, type Histogram, type MeterProvider, type Span, type Tracer, type TracerProvider } from '@opentelemetry/api';
+import { toWorkloadName } from './naming.js';
+/** How urgent a workload's alerts are; it routes notifications. */
+export type Severity = 'info' | 'warning' | 'critical';
+/** A duration in milliseconds, or a string such as `'90s'`, `'30m'`, `'2h'` or `'1d'`. */
+export type Duration = number | string;
+/**
+ * What a workload is expected to do. These define the alerts RunSignal provisions and do not change how signals
+ * are recorded.
+ */
+export interface WorkloadOptions {
+    /** Cron expression for when the workload should run. Produces the missed alert. */
+    schedule?: string;
+    /** Longest acceptable run. Produces the overrun alert. */
+    maxDuration?: Duration;
+    /** Longest acceptable gap between heartbeats. Produces the stalled alert. */
+    expectEvery?: Duration;
+    /** Fewest items a run should process. Produces the low-output alert. */
+    minProcessed?: number;
+    /** Highest acceptable share (0 to 1) of failed runs or items. Produces the failure-rate alert. */
+    failureRateThreshold?: number;
+    /** How urgent the workload's alerts are. Defaults to `'warning'`. */
+    severity?: Severity;
+}
+/** The validated expectations of a workload, with durations in milliseconds. */
+export interface Expectations {
+    readonly schedule?: string;
+    readonly maxDurationMs?: number;
+    readonly expectEveryMs?: number;
+    readonly minProcessed?: number;
+    readonly failureRateThreshold?: number;
+    readonly severity: Severity;
+}
+export interface RegistryOptions {
+    /** Records metrics on this provider instead of the global one. */
+    meterProvider?: MeterProvider;
+    /** Records run spans on this provider instead of the global one. */
+    tracerProvider?: TracerProvider;
+    /** Set to false to record no span per run, for workloads that run thousands of times per second. */
+    tracing?: boolean;
+}
+/** An error can supply its own low-cardinality `error.type`, such as `'statement_missing'`. */
+export interface ErrorWithType {
+    errorType: string;
+}
+/** Thrown when a workload's options are invalid or declared twice. */
+export declare class WorkloadConfigurationError extends Error {
+    name: string;
+}
+/** @internal */
+export interface Instruments {
+    readonly provider: MeterProvider;
+    readonly runs: Counter;
+    readonly duration: Histogram;
+    readonly items: Counter;
+    readonly heartbeats: Counter;
+}
+/** Creates and holds the workloads of an application and the instruments they record on. */
+export declare class WorkloadRegistry {
+    #private;
+    /** @internal */ readonly tracer: Tracer | undefined;
+    /**
+     * By default the registry records on the global OpenTelemetry providers. It follows the global meter provider
+     * when it changes, so it works even when it is created, for example by an import, before the SDK starts.
+     */
+    constructor(options?: RegistryOptions);
+    /** @internal The instruments to record on, recreated if the global meter provider has changed. */
+    get instruments(): Instruments;
+    /**
+     * Returns the workload called `name`, creating it with `options` on first use. Call it once and keep the
+     * result. Passing options for a workload that already exists throws, so expectations are declared in exactly
+     * one place.
+     */
+    workload(name: string, options?: WorkloadOptions): Workload;
+    /**
+     * Returns the workload called `name`, creating it with `options` if it does not exist yet. Unlike `workload`,
+     * an existing workload is returned as is: options declared elsewhere take precedence. Scheduler integrations
+     * use it to name workloads after jobs.
+     */
+    getOrAdd(name: string, options?: WorkloadOptions): Workload;
+    /** Every workload created so far, sorted by name. */
+    get workloads(): Workload[];
+    /** Describes every workload, for alert provisioning. `service` must match the OpenTelemetry `service.name`. */
+    manifest(service: string): WorkloadManifest;
+    /** Writes the manifest as indented JSON, atomically, so a reader never sees half a manifest. */
+    writeManifest(path: string, service: string): void;
+    /**
+     * Writes the manifest if the RUNSIGNAL_MANIFEST_PATH environment variable is set, so CI can ask for one
+     * without code changes. Call it once every workload has been registered. The service name is `service`, or
+     * else OTEL_SERVICE_NAME, or else the script name. Returns the path written, or undefined.
+     */
+    writeManifestFromEnv(service?: string): string | undefined;
+}
+/** A workload manifest, in the format of spec/manifest.schema.json. */
+export interface WorkloadManifest {
+    version: 1;
+    service: string;
+    workloads: Array<{
+        name: string;
+        schedule?: string;
+        maxDurationSeconds?: number;
+        expectEverySeconds?: number;
+        minProcessed?: number;
+        failureRateThreshold?: number;
+        severity: Severity;
+    }>;
+}
+type Outcome = 'success' | 'failure' | 'cancelled';
+/**
+ * A unit of background work, such as a scheduled job, a queue consumer or a sync loop. Get one from a
+ * WorkloadRegistry once and keep it.
+ */
+export declare class Workload {
+    #private;
+    readonly name: string;
+    readonly expectations: Expectations;
+    /** @internal */ readonly nameAttributes: OtelAttributes;
+    /** @internal */
+    constructor(registry: WorkloadRegistry, name: string, expectations: Expectations);
+    /**
+     * Starts a run. End it with exactly one call to `succeed`, `fail`, `failCode` or `cancel`; later calls are
+     * ignored. Prefer `run`, which ends the run for you and makes the run's span active for `fn`.
+     */
+    start(): Run;
+    /**
+     * Runs `fn` as one run of the workload: it succeeds when `fn` resolves, is cancelled when `fn` rejects after
+     * `signal` was aborted, and fails otherwise. The result or error of `fn` is passed through.
+     */
+    run<T>(fn: (signal?: AbortSignal) => T | Promise<T>, options?: {
+        signal?: AbortSignal;
+    }): Promise<T>;
+    /** Records `count` successfully processed items. Recording 0 is useful: it reports that a run did nothing. */
+    processed(count?: number): void;
+    /** Records `count` items that could not be processed. */
+    itemFailed(count?: number): void;
+    /** Records a heartbeat: the workload is alive and making progress. */
+    beat(): void;
+    /** @internal */
+    complete(start: number, span: Span | undefined, outcome: Outcome, errorType?: string, error?: unknown, description?: string): void;
+    /** @internal */
+    secondsSinceSuccess(now: number): number | undefined;
+    /** @internal */
+    secondsSinceHeartbeat(now: number): number | undefined;
+}
+/** One run of a Workload, started with `Workload.start`. */
+export declare class Run {
+    #private;
+    readonly workload: Workload;
+    private readonly started;
+    readonly span: Span | undefined;
+    /** @internal */
+    constructor(workload: Workload, started: number, span: Span | undefined);
+    /** Milliseconds since the run started. */
+    get elapsedMs(): number;
+    /** Ends the run as successful. */
+    succeed(): void;
+    /**
+     * Ends the run as failed because of `error`. Its `error.type` is the error's `errorType` if it has one, then
+     * its `code` if that is a string (such as Node's `'ECONNREFUSED'`), then its class name.
+     */
+    fail(error: unknown): void;
+    /**
+     * Ends the run as failed without an error, for example when an expected input file is missing. `code` must be
+     * a short, stable value such as `'statement_missing'`; never put messages or IDs in it.
+     */
+    failCode(code: string, description?: string): void;
+    /** Ends the run as cancelled, for example on shutdown. Cancelled runs do not count as failures. */
+    cancel(): void;
+}
+/** A process-wide registry on the global OpenTelemetry providers. */
+export declare const defaultRegistry: WorkloadRegistry;
+export { toWorkloadName };

package/dist/registry.js

@@ -0,0 +1,353 @@
+import { context, metrics, SpanKind, SpanStatusCode, trace, } from '@opentelemetry/api';
+import { mkdirSync, renameSync, writeFileSync } from 'node:fs';
+import { basename, dirname } from 'node:path';
+import { performance } from 'node:perf_hooks';
+import { toWorkloadName, validateName } from './naming.js';
+import { Attributes, DURATION_BUCKETS, Metrics, SCOPE_NAME, VERSION } from './telemetry.js';
+/** Thrown when a workload's options are invalid or declared twice. */
+export class WorkloadConfigurationError extends Error {
+    name = 'WorkloadConfigurationError';
+}
+const UNIT_MS = { s: 1000, m: 60_000, h: 3_600_000, d: 86_400_000 };
+function toMs(value, option) {
+    if (typeof value === 'number') {
+        if (!Number.isFinite(value) || value <= 0)
+            throw new WorkloadConfigurationError(`${option} must be a positive number of milliseconds.`);
+        return value;
+    }
+    const match = /^(\d+(?:\.\d+)?)([smhd])$/.exec(value.trim());
+    if (!match)
+        throw new WorkloadConfigurationError(`${option} '${value}' is not a duration. Use milliseconds or a number with s, m, h or d, such as '30m'.`);
+    return Number(match[1]) * UNIT_MS[match[2]];
+}
+function toExpectations(options) {
+    const { failureRateThreshold: rate, minProcessed } = options;
+    if (rate !== undefined && (rate < 0 || rate > 1))
+        throw new WorkloadConfigurationError(`failureRateThreshold must be between 0 and 1, got ${rate}.`);
+    if (minProcessed !== undefined && (!Number.isInteger(minProcessed) || minProcessed < 0))
+        throw new WorkloadConfigurationError('minProcessed must be a non-negative integer.');
+    const severity = options.severity ?? 'warning';
+    if (!['info', 'warning', 'critical'].includes(severity))
+        throw new WorkloadConfigurationError(`Unknown severity '${severity}'.`);
+    return {
+        severity,
+        ...(options.schedule !== undefined && { schedule: options.schedule }),
+        ...(options.maxDuration !== undefined && { maxDurationMs: toMs(options.maxDuration, 'maxDuration') }),
+        ...(options.expectEvery !== undefined && { expectEveryMs: toMs(options.expectEvery, 'expectEvery') }),
+        ...(minProcessed !== undefined && { minProcessed }),
+        ...(rate !== undefined && { failureRateThreshold: rate }),
+    };
+}
+/** Creates and holds the workloads of an application and the instruments they record on. */
+export class WorkloadRegistry {
+    #workloads = new Map();
+    #meterProvider;
+    #instruments;
+    /** @internal */ tracer;
+    /**
+     * By default the registry records on the global OpenTelemetry providers. It follows the global meter provider
+     * when it changes, so it works even when it is created, for example by an import, before the SDK starts.
+     */
+    constructor(options = {}) {
+        this.#meterProvider = options.meterProvider;
+        this.#instruments = this.#createInstruments(options.meterProvider ?? metrics.getMeterProvider());
+        if (options.tracing !== false) {
+            // The global tracer provider is a proxy that follows the SDK, unlike the global meter provider.
+            this.tracer = (options.tracerProvider ?? trace.getTracerProvider()).getTracer(SCOPE_NAME, VERSION);
+        }
+    }
+    /** @internal The instruments to record on, recreated if the global meter provider has changed. */
+    get instruments() {
+        if (this.#meterProvider === undefined) {
+            const current = metrics.getMeterProvider();
+            if (current !== this.#instruments.provider)
+                this.#instruments = this.#createInstruments(current);
+        }
+        return this.#instruments;
+    }
+    #createInstruments(provider) {
+        const meter = provider.getMeter(SCOPE_NAME, VERSION);
+        const sinceSuccess = meter.createObservableGauge(Metrics.sinceSuccess, {
+            unit: 's',
+            description: 'Seconds since the last successful run of a workload, or since it was registered.',
+        });
+        const sinceHeartbeat = meter.createObservableGauge(Metrics.sinceHeartbeat, {
+            unit: 's',
+            description: 'Seconds since the last heartbeat of a workload, or since it was registered.',
+        });
+        meter.addBatchObservableCallback((observer) => {
+            const now = performance.now();
+            for (const workload of this.#workloads.values()) {
+                const success = workload.secondsSinceSuccess(now);
+                if (success !== undefined)
+                    observer.observe(sinceSuccess, success, workload.nameAttributes);
+                const heartbeat = workload.secondsSinceHeartbeat(now);
+                if (heartbeat !== undefined)
+                    observer.observe(sinceHeartbeat, heartbeat, workload.nameAttributes);
+            }
+        }, [sinceSuccess, sinceHeartbeat]);
+        return {
+            provider,
+            runs: meter.createCounter(Metrics.runs, { unit: '{run}', description: 'Completed runs of a workload.' }),
+            duration: meter.createHistogram(Metrics.duration, {
+                unit: 's',
+                description: 'Duration of workload runs.',
+                advice: { explicitBucketBoundaries: [...DURATION_BUCKETS] },
+            }),
+            items: meter.createCounter(Metrics.items, { unit: '{item}', description: 'Items handled by workload runs.' }),
+            heartbeats: meter.createCounter(Metrics.heartbeats, { unit: '{heartbeat}', description: 'Heartbeats of long-running workloads.' }),
+        };
+    }
+    /**
+     * Returns the workload called `name`, creating it with `options` on first use. Call it once and keep the
+     * result. Passing options for a workload that already exists throws, so expectations are declared in exactly
+     * one place.
+     */
+    workload(name, options) {
+        const existing = this.#workloads.get(name);
+        if (existing) {
+            if (options !== undefined) {
+                throw new WorkloadConfigurationError(`Workload '${name}' is already registered; set its options only where it is first created.`);
+            }
+            return existing;
+        }
+        return this.getOrAdd(name, options);
+    }
+    /**
+     * Returns the workload called `name`, creating it with `options` if it does not exist yet. Unlike `workload`,
+     * an existing workload is returned as is: options declared elsewhere take precedence. Scheduler integrations
+     * use it to name workloads after jobs.
+     */
+    getOrAdd(name, options = {}) {
+        const existing = this.#workloads.get(name);
+        if (existing)
+            return existing;
+        validateName(name);
+        const created = new Workload(this, name, toExpectations(options));
+        this.#workloads.set(name, created);
+        return created;
+    }
+    /** Every workload created so far, sorted by name. */
+    get workloads() {
+        return [...this.#workloads.values()].sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0));
+    }
+    /** Describes every workload, for alert provisioning. `service` must match the OpenTelemetry `service.name`. */
+    manifest(service) {
+        return {
+            version: 1,
+            service,
+            workloads: this.workloads.map(({ name, expectations: e }) => ({
+                name,
+                ...(e.schedule !== undefined && { schedule: e.schedule }),
+                ...(e.maxDurationMs !== undefined && { maxDurationSeconds: e.maxDurationMs / 1000 }),
+                ...(e.expectEveryMs !== undefined && { expectEverySeconds: e.expectEveryMs / 1000 }),
+                ...(e.minProcessed && { minProcessed: e.minProcessed }),
+                ...(e.failureRateThreshold && { failureRateThreshold: e.failureRateThreshold }),
+                severity: e.severity,
+            })),
+        };
+    }
+    /** Writes the manifest as indented JSON, atomically, so a reader never sees half a manifest. */
+    writeManifest(path, service) {
+        mkdirSync(dirname(path), { recursive: true });
+        writeFileSync(`${path}.tmp`, JSON.stringify(this.manifest(service), null, 2));
+        renameSync(`${path}.tmp`, path);
+    }
+    /**
+     * Writes the manifest if the RUNSIGNAL_MANIFEST_PATH environment variable is set, so CI can ask for one
+     * without code changes. Call it once every workload has been registered. The service name is `service`, or
+     * else OTEL_SERVICE_NAME, or else the script name. Returns the path written, or undefined.
+     */
+    writeManifestFromEnv(service) {
+        const path = process.env.RUNSIGNAL_MANIFEST_PATH?.trim();
+        if (!path)
+            return undefined;
+        this.writeManifest(path, service || process.env.OTEL_SERVICE_NAME || basename(process.argv[1] ?? 'node', '.js'));
+        return path;
+    }
+}
+/**
+ * A unit of background work, such as a scheduled job, a queue consumer or a sync loop. Get one from a
+ * WorkloadRegistry once and keep it.
+ */
+export class Workload {
+    name;
+    expectations;
+    /** @internal */ nameAttributes;
+    #registry;
+    #outcomeAttributes;
+    #processed;
+    #failed;
+    // performance.now() timestamps. Until the first success or heartbeat they hold the time the workload was
+    // created, so a workload that never succeeds or never beats still reports a growing age.
+    #lastSuccess;
+    #lastHeartbeat;
+    #hasStarted = false;
+    #hasBeaten = false;
+    /** @internal */
+    constructor(registry, name, expectations) {
+        this.name = name;
+        this.expectations = expectations;
+        this.#registry = registry;
+        this.nameAttributes = Object.freeze({ [Attributes.workload]: name });
+        this.#outcomeAttributes = {
+            success: Object.freeze({ [Attributes.workload]: name, [Attributes.outcome]: 'success' }),
+            failure: Object.freeze({ [Attributes.workload]: name, [Attributes.outcome]: 'failure' }),
+            cancelled: Object.freeze({ [Attributes.workload]: name, [Attributes.outcome]: 'cancelled' }),
+        };
+        this.#processed = Object.freeze({ [Attributes.workload]: name, [Attributes.itemResult]: 'processed' });
+        this.#failed = Object.freeze({ [Attributes.workload]: name, [Attributes.itemResult]: 'failed' });
+        this.#lastSuccess = this.#lastHeartbeat = performance.now();
+    }
+    /**
+     * Starts a run. End it with exactly one call to `succeed`, `fail`, `failCode` or `cancel`; later calls are
+     * ignored. Prefer `run`, which ends the run for you and makes the run's span active for `fn`.
+     */
+    start() {
+        this.#hasStarted = true;
+        const span = this.#registry.tracer?.startSpan(this.name, { kind: SpanKind.INTERNAL, attributes: this.nameAttributes });
+        return new Run(this, performance.now(), span);
+    }
+    /**
+     * Runs `fn` as one run of the workload: it succeeds when `fn` resolves, is cancelled when `fn` rejects after
+     * `signal` was aborted, and fails otherwise. The result or error of `fn` is passed through.
+     */
+    async run(fn, options = {}) {
+        const run = this.start();
+        const active = run.span ? trace.setSpan(context.active(), run.span) : context.active();
+        try {
+            const result = await context.with(active, () => fn(options.signal));
+            run.succeed();
+            return result;
+        }
+        catch (error) {
+            if (options.signal?.aborted)
+                run.cancel();
+            else
+                run.fail(error);
+            throw error;
+        }
+    }
+    /** Records `count` successfully processed items. Recording 0 is useful: it reports that a run did nothing. */
+    processed(count = 1) {
+        if (count >= 0)
+            this.#registry.instruments.items.add(count, this.#processed);
+    }
+    /** Records `count` items that could not be processed. */
+    itemFailed(count = 1) {
+        if (count >= 0)
+            this.#registry.instruments.items.add(count, this.#failed);
+    }
+    /** Records a heartbeat: the workload is alive and making progress. */
+    beat() {
+        this.#lastHeartbeat = performance.now();
+        this.#hasBeaten = true;
+        this.#registry.instruments.heartbeats.add(1, this.nameAttributes);
+    }
+    /** @internal */
+    complete(start, span, outcome, errorType, error, description) {
+        const now = performance.now();
+        const instruments = this.#registry.instruments;
+        if (errorType === undefined) {
+            instruments.runs.add(1, this.#outcomeAttributes[outcome]);
+        }
+        else {
+            instruments.runs.add(1, { ...this.#outcomeAttributes.failure, [Attributes.errorType]: errorType });
+        }
+        instruments.duration.record((now - start) / 1000, this.#outcomeAttributes[outcome]);
+        if (outcome === 'success')
+            this.#lastSuccess = now;
+        if (span) {
+            if (span.isRecording()) {
+                span.setAttribute(Attributes.outcome, outcome);
+                if (outcome === 'failure') {
+                    span.setAttribute(Attributes.errorType, errorType);
+                    if (error instanceof Error)
+                        span.recordException(error);
+                    span.setStatus({ code: SpanStatusCode.ERROR, ...(description !== undefined && { message: description }) });
+                }
+                else if (outcome === 'success') {
+                    span.setStatus({ code: SpanStatusCode.OK });
+                }
+            }
+            span.end();
+        }
+    }
+    // Reported for workloads that are scheduled or have run, so alerts can tell a missed run from a workload
+    // that simply has no runs.
+    /** @internal */
+    secondsSinceSuccess(now) {
+        return this.#hasStarted || this.expectations.schedule !== undefined ? (now - this.#lastSuccess) / 1000 : undefined;
+    }
+    // Reported for workloads that expect heartbeats or have sent one.
+    /** @internal */
+    secondsSinceHeartbeat(now) {
+        return this.#hasBeaten || this.expectations.expectEveryMs !== undefined ? (now - this.#lastHeartbeat) / 1000 : undefined;
+    }
+}
+/** One run of a Workload, started with `Workload.start`. */
+export class Run {
+    workload;
+    started;
+    span;
+    #ended = false;
+    /** @internal */
+    constructor(workload, started, span) {
+        this.workload = workload;
+        this.started = started;
+        this.span = span;
+    }
+    /** Milliseconds since the run started. */
+    get elapsedMs() {
+        return performance.now() - this.started;
+    }
+    /** Ends the run as successful. */
+    succeed() {
+        if (this.#end())
+            this.workload.complete(this.started, this.span, 'success');
+    }
+    /**
+     * Ends the run as failed because of `error`. Its `error.type` is the error's `errorType` if it has one, then
+     * its `code` if that is a string (such as Node's `'ECONNREFUSED'`), then its class name.
+     */
+    fail(error) {
+        if (this.#end())
+            this.workload.complete(this.started, this.span, 'failure', errorTypeOf(error), error, error instanceof Error ? error.message : String(error));
+    }
+    /**
+     * Ends the run as failed without an error, for example when an expected input file is missing. `code` must be
+     * a short, stable value such as `'statement_missing'`; never put messages or IDs in it.
+     */
+    failCode(code, description) {
+        if (this.#end())
+            this.workload.complete(this.started, this.span, 'failure', code || 'unknown', undefined, description);
+    }
+    /** Ends the run as cancelled, for example on shutdown. Cancelled runs do not count as failures. */
+    cancel() {
+        if (this.#end())
+            this.workload.complete(this.started, this.span, 'cancelled');
+    }
+    #end() {
+        if (this.#ended)
+            return false;
+        this.#ended = true;
+        return true;
+    }
+}
+function errorTypeOf(error) {
+    if (typeof error === 'object' && error !== null) {
+        const { errorType, code } = error;
+        if (typeof errorType === 'string' && errorType)
+            return errorType;
+        if (typeof code === 'string' && code)
+            return code;
+        const name = error.constructor?.name;
+        if (name && name !== 'Object')
+            return name;
+    }
+    return typeof error;
+}
+/** A process-wide registry on the global OpenTelemetry providers. */
+export const defaultRegistry = new WorkloadRegistry();
+export { toWorkloadName };
+//# sourceMappingURL=registry.js.map

package/dist/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","sourceRoot":"","sources":["../src/registry.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EACP,OAAO,EACP,QAAQ,EACR,cAAc,EACd,KAAK,GAQN,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAmD5F,sEAAsE;AACtE,MAAM,OAAO,0BAA2B,SAAQ,KAAK;IAC1C,IAAI,GAAG,4BAA4B,CAAC;CAC9C;AAED,MAAM,OAAO,GAA2B,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC;AAE5F,SAAS,IAAI,CAAC,KAAe,EAAE,MAAc;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;YAAE,MAAM,IAAI,0BAA0B,CAAC,GAAG,MAAM,6CAA6C,CAAC,CAAC;QACxI,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,KAAK,GAAG,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAC7D,IAAI,CAAC,KAAK;QAAE,MAAM,IAAI,0BAA0B,CAAC,GAAG,MAAM,KAAK,KAAK,qFAAqF,CAAC,CAAC;IAC3J,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAE,CAAE,CAAC;AAChD,CAAC;AAED,SAAS,cAAc,CAAC,OAAwB;IAC9C,MAAM,EAAE,oBAAoB,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;IAC7D,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;QAAE,MAAM,IAAI,0BAA0B,CAAC,qDAAqD,IAAI,GAAG,CAAC,CAAC;IACrJ,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,YAAY,GAAG,CAAC,CAAC;QAAE,MAAM,IAAI,0BAA0B,CAAC,8CAA8C,CAAC,CAAC;IAC9K,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,SAAS,CAAC;IAC/C,IAAI,CAAC,CAAC,MAAM,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,MAAM,IAAI,0BAA0B,CAAC,qBAAqB,QAAQ,IAAI,CAAC,CAAC;IACjI,OAAO;QACL,QAAQ;QACR,GAAG,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrE,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC;QACrG,GAAG,CAAC,OAAO,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC;QACrG,GAAG,CAAC,YAAY,KAAK,SAAS,IAAI,EAAE,YAAY,EAAE,CAAC;QACnD,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;KAC1D,CAAC;AACJ,CAAC;AAWD,4FAA4F;AAC5F,MAAM,OAAO,gBAAgB;IAClB,UAAU,GAAG,IAAI,GAAG,EAAoB,CAAC;IACzC,cAAc,CAA4B;IACnD,YAAY,CAAc;IAC1B,gBAAgB,CAAU,MAAM,CAAqB;IAErD;;;OAGG;IACH,YAAY,OAAO,GAAoB,EAAE;QACvC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;QAC5C,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACjG,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC9B,gGAAgG;YAChG,IAAI,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,cAAc,IAAI,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrG,CAAC;IACH,CAAC;IAED,kGAAkG;IAClG,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,OAAO,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC3C,IAAI,OAAO,KAAK,IAAI,CAAC,YAAY,CAAC,QAAQ;gBAAE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACnG,CAAC;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED,kBAAkB,CAAC,QAAuB;QACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrD,MAAM,YAAY,GAAG,KAAK,CAAC,qBAAqB,CAAC,OAAO,CAAC,YAAY,EAAE;YACrE,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,kFAAkF;SAChG,CAAC,CAAC;QACH,MAAM,cAAc,GAAG,KAAK,CAAC,qBAAqB,CAAC,OAAO,CAAC,cAAc,EAAE;YACzE,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,6EAA6E;SAC3F,CAAC,CAAC;QACH,KAAK,CAAC,0BAA0B,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC5C,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAC9B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;gBAChD,MAAM,OAAO,GAAG,QAAQ,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC;gBAClD,IAAI,OAAO,KAAK,SAAS;oBAAE,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,OAAO,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;gBAC5F,MAAM,SAAS,GAAG,QAAQ,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC;gBACtD,IAAI,SAAS,KAAK,SAAS;oBAAE,QAAQ,CAAC,OAAO,CAAC,cAAc,EAAE,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;YACpG,CAAC;QACH,CAAC,EAAE,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC,CAAC;QAEnC,OAAO;YACL,QAAQ;YACR,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,+BAA+B,EAAE,CAAC;YACxG,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,QAAQ,EAAE;gBAChD,IAAI,EAAE,GAAG;gBACT,WAAW,EAAE,4BAA4B;gBACzC,MAAM,EAAE,EAAE,wBAAwB,EAAE,CAAC,GAAG,gBAAgB,CAAC,EAAE;aAC5D,CAAC;YACF,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,iCAAiC,EAAE,CAAC;YAC7G,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,uCAAuC,EAAE,CAAC;SACnI,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAyB;QAC9C,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,MAAM,IAAI,0BAA0B,CAAC,aAAa,IAAI,0EAA0E,CAAC,CAAC;YACpI,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,QAAQ,CAAC,IAAY,EAAE,OAAO,GAAoB,EAAE;QAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAC9B,YAAY,CAAC,IAAI,CAAC,CAAC;QACnB,MAAM,OAAO,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;QAClE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,qDAAqD;IACrD,IAAI,SAAS;QACX,OAAO,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACxG,CAAC;IAED,+GAA+G;IAC/G,QAAQ,CAAC,OAAe;QACtB,OAAO;YACL,OAAO,EAAE,CAAC;YACV,OAAO;YACP,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC5D,IAAI;gBACJ,GAAG,CAAC,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACzD,GAAG,CAAC,CAAC,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC,aAAa,GAAG,IAAI,EAAE,CAAC;gBACpF,GAAG,CAAC,CAAC,CAAC,aAAa,KAAK,SAAS,IAAI,EAAE,kBAAkB,EAAE,CAAC,CAAC,aAAa,GAAG,IAAI,EAAE,CAAC;gBACpF,GAAG,CAAC,CAAC,CAAC,YAAY,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC;gBACvD,GAAG,CAAC,CAAC,CAAC,oBAAoB,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAC,oBAAoB,EAAE,CAAC;gBAC/E,QAAQ,EAAE,CAAC,CAAC,QAAQ;aACrB,CAAC,CAAC;SACJ,CAAC;IACJ,CAAC;IAED,gGAAgG;IAChG,aAAa,CAAC,IAAY,EAAE,OAAe;QACzC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,aAAa,CAAC,GAAG,IAAI,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9E,UAAU,CAAC,GAAG,IAAI,MAAM,EAAE,IAAI,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,OAAgB;QACnC,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,IAAI,EAAE,CAAC;QACzD,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAC5B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAmBD;;;GAGG;AACH,MAAM,OAAO,QAAQ;IAe8B,IAAI;IAAmB,YAAY;IAdpF,gBAAgB,CAAU,cAAc,CAAiB;IAChD,SAAS,CAAmB;IAC5B,kBAAkB,CAAkC;IACpD,UAAU,CAAiB;IAC3B,OAAO,CAAiB;IAEjC,yGAAyG;IACzG,yFAAyF;IACzF,YAAY,CAAS;IACrB,cAAc,CAAS;IACvB,WAAW,GAAG,KAAK,CAAC;IACpB,UAAU,GAAG,KAAK,CAAC;IAEnB,gBAAgB;IAChB,YAAY,QAA0B,EAAW,IAAY,EAAW,YAA0B;oBAAjD,IAAI;4BAAmB,YAAY;QAClF,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,IAAI,CAAC,kBAAkB,GAAG;YACxB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;YACxF,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;YACxF,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;SAC7F,CAAC;QACF,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QACvG,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QACjG,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAC9D,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,QAAQ,EAAE,UAAU,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;QACvH,OAAO,IAAI,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,GAAG,CAAI,EAA4C,EAAE,OAAO,GAA6B,EAAE;QAC/F,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACvF,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YACpE,GAAG,CAAC,OAAO,EAAE,CAAC;YACd,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO;gBAAE,GAAG,CAAC,MAAM,EAAE,CAAC;;gBACrC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,8GAA8G;IAC9G,SAAS,CAAC,KAAK,GAAG,CAAC;QACjB,IAAI,KAAK,IAAI,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC/E,CAAC;IAED,yDAAyD;IACzD,UAAU,CAAC,KAAK,GAAG,CAAC;QAClB,IAAI,KAAK,IAAI,CAAC;YAAE,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC5E,CAAC;IAED,sEAAsE;IACtE,IAAI;QACF,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACxC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACpE,CAAC;IAED,gBAAgB;IAChB,QAAQ,CAAC,KAAa,EAAE,IAAsB,EAAE,OAAgB,EAAE,SAAkB,EAAE,KAAe,EAAE,WAAoB;QACzH,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAC9B,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;QAC/C,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;YAC5B,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;QAC5D,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACrG,CAAC;QACD,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;QACpF,IAAI,OAAO,KAAK,SAAS;YAAE,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC;QAEnD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBACvB,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC/C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,EAAE,SAAU,CAAC,CAAC;oBACpD,IAAI,KAAK,YAAY,KAAK;wBAAE,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;oBACxD,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,GAAG,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;gBAC7G,CAAC;qBAAM,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBACjC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YACD,IAAI,CAAC,GAAG,EAAE,CAAC;QACb,CAAC;IACH,CAAC;IAED,yGAAyG;IACzG,2BAA2B;IAC3B,gBAAgB;IAChB,mBAAmB,CAAC,GAAW;QAC7B,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IACrH,CAAC;IAED,kEAAkE;IAClE,gBAAgB;IAChB,qBAAqB,CAAC,GAAW;QAC/B,OAAO,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3H,CAAC;CACF;AAED,4DAA4D;AAC5D,MAAM,OAAO,GAAG;IAIO,QAAQ;IAA6B,OAAO;IAAmB,IAAI;IAHxF,MAAM,GAAG,KAAK,CAAC;IAEf,gBAAgB;IAChB,YAAqB,QAAkB,EAAmB,OAAe,EAAW,IAAsB;wBAArF,QAAQ;uBAA6B,OAAO;oBAAmB,IAAI;IAAqB,CAAC;IAE9G,0CAA0C;IAC1C,IAAI,SAAS;QACX,OAAO,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;IAC1C,CAAC;IAED,kCAAkC;IAClC,OAAO;QACL,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,KAAc;QACjB,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACjK,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAY,EAAE,WAAoB;QACzC,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IACzH,CAAC;IAED,mGAAmG;IACnG,MAAM;QACJ,IAAI,IAAI,CAAC,IAAI,EAAE;YAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAChF,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,KAAK,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,KAAgD,CAAC;QAC7E,IAAI,OAAO,SAAS,KAAK,QAAQ,IAAI,SAAS;YAAE,OAAO,SAAS,CAAC;QACjE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QAClD,MAAM,IAAI,GAAG,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC;QACrC,IAAI,IAAI,IAAI,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;IAC7C,CAAC;IACD,OAAO,OAAO,KAAK,CAAC;AACtB,CAAC;AAED,qEAAqE;AACrE,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,gBAAgB,EAAE,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/telemetry.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Names of the meter, tracer, instruments and attributes RunSignal emits. They are identical in every RunSignal
+ * SDK (see spec/README.md in the repository), so one set of alert rules covers every language.
+ */
+export declare const SCOPE_NAME = "RunSignal";
+export declare const VERSION = "0.1.0";
+export declare const Metrics: {
+    readonly runs: 'runsignal.workload.runs';
+    readonly duration: 'runsignal.workload.duration';
+    readonly items: 'runsignal.workload.items';
+    readonly heartbeats: 'runsignal.workload.heartbeats';
+    readonly sinceSuccess: 'runsignal.workload.since_success';
+    readonly sinceHeartbeat: 'runsignal.workload.since_heartbeat';
+};
+export declare const Attributes: {
+    readonly workload: 'runsignal.workload';
+    readonly outcome: 'runsignal.outcome';
+    readonly itemResult: 'runsignal.item.result';
+    readonly errorType: 'error.type';
+};
+/**
+ * Histogram bucket boundaries, in seconds, for the duration metric: background work runs from milliseconds to
+ * hours, while the OpenTelemetry defaults stop at 10 seconds.
+ */
+export declare const DURATION_BUCKETS: readonly number[];

package/dist/telemetry.js

@@ -0,0 +1,28 @@
+/**
+ * Names of the meter, tracer, instruments and attributes RunSignal emits. They are identical in every RunSignal
+ * SDK (see spec/README.md in the repository), so one set of alert rules covers every language.
+ */
+export const SCOPE_NAME = 'RunSignal';
+export const VERSION = '0.1.0';
+export const Metrics = {
+    runs: 'runsignal.workload.runs',
+    duration: 'runsignal.workload.duration',
+    items: 'runsignal.workload.items',
+    heartbeats: 'runsignal.workload.heartbeats',
+    sinceSuccess: 'runsignal.workload.since_success',
+    sinceHeartbeat: 'runsignal.workload.since_heartbeat',
+};
+export const Attributes = {
+    workload: 'runsignal.workload',
+    outcome: 'runsignal.outcome',
+    itemResult: 'runsignal.item.result',
+    errorType: 'error.type',
+};
+/**
+ * Histogram bucket boundaries, in seconds, for the duration metric: background work runs from milliseconds to
+ * hours, while the OpenTelemetry defaults stop at 10 seconds.
+ */
+export const DURATION_BUCKETS = [
+    0.01, 0.05, 0.1, 0.5, 1, 5, 10, 30, 60, 120, 300, 600, 900, 1800, 3600, 7200, 14400, 28800,
+];
+//# sourceMappingURL=telemetry.js.map

package/dist/telemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.js","sourceRoot":"","sources":["../src/telemetry.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,WAAW,CAAC;AACtC,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC;AAE/B,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI,EAAE,yBAAyB;IAC/B,QAAQ,EAAE,6BAA6B;IACvC,KAAK,EAAE,0BAA0B;IACjC,UAAU,EAAE,+BAA+B;IAC3C,YAAY,EAAE,kCAAkC;IAChD,cAAc,EAAE,oCAAoC;CAC5C,CAAC;AAEX,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,QAAQ,EAAE,oBAAoB;IAC9B,OAAO,EAAE,mBAAmB;IAC5B,UAAU,EAAE,uBAAuB;IACnC,SAAS,EAAE,YAAY;CACf,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAsB;IACjD,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK;CAC3F,CAAC"}

package/package.json

@@ -1,6 +1,75 @@
 {
   "name": "@runsignal/node",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Monitor Node.js background work that no HTTP status code describes (scheduled jobs, BullMQ queues, sync loops) with OpenTelemetry, and alert on missed, overrunning, stalled or low-output jobs.",
+  "license": "MIT",
+  "author": "Gokhan Ertogan",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gokhanertogan/RunSignal.git",
+    "directory": "src/RunSignal.Node"
+  },
+  "keywords": [
+    "observability",
+    "opentelemetry",
+    "monitoring",
+    "alerting",
+    "background-jobs",
+    "cron",
+    "heartbeat",
+    "bullmq",
+    "newrelic"
+  ],
+  "type": "module",
+  "engines": {
+    "node": ">=20"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./bullmq": {
+      "types": "./dist/bullmq.d.ts",
+      "default": "./dist/bullmq.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "tsc -p tsconfig.test.json && node --test --test-concurrency=1 'dist-test/test/**/*.test.js'",
+    "bench": "tsc -p tsconfig.test.json && node dist-test/test/bench.js",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "bullmq": ">=5.16.0"
+  },
+  "peerDependenciesMeta": {
+    "bullmq": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/context-async-hooks": "^2.12.0",
+    "@opentelemetry/sdk-metrics": "^2.12.0",
+    "@opentelemetry/sdk-trace-base": "^2.12.0",
+    "@types/node": "^26.6.5",
+    "bullmq": "^6.4.0",
+    "ioredis": "^6.0.0",
+    "typescript": "^7.0.2"
+  },
+  "homepage": "https://github.com/gokhanertogan/RunSignal/tree/main/src/RunSignal.Node#readme",
+  "bugs": {
+    "url": "https://github.com/gokhanertogan/RunSignal/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "sideEffects": false
+}