@twin.org/telemetry-service 0.0.2-next.3 → 0.0.3-next.10

package/docs/open-api/spec.json

@@ -139,8 +139,9 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"$ref": "#/components/schemas/MetricType"
-						}
+							"type": "string"
+						},
+						"example": "0"
 					},
 					{
 						"name": "cursor",
@@ -707,10 +708,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -719,10 +717,7 @@
 						"in": "query",
 						"required": false,
 						"schema": {
-							"type": [
-								"number",
-								"string"
-							]
+							"type": "string"
 						}
 					},
 					{
@@ -849,6 +844,7 @@
 	"components": {
 		"schemas": {
 			"Error": {
+				"description": "Model to describe serialized error.",
 				"type": "object",
 				"properties": {
 					"name": {
@@ -857,7 +853,7 @@
 					},
 					"message": {
 						"type": "string",
-						"description": "The message for the error."
+						"description": "The message for the error as an i18n key."
 					},
 					"source": {
 						"type": "string",
@@ -879,29 +875,37 @@
 				"required": [
 					"name",
 					"message"
-				],
-				"additionalProperties": false,
-				"description": "Model to describe serialized error."
+				]
+			},
+			"MetricCounterOperation": {
+				"description": "The types of metric counter operations.",
+				"anyOf": [
+					{
+						"const": "inc",
+						"description": "Increment Counter."
+					},
+					{
+						"const": "dec",
+						"description": "Decrement Counter."
+					}
+				]
 			},
 			"MetricType": {
+				"description": "The types of metrics.",
 				"anyOf": [
 					{
-						"type": "number",
 						"const": 0,
 						"description": "Counter."
 					},
 					{
-						"type": "number",
 						"const": 1,
 						"description": "Increment Decrement Counter."
 					},
 					{
-						"type": "number",
 						"const": 2,
 						"description": "Gauge."
 					}
-				],
-				"description": "The types of metrics."
+				]
 			},
 			"TelemetryAddMetricValueRequest": {
 				"type": "object",
@@ -909,12 +913,7 @@
 					"value": {
 						"anyOf": [
 							{
-								"type": "string",
-								"const": "inc"
-							},
-							{
-								"type": "string",
-								"const": "dec"
+								"$ref": "#/components/schemas/MetricCounterOperation"
 							},
 							{
 								"type": "number"
@@ -931,7 +930,6 @@
 				"required": [
 					"value"
 				],
-				"additionalProperties": false,
 				"description": "The data to be used in the update."
 			},
 			"TelemetryGetMetricResponse": {
@@ -948,7 +946,6 @@
 					"metric",
 					"value"
 				],
-				"additionalProperties": false,
 				"description": "The body parameters."
 			},
 			"TelemetryListResponse": {
@@ -956,13 +953,10 @@
 				"properties": {
 					"entities": {
 						"type": "array",
-						"items": false,
-						"description": "The metrics.",
-						"prefixItems": [
-							{
-								"$ref": "#/components/schemas/TelemetryMetric"
-							}
-						]
+						"items": {
+							"$ref": "#/components/schemas/TelemetryMetric"
+						},
+						"description": "The metrics."
 					},
 					"cursor": {
 						"type": "string",
@@ -972,10 +966,10 @@
 				"required": [
 					"entities"
 				],
-				"additionalProperties": false,
 				"description": "The response payload."
 			},
 			"TelemetryMetric": {
+				"description": "Interface describing a telemetry metric.",
 				"type": "object",
 				"properties": {
 					"id": {
@@ -996,17 +990,20 @@
 					"unit": {
 						"type": "string",
 						"description": "The unit the metric describes."
+					},
+					"maxHistory": {
+						"type": "number",
+						"description": "The maximum number of values to retain; oldest are trimmed on each addMetricValue call.\nUnlimited when absent."
 					}
 				},
 				"required": [
 					"id",
 					"label",
 					"type"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a telemetry metric."
+				]
 			},
 			"TelemetryMetricValue": {
+				"description": "Interface describing a telemetry metric value.",
 				"type": "object",
 				"properties": {
 					"id": {
@@ -1031,9 +1028,7 @@
 					"id",
 					"ts",
 					"value"
-				],
-				"additionalProperties": false,
-				"description": "Interface describing a telemetry metric value."
+				]
 			},
 			"TelemetryUpdateMetricRequest": {
 				"type": "object",
@@ -1054,7 +1049,6 @@
 				"required": [
 					"label"
 				],
-				"additionalProperties": false,
 				"description": "The data to be used in the update."
 			},
 			"TelemetryValuesListResponse": {
@@ -1065,13 +1059,10 @@
 					},
 					"entities": {
 						"type": "array",
-						"items": false,
-						"description": "The metric values.",
-						"prefixItems": [
-							{
-								"$ref": "#/components/schemas/TelemetryMetricValue"
-							}
-						]
+						"items": {
+							"$ref": "#/components/schemas/TelemetryMetricValue"
+						},
+						"description": "The metric values."
 					},
 					"cursor": {
 						"type": "string",
@@ -1082,7 +1073,6 @@
 					"metric",
 					"entities"
 				],
-				"additionalProperties": false,
 				"description": "The response payload."
 			}
 		},

package/docs/reference/classes/MetricsCollectorService.md

@@ -0,0 +1,98 @@
+# Class: MetricsCollectorService
+
+Collects metrics from registered producers at a fixed interval.
+
+## Implements
+
+- `IMetricsCollectorComponent`
+
+## Constructors
+
+### Constructor
+
+> **new MetricsCollectorService**(`options?`): `MetricsCollectorService`
+
+Create a new instance of MetricsCollectorService.
+
+#### Parameters
+
+##### options?
+
+[`IMetricsCollectorServiceConstructorOptions`](../interfaces/IMetricsCollectorServiceConstructorOptions.md)
+
+The options for the service.
+
+#### Returns
+
+`MetricsCollectorService`
+
+## 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
+
+`IMetricsCollectorComponent.className`
+
+***
+
+### start() {#start}
+
+> **start**(): `Promise`\<`void`\>
+
+Start the service: register all producers and begin the polling cycle.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IMetricsCollectorComponent.start`
+
+***
+
+### stop() {#stop}
+
+> **stop**(): `Promise`\<`void`\>
+
+Stop the service and cancel the pending timer.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IMetricsCollectorComponent.stop`
+
+***
+
+### tick() {#tick}
+
+> **tick**(): `Promise`\<`void`\>
+
+One collection cycle across all registered producers.
+Public so tests can drive it deterministically.
+
+#### Returns
+
+`Promise`\<`void`\>

package/docs/reference/classes/TelemetryService.md

@@ -28,7 +28,7 @@ The options for the connector.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -36,7 +36,25 @@ Runtime name for the class.
 
 ## Methods
 
-### createMetric()
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ITelemetryComponent.className`
+
+***
+
+### createMetric() {#createmetric}
 
 > **createMetric**(`metric`): `Promise`\<`void`\>
 
@@ -62,7 +80,7 @@ Nothing.
 
 ***
 
-### getMetric()
+### getMetric() {#getmetric}
 
 > **getMetric**(`id`): `Promise`\<\{ `metric`: `ITelemetryMetric`; `value`: `ITelemetryMetricValue`; \}\>
 
@@ -88,7 +106,7 @@ The metric details and it's most recent value.
 
 ***
 
-### updateMetric()
+### updateMetric() {#updatemetric}
 
 > **updateMetric**(`metric`): `Promise`\<`void`\>
 
@@ -114,7 +132,7 @@ Nothing.
 
 ***
 
-### addMetricValue()
+### addMetricValue() {#addmetricvalue}
 
 > **addMetricValue**(`id`, `value`, `customData?`): `Promise`\<`string`\>
 
@@ -130,9 +148,9 @@ The id of the metric.
 
 ##### value
 
-The value for the add operation.
+`number` \| `MetricCounterOperation`
 
-`number` | `"inc"` | `"dec"`
+The value for the add operation.
 
 ##### customData?
 
@@ -150,7 +168,7 @@ The created metric value id.
 
 ***
 
-### removeMetric()
+### removeMetric() {#removemetric}
 
 > **removeMetric**(`id`): `Promise`\<`void`\>
 
@@ -176,7 +194,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`type?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: `ITelemetryMetric`[]; `cursor?`: `string`; \}\>
 
@@ -219,7 +237,7 @@ NotImplementedError if the implementation does not support retrieval.
 
 ***
 
-### queryValues()
+### queryValues() {#queryvalues}
 
 > **queryValues**(`id`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `metric`: `ITelemetryMetric`; `entities`: `ITelemetryMetricValue`[]; `cursor?`: `string`; \}\>
 

package/docs/reference/index.md

@@ -2,10 +2,13 @@
 
 ## Classes
 
+- [MetricsCollectorService](classes/MetricsCollectorService.md)
 - [TelemetryService](classes/TelemetryService.md)
 
 ## Interfaces
 
+- [IMetricsCollectorServiceConfig](interfaces/IMetricsCollectorServiceConfig.md)
+- [IMetricsCollectorServiceConstructorOptions](interfaces/IMetricsCollectorServiceConstructorOptions.md)
 - [ITelemetryServiceConstructorOptions](interfaces/ITelemetryServiceConstructorOptions.md)
 
 ## Variables

package/docs/reference/interfaces/IMetricsCollectorServiceConfig.md

@@ -0,0 +1,17 @@
+# Interface: IMetricsCollectorServiceConfig
+
+The options for the metrics collector service config.
+
+## Properties
+
+### intervalMs? {#intervalms}
+
+> `optional` **intervalMs?**: `number`
+
+Polling interval in milliseconds.
+
+#### Default
+
+```ts
+60000
+```

package/docs/reference/interfaces/IMetricsCollectorServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IMetricsCollectorServiceConstructorOptions
+
+The options for the metrics collector service constructor.
+
+## Properties
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The type of the logging component to use.
+
+#### Default
+
+```ts
+logging
+```
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IMetricsCollectorServiceConfig`](IMetricsCollectorServiceConfig.md)
+
+The configuration options for the metrics collector service.

package/docs/reference/interfaces/ITelemetryServiceConstructorOptions.md

@@ -4,9 +4,9 @@ The options for the telemetry service constructor.
 
 ## Properties
 
-### telemetryConnectorType?
+### telemetryConnectorType? {#telemetryconnectortype}
 
-> `optional` **telemetryConnectorType**: `string`
+> `optional` **telemetryConnectorType?**: `string`
 
 The type of the telemetry connector to use.
 

package/locales/en.json

@@ -1 +1,7 @@
-{}
+{
+	"error": {
+		"metricsCollectorService": {
+			"producerCollectionFailed": "Failed to collect metrics from producer \"{producer}\""
+		}
+	}
+}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/telemetry-service",
-	"version": "0.0.2-next.3",
-	"description": "Telemetry contract implementation and REST endpoint definitions",
+	"version": "0.0.3-next.10",
+	"description": "Telemetry service implementation with REST entry points.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/telemetry.git",
+		"url": "git+https://github.com/iotaledger/telemetry.git",
 		"directory": "packages/telemetry-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -17,24 +17,23 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
+		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/telemetry-models": "0.0.2-next.3",
+		"@twin.org/telemetry-models": "0.0.3-next.10",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -51,7 +50,7 @@
 		"business-logic"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/telemetry/issues"
+		"url": "git+https://github.com/iotaledger/telemetry/issues"
 	},
 	"homepage": "https://twindev.org"
 }