@3sixty/telemetry-producers 0.0.0-stage → 0.20.0-next.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty Telemetry Producers
 
-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.
+This package provides metrics producers that collect Node.js process and host-level system metrics on each poll cycle and publish them through the shared telemetry component.
+
+## Installation
+
+```shell
+npm install @3sixty/telemetry-producers
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-telemetry](https://github.com/iotaledger/twin-telemetry/tree/next/packages/telemetry-producers) repository.

package/dist/es/index.js

@@ -0,0 +1,7 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./models/IProcessMetricsProducerConstructorOptions.js";
+export * from "./models/ISystemMetricsProducerConstructorOptions.js";
+export * from "./processMetricsProducer.js";
+export * from "./systemMetricsProducer.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,uDAAuD,CAAC;AACtE,cAAc,sDAAsD,CAAC;AACrE,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/IProcessMetricsProducerConstructorOptions.js\";\nexport * from \"./models/ISystemMetricsProducerConstructorOptions.js\";\nexport * from \"./processMetricsProducer.js\";\nexport * from \"./systemMetricsProducer.js\";\n"]}

package/dist/es/models/IProcessMetricsProducerConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IProcessMetricsProducerConstructorOptions.js.map

package/dist/es/models/IProcessMetricsProducerConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IProcessMetricsProducerConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IProcessMetricsProducerConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The options for the process metrics producer constructor.\n */\nexport interface IProcessMetricsProducerConstructorOptions {\n\t/**\n\t * Type name of the telemetry component in `ComponentFactory`.\n\t * @default telemetry\n\t */\n\ttelemetryComponentType?: string;\n\n\t/**\n\t * Per-metric history cap.\n\t * @default 1440\n\t */\n\tmaxHistory?: number;\n}\n"]}

package/dist/es/models/ISystemMetricsProducerConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=ISystemMetricsProducerConstructorOptions.js.map

package/dist/es/models/ISystemMetricsProducerConstructorOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISystemMetricsProducerConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ISystemMetricsProducerConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The options for the system metrics producer constructor.\n */\nexport interface ISystemMetricsProducerConstructorOptions {\n\t/**\n\t * Type name of the telemetry component in `ComponentFactory`.\n\t * @default telemetry\n\t */\n\ttelemetryComponentType?: string;\n\n\t/**\n\t * Per-metric history cap.\n\t * @default 1440\n\t */\n\tmaxHistory?: number;\n}\n"]}

package/dist/es/processMetricsProducer.js

@@ -0,0 +1,82 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory } from "@3sixty/core";
+import { MetricHelper, MetricType } from "@3sixty/telemetry-models";
+/**
+ * Metrics producer that emits Node.js process metrics on every poll cycle.
+ */
+export class ProcessMetricsProducer {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ProcessMetricsProducer";
+    /**
+     * Resolved telemetry component.
+     * @internal
+     */
+    _telemetry;
+    /**
+     * Per-metric history cap.
+     * @internal
+     */
+    _maxHistory;
+    /**
+     * Create a new instance of ProcessMetricsProducer.
+     * @param options The options for the producer.
+     */
+    constructor(options) {
+        this._telemetry = ComponentFactory.get(options?.telemetryComponentType ?? "telemetry");
+        this._maxHistory = options?.maxHistory ?? 1440;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return ProcessMetricsProducer.CLASS_NAME;
+    }
+    /**
+     * Register all process metrics with the telemetry component.
+     * @returns A promise that resolves when all process metrics have been registered.
+     */
+    async register() {
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "process_memory_rss_bytes",
+            label: "RSS memory",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "process_memory_heap_used_bytes",
+            label: "Heap used",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "process_memory_heap_total_bytes",
+            label: "Heap total",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "process_uptime_seconds",
+            label: "Process uptime",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+    }
+    /**
+     * Read the current process metric values.
+     * @returns The current values for the process metrics.
+     */
+    async collect() {
+        const mem = process.memoryUsage();
+        return [
+            { id: "process_memory_rss_bytes", value: mem.rss },
+            { id: "process_memory_heap_used_bytes", value: mem.heapUsed },
+            { id: "process_memory_heap_total_bytes", value: mem.heapTotal },
+            { id: "process_uptime_seconds", value: Number(process.uptime().toFixed(1)) }
+        ];
+    }
+}
+//# sourceMappingURL=processMetricsProducer.js.map

package/dist/es/processMetricsProducer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processMetricsProducer.js","sourceRoot":"","sources":["../../src/processMetricsProducer.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EACN,YAAY,EACZ,UAAU,EAIV,MAAM,0BAA0B,CAAC;AAGlC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAClC;;OAEG;IACI,MAAM,CAAU,UAAU,4BAA4C;IAE7E;;;OAGG;IACc,UAAU,CAAsB;IAEjD;;;OAGG;IACc,WAAW,CAAS;IAErC;;;OAGG;IACH,YAAY,OAAmD;QAC9D,IAAI,CAAC,UAAU,GAAG,gBAAgB,CAAC,GAAG,CACrC,OAAO,EAAE,sBAAsB,IAAI,WAAW,CAC9C,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,UAAU,IAAI,IAAI,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,sBAAsB,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,0BAA0B;YAC9B,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,gCAAgC;YACpC,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,iCAAiC;YACrC,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,wBAAwB;YAC5B,KAAK,EAAE,gBAAgB;YACvB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;QAElC,OAAO;YACN,EAAE,EAAE,EAAE,0BAA0B,EAAE,KAAK,EAAE,GAAG,CAAC,GAAG,EAAE;YAClD,EAAE,EAAE,EAAE,gCAAgC,EAAE,KAAK,EAAE,GAAG,CAAC,QAAQ,EAAE;YAC7D,EAAE,EAAE,EAAE,iCAAiC,EAAE,KAAK,EAAE,GAAG,CAAC,SAAS,EAAE;YAC/D,EAAE,EAAE,EAAE,wBAAwB,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;SAC5E,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory } from \"@3sixty/core\";\nimport { nameof } from \"@3sixty/nameof\";\nimport {\n\tMetricHelper,\n\tMetricType,\n\ttype IMetricsProducer,\n\ttype ITelemetryComponent,\n\ttype ITelemetryMetricValueEntry\n} from \"@3sixty/telemetry-models\";\nimport type { IProcessMetricsProducerConstructorOptions } from \"./models/IProcessMetricsProducerConstructorOptions.js\";\n\n/**\n * Metrics producer that emits Node.js process metrics on every poll cycle.\n */\nexport class ProcessMetricsProducer implements IMetricsProducer {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ProcessMetricsProducer>();\n\n\t/**\n\t * Resolved telemetry component.\n\t * @internal\n\t */\n\tprivate readonly _telemetry: ITelemetryComponent;\n\n\t/**\n\t * Per-metric history cap.\n\t * @internal\n\t */\n\tprivate readonly _maxHistory: number;\n\n\t/**\n\t * Create a new instance of ProcessMetricsProducer.\n\t * @param options The options for the producer.\n\t */\n\tconstructor(options?: IProcessMetricsProducerConstructorOptions) {\n\t\tthis._telemetry = ComponentFactory.get<ITelemetryComponent>(\n\t\t\toptions?.telemetryComponentType ?? \"telemetry\"\n\t\t);\n\t\tthis._maxHistory = options?.maxHistory ?? 1440;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn ProcessMetricsProducer.CLASS_NAME;\n\t}\n\n\t/**\n\t * Register all process metrics with the telemetry component.\n\t * @returns A promise that resolves when all process metrics have been registered.\n\t */\n\tpublic async register(): Promise<void> {\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"process_memory_rss_bytes\",\n\t\t\tlabel: \"RSS memory\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"process_memory_heap_used_bytes\",\n\t\t\tlabel: \"Heap used\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"process_memory_heap_total_bytes\",\n\t\t\tlabel: \"Heap total\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"process_uptime_seconds\",\n\t\t\tlabel: \"Process uptime\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t}\n\n\t/**\n\t * Read the current process metric values.\n\t * @returns The current values for the process metrics.\n\t */\n\tpublic async collect(): Promise<ITelemetryMetricValueEntry[]> {\n\t\tconst mem = process.memoryUsage();\n\n\t\treturn [\n\t\t\t{ id: \"process_memory_rss_bytes\", value: mem.rss },\n\t\t\t{ id: \"process_memory_heap_used_bytes\", value: mem.heapUsed },\n\t\t\t{ id: \"process_memory_heap_total_bytes\", value: mem.heapTotal },\n\t\t\t{ id: \"process_uptime_seconds\", value: Number(process.uptime().toFixed(1)) }\n\t\t];\n\t}\n}\n"]}

package/dist/es/systemMetricsProducer.js

@@ -0,0 +1,125 @@
+// Copyright 2026 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import * as os from "node:os";
+import { ComponentFactory } from "@3sixty/core";
+import { MetricHelper, MetricType } from "@3sixty/telemetry-models";
+/**
+ * Metrics producer that emits host-level OS metrics on every poll cycle.
+ */
+export class SystemMetricsProducer {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "SystemMetricsProducer";
+    /**
+     * Resolved telemetry component.
+     * @internal
+     */
+    _telemetry;
+    /**
+     * Per-metric history cap.
+     * @internal
+     */
+    _maxHistory;
+    /**
+     * Snapshot of CPU times from the previous tick - used to compute deltas.
+     * @internal
+     */
+    _prevCpuTimes;
+    /**
+     * Create a new instance of SystemMetricsProducer.
+     * @param options The options for the producer.
+     */
+    constructor(options) {
+        this._telemetry = ComponentFactory.get(options?.telemetryComponentType ?? "telemetry");
+        this._maxHistory = options?.maxHistory ?? 1440;
+        this._prevCpuTimes = os.cpus().map(c => c.times);
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return SystemMetricsProducer.CLASS_NAME;
+    }
+    /**
+     * Register all system metrics with the telemetry component.
+     * @returns A promise that resolves when all system metrics have been registered.
+     */
+    async register() {
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "system_cpu_usage_percent",
+            label: "CPU usage",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "system_memory_total_bytes",
+            label: "Memory total",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "system_memory_used_bytes",
+            label: "Memory used",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "system_memory_free_bytes",
+            label: "Memory free",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "system_memory_usage_percent",
+            label: "Memory usage",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+        await MetricHelper.createMetric(this._telemetry, {
+            id: "system_uptime_seconds",
+            label: "System uptime",
+            type: MetricType.Gauge,
+            maxHistory: this._maxHistory
+        });
+    }
+    /**
+     * Read the current system metric values.
+     * @returns The current values for the system metrics.
+     */
+    async collect() {
+        const currCpuTimes = os.cpus().map(c => c.times);
+        const usages = currCpuTimes.map((curr, i) => {
+            const prev = this._prevCpuTimes[i];
+            const idle = curr.idle - prev.idle;
+            const total = curr.user -
+                prev.user +
+                curr.nice -
+                prev.nice +
+                curr.sys -
+                prev.sys +
+                curr.idle -
+                prev.idle +
+                curr.irq -
+                prev.irq;
+            const idleDivision = idle / total;
+            const idlePercent = 1 - idleDivision;
+            return total === 0 ? 0 : 100 * idlePercent;
+        });
+        this._prevCpuTimes = currCpuTimes;
+        const avgCpu = usages.reduce((a, b) => a + b, 0) / Math.max(1, usages.length);
+        const total = os.totalmem();
+        const free = os.freemem();
+        const used = total - free;
+        return [
+            { id: "system_cpu_usage_percent", value: Number(avgCpu.toFixed(2)) },
+            { id: "system_memory_total_bytes", value: total },
+            { id: "system_memory_used_bytes", value: used },
+            { id: "system_memory_free_bytes", value: free },
+            { id: "system_memory_usage_percent", value: Number(((100 * used) / total).toFixed(2)) },
+            { id: "system_uptime_seconds", value: Number(os.uptime().toFixed(1)) }
+        ];
+    }
+}
+//# sourceMappingURL=systemMetricsProducer.js.map

package/dist/es/systemMetricsProducer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"systemMetricsProducer.js","sourceRoot":"","sources":["../../src/systemMetricsProducer.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhD,OAAO,EACN,YAAY,EACZ,UAAU,EAIV,MAAM,0BAA0B,CAAC;AAGlC;;GAEG;AACH,MAAM,OAAO,qBAAqB;IACjC;;OAEG;IACI,MAAM,CAAU,UAAU,2BAA2C;IAE5E;;;OAGG;IACc,UAAU,CAAsB;IAEjD;;;OAGG;IACc,WAAW,CAAS;IAErC;;;OAGG;IACK,aAAa,CAAwB;IAE7C;;;OAGG;IACH,YAAY,OAAkD;QAC7D,IAAI,CAAC,UAAU,GAAG,gBAAgB,CAAC,GAAG,CACrC,OAAO,EAAE,sBAAsB,IAAI,WAAW,CAC9C,CAAC;QACF,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,UAAU,IAAI,IAAI,CAAC;QAC/C,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,qBAAqB,CAAC,UAAU,CAAC;IACzC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,0BAA0B;YAC9B,KAAK,EAAE,WAAW;YAClB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,2BAA2B;YAC/B,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,0BAA0B;YAC9B,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,0BAA0B;YAC9B,KAAK,EAAE,aAAa;YACpB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,6BAA6B;YACjC,KAAK,EAAE,cAAc;YACrB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;QACH,MAAM,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE;YAChD,EAAE,EAAE,uBAAuB;YAC3B,KAAK,EAAE,eAAe;YACtB,IAAI,EAAE,UAAU,CAAC,KAAK;YACtB,UAAU,EAAE,IAAI,CAAC,WAAW;SAC5B,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,YAAY,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;YAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;YACnC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;YACnC,MAAM,KAAK,GACV,IAAI,CAAC,IAAI;gBACT,IAAI,CAAC,IAAI;gBACT,IAAI,CAAC,IAAI;gBACT,IAAI,CAAC,IAAI;gBACT,IAAI,CAAC,GAAG;gBACR,IAAI,CAAC,GAAG;gBACR,IAAI,CAAC,IAAI;gBACT,IAAI,CAAC,IAAI;gBACT,IAAI,CAAC,GAAG;gBACR,IAAI,CAAC,GAAG,CAAC;YACV,MAAM,YAAY,GAAG,IAAI,GAAG,KAAK,CAAC;YAClC,MAAM,WAAW,GAAG,CAAC,GAAG,YAAY,CAAC;YACrC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC;QAC5C,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAE9E,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC;QAE1B,OAAO;YACN,EAAE,EAAE,EAAE,0BAA0B,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;YACpE,EAAE,EAAE,EAAE,2BAA2B,EAAE,KAAK,EAAE,KAAK,EAAE;YACjD,EAAE,EAAE,EAAE,0BAA0B,EAAE,KAAK,EAAE,IAAI,EAAE;YAC/C,EAAE,EAAE,EAAE,0BAA0B,EAAE,KAAK,EAAE,IAAI,EAAE;YAC/C,EAAE,EAAE,EAAE,6BAA6B,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;YACvF,EAAE,EAAE,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;SACtE,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2026 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport * as os from \"node:os\";\nimport { ComponentFactory } from \"@3sixty/core\";\nimport { nameof } from \"@3sixty/nameof\";\nimport {\n\tMetricHelper,\n\tMetricType,\n\ttype IMetricsProducer,\n\ttype ITelemetryComponent,\n\ttype ITelemetryMetricValueEntry\n} from \"@3sixty/telemetry-models\";\nimport type { ISystemMetricsProducerConstructorOptions } from \"./models/ISystemMetricsProducerConstructorOptions.js\";\n\n/**\n * Metrics producer that emits host-level OS metrics on every poll cycle.\n */\nexport class SystemMetricsProducer implements IMetricsProducer {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<SystemMetricsProducer>();\n\n\t/**\n\t * Resolved telemetry component.\n\t * @internal\n\t */\n\tprivate readonly _telemetry: ITelemetryComponent;\n\n\t/**\n\t * Per-metric history cap.\n\t * @internal\n\t */\n\tprivate readonly _maxHistory: number;\n\n\t/**\n\t * Snapshot of CPU times from the previous tick - used to compute deltas.\n\t * @internal\n\t */\n\tprivate _prevCpuTimes: os.CpuInfo[\"times\"][];\n\n\t/**\n\t * Create a new instance of SystemMetricsProducer.\n\t * @param options The options for the producer.\n\t */\n\tconstructor(options?: ISystemMetricsProducerConstructorOptions) {\n\t\tthis._telemetry = ComponentFactory.get<ITelemetryComponent>(\n\t\t\toptions?.telemetryComponentType ?? \"telemetry\"\n\t\t);\n\t\tthis._maxHistory = options?.maxHistory ?? 1440;\n\t\tthis._prevCpuTimes = os.cpus().map(c => c.times);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn SystemMetricsProducer.CLASS_NAME;\n\t}\n\n\t/**\n\t * Register all system metrics with the telemetry component.\n\t * @returns A promise that resolves when all system metrics have been registered.\n\t */\n\tpublic async register(): Promise<void> {\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"system_cpu_usage_percent\",\n\t\t\tlabel: \"CPU usage\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"system_memory_total_bytes\",\n\t\t\tlabel: \"Memory total\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"system_memory_used_bytes\",\n\t\t\tlabel: \"Memory used\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"system_memory_free_bytes\",\n\t\t\tlabel: \"Memory free\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"system_memory_usage_percent\",\n\t\t\tlabel: \"Memory usage\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t\tawait MetricHelper.createMetric(this._telemetry, {\n\t\t\tid: \"system_uptime_seconds\",\n\t\t\tlabel: \"System uptime\",\n\t\t\ttype: MetricType.Gauge,\n\t\t\tmaxHistory: this._maxHistory\n\t\t});\n\t}\n\n\t/**\n\t * Read the current system metric values.\n\t * @returns The current values for the system metrics.\n\t */\n\tpublic async collect(): Promise<ITelemetryMetricValueEntry[]> {\n\t\tconst currCpuTimes = os.cpus().map(c => c.times);\n\t\tconst usages = currCpuTimes.map((curr, i) => {\n\t\t\tconst prev = this._prevCpuTimes[i];\n\t\t\tconst idle = curr.idle - prev.idle;\n\t\t\tconst total =\n\t\t\t\tcurr.user -\n\t\t\t\tprev.user +\n\t\t\t\tcurr.nice -\n\t\t\t\tprev.nice +\n\t\t\t\tcurr.sys -\n\t\t\t\tprev.sys +\n\t\t\t\tcurr.idle -\n\t\t\t\tprev.idle +\n\t\t\t\tcurr.irq -\n\t\t\t\tprev.irq;\n\t\t\tconst idleDivision = idle / total;\n\t\t\tconst idlePercent = 1 - idleDivision;\n\t\t\treturn total === 0 ? 0 : 100 * idlePercent;\n\t\t});\n\t\tthis._prevCpuTimes = currCpuTimes;\n\t\tconst avgCpu = usages.reduce((a, b) => a + b, 0) / Math.max(1, usages.length);\n\n\t\tconst total = os.totalmem();\n\t\tconst free = os.freemem();\n\t\tconst used = total - free;\n\n\t\treturn [\n\t\t\t{ id: \"system_cpu_usage_percent\", value: Number(avgCpu.toFixed(2)) },\n\t\t\t{ id: \"system_memory_total_bytes\", value: total },\n\t\t\t{ id: \"system_memory_used_bytes\", value: used },\n\t\t\t{ id: \"system_memory_free_bytes\", value: free },\n\t\t\t{ id: \"system_memory_usage_percent\", value: Number(((100 * used) / total).toFixed(2)) },\n\t\t\t{ id: \"system_uptime_seconds\", value: Number(os.uptime().toFixed(1)) }\n\t\t];\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./models/IProcessMetricsProducerConstructorOptions.js";
+export * from "./models/ISystemMetricsProducerConstructorOptions.js";
+export * from "./processMetricsProducer.js";
+export * from "./systemMetricsProducer.js";

package/dist/types/models/IProcessMetricsProducerConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The options for the process metrics producer constructor.
+ */
+export interface IProcessMetricsProducerConstructorOptions {
+    /**
+     * Type name of the telemetry component in `ComponentFactory`.
+     * @default telemetry
+     */
+    telemetryComponentType?: string;
+    /**
+     * Per-metric history cap.
+     * @default 1440
+     */
+    maxHistory?: number;
+}

package/dist/types/models/ISystemMetricsProducerConstructorOptions.d.ts

@@ -0,0 +1,15 @@
+/**
+ * The options for the system metrics producer constructor.
+ */
+export interface ISystemMetricsProducerConstructorOptions {
+    /**
+     * Type name of the telemetry component in `ComponentFactory`.
+     * @default telemetry
+     */
+    telemetryComponentType?: string;
+    /**
+     * Per-metric history cap.
+     * @default 1440
+     */
+    maxHistory?: number;
+}

package/dist/types/processMetricsProducer.d.ts

@@ -0,0 +1,31 @@
+import { type IMetricsProducer, type ITelemetryMetricValueEntry } from "@3sixty/telemetry-models";
+import type { IProcessMetricsProducerConstructorOptions } from "./models/IProcessMetricsProducerConstructorOptions.js";
+/**
+ * Metrics producer that emits Node.js process metrics on every poll cycle.
+ */
+export declare class ProcessMetricsProducer implements IMetricsProducer {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of ProcessMetricsProducer.
+     * @param options The options for the producer.
+     */
+    constructor(options?: IProcessMetricsProducerConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Register all process metrics with the telemetry component.
+     * @returns A promise that resolves when all process metrics have been registered.
+     */
+    register(): Promise<void>;
+    /**
+     * Read the current process metric values.
+     * @returns The current values for the process metrics.
+     */
+    collect(): Promise<ITelemetryMetricValueEntry[]>;
+}

package/dist/types/systemMetricsProducer.d.ts

@@ -0,0 +1,31 @@
+import { type IMetricsProducer, type ITelemetryMetricValueEntry } from "@3sixty/telemetry-models";
+import type { ISystemMetricsProducerConstructorOptions } from "./models/ISystemMetricsProducerConstructorOptions.js";
+/**
+ * Metrics producer that emits host-level OS metrics on every poll cycle.
+ */
+export declare class SystemMetricsProducer implements IMetricsProducer {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of SystemMetricsProducer.
+     * @param options The options for the producer.
+     */
+    constructor(options?: ISystemMetricsProducerConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
+    /**
+     * Register all system metrics with the telemetry component.
+     * @returns A promise that resolves when all system metrics have been registered.
+     */
+    register(): Promise<void>;
+    /**
+     * Read the current system metric values.
+     * @returns The current values for the system metrics.
+     */
+    collect(): Promise<ITelemetryMetricValueEntry[]>;
+}

package/docs/examples.md

@@ -0,0 +1,49 @@
+# Telemetry Producers Examples
+
+These examples show how to register runtime and host metrics with a telemetry component and emit values during a polling cycle. Each snippet uses a small in-memory component so you can see how metric registration and collection fit together.
+
+## ProcessMetricsProducer
+
+```typescript
+import { ProcessMetricsProducer } from '@3sixty/telemetry-producers';
+
+const producer = new ProcessMetricsProducer({
+  telemetryComponentType: 'telemetry',
+  maxHistory: 120
+});
+
+console.log(producer.className()); // ProcessMetricsProducer
+
+await producer.register();
+
+const registeredMetrics = await telemetryComponent.query(MetricType.Gauge);
+console.log(registeredMetrics.entities.map(metric => metric.id)); // ["process_memory_rss_bytes", "process_memory_heap_used_bytes", "process_memory_heap_total_bytes", "process_uptime_seconds"]
+
+await producer.collect();
+
+const uptimeValues = await telemetryComponent.queryValues('process_uptime_seconds');
+console.log(uptimeValues.entities.length); // 1
+```
+
+## SystemMetricsProducer
+
+```typescript
+import { SystemMetricsProducer } from '@3sixty/telemetry-producers';
+
+const producer = new SystemMetricsProducer({
+  telemetryComponentType: 'telemetry',
+  maxHistory: 288
+});
+
+console.log(producer.className()); // SystemMetricsProducer
+
+await producer.register();
+
+const registeredMetrics = await telemetryComponent.query(MetricType.Gauge);
+console.log(registeredMetrics.entities.map(metric => metric.id)); // ["system_cpu_usage_percent", "system_memory_total_bytes", "system_memory_used_bytes", "system_memory_free_bytes", "system_memory_usage_percent", "system_uptime_seconds"]
+
+await producer.collect();
+
+const cpuValues = await telemetryComponent.queryValues('system_cpu_usage_percent');
+console.log(cpuValues.entities.length); // 1
+```

package/docs/reference/classes/ProcessMetricsProducer.md

@@ -0,0 +1,89 @@
+# Class: ProcessMetricsProducer
+
+Metrics producer that emits Node.js process metrics on every poll cycle.
+
+## Implements
+
+- `IMetricsProducer`
+
+## Constructors
+
+### Constructor
+
+> **new ProcessMetricsProducer**(`options?`): `ProcessMetricsProducer`
+
+Create a new instance of ProcessMetricsProducer.
+
+#### Parameters
+
+##### options?
+
+[`IProcessMetricsProducerConstructorOptions`](../interfaces/IProcessMetricsProducerConstructorOptions.md)
+
+The options for the producer.
+
+#### Returns
+
+`ProcessMetricsProducer`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IMetricsProducer.className`
+
+***
+
+### register() {#register}
+
+> **register**(): `Promise`\<`void`\>
+
+Register all process metrics with the telemetry component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when all process metrics have been registered.
+
+#### Implementation of
+
+`IMetricsProducer.register`
+
+***
+
+### collect() {#collect}
+
+> **collect**(): `Promise`\<`ITelemetryMetricValueEntry`[]\>
+
+Read the current process metric values.
+
+#### Returns
+
+`Promise`\<`ITelemetryMetricValueEntry`[]\>
+
+The current values for the process metrics.
+
+#### Implementation of
+
+`IMetricsProducer.collect`

package/docs/reference/classes/SystemMetricsProducer.md

@@ -0,0 +1,89 @@
+# Class: SystemMetricsProducer
+
+Metrics producer that emits host-level OS metrics on every poll cycle.
+
+## Implements
+
+- `IMetricsProducer`
+
+## Constructors
+
+### Constructor
+
+> **new SystemMetricsProducer**(`options?`): `SystemMetricsProducer`
+
+Create a new instance of SystemMetricsProducer.
+
+#### Parameters
+
+##### options?
+
+[`ISystemMetricsProducerConstructorOptions`](../interfaces/ISystemMetricsProducerConstructorOptions.md)
+
+The options for the producer.
+
+#### Returns
+
+`SystemMetricsProducer`
+
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IMetricsProducer.className`
+
+***
+
+### register() {#register}
+
+> **register**(): `Promise`\<`void`\>
+
+Register all system metrics with the telemetry component.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when all system metrics have been registered.
+
+#### Implementation of
+
+`IMetricsProducer.register`
+
+***
+
+### collect() {#collect}
+
+> **collect**(): `Promise`\<`ITelemetryMetricValueEntry`[]\>
+
+Read the current system metric values.
+
+#### Returns
+
+`Promise`\<`ITelemetryMetricValueEntry`[]\>
+
+The current values for the system metrics.
+
+#### Implementation of
+
+`IMetricsProducer.collect`

package/docs/reference/index.md

@@ -0,0 +1,11 @@
+# @3sixty/telemetry-producers
+
+## Classes
+
+- [ProcessMetricsProducer](classes/ProcessMetricsProducer.md)
+- [SystemMetricsProducer](classes/SystemMetricsProducer.md)
+
+## Interfaces
+
+- [IProcessMetricsProducerConstructorOptions](interfaces/IProcessMetricsProducerConstructorOptions.md)
+- [ISystemMetricsProducerConstructorOptions](interfaces/ISystemMetricsProducerConstructorOptions.md)

package/docs/reference/interfaces/IProcessMetricsProducerConstructorOptions.md

@@ -0,0 +1,31 @@
+# Interface: IProcessMetricsProducerConstructorOptions
+
+The options for the process metrics producer constructor.
+
+## Properties
+
+### telemetryComponentType? {#telemetrycomponenttype}
+
+> `optional` **telemetryComponentType?**: `string`
+
+Type name of the telemetry component in `ComponentFactory`.
+
+#### Default
+
+```ts
+telemetry
+```
+
+***
+
+### maxHistory? {#maxhistory}
+
+> `optional` **maxHistory?**: `number`
+
+Per-metric history cap.
+
+#### Default
+
+```ts
+1440
+```

package/docs/reference/interfaces/ISystemMetricsProducerConstructorOptions.md

@@ -0,0 +1,31 @@
+# Interface: ISystemMetricsProducerConstructorOptions
+
+The options for the system metrics producer constructor.
+
+## Properties
+
+### telemetryComponentType? {#telemetrycomponenttype}
+
+> `optional` **telemetryComponentType?**: `string`
+
+Type name of the telemetry component in `ComponentFactory`.
+
+#### Default
+
+```ts
+telemetry
+```
+
+***
+
+### maxHistory? {#maxhistory}
+
+> `optional` **maxHistory?**: `number`
+
+Per-metric history cap.
+
+#### Default
+
+```ts
+1440
+```

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,52 @@
 {
-  "name": "@3sixty/telemetry-producers",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/telemetry-producers",
+	"version": "0.20.0-next.0",
+	"description": "Metrics producers for collecting Node.js process and system telemetry.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/telemetry.git",
+		"directory": "packages/telemetry-producers"
+	},
+	"author": "adrian.sanchez.sequeira@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/core": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/telemetry-models": "0.20.0-next.0"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"telemetry",
+		"service",
+		"microservice",
+		"business-logic"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/telemetry/issues"
+	},
+	"homepage": "https://3sixty.global"
+}