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

package/docs/reference/classes/MultiTelemetryConnector.md

@@ -0,0 +1,357 @@
+# Class: MultiTelemetryConnector
+
+Class for performing telemetry operations on multiple connectors.
+
+## Implements
+
+- [`ITelemetryConnector`](../interfaces/ITelemetryConnector.md)
+
+## Constructors
+
+### Constructor
+
+> **new MultiTelemetryConnector**(`options`): `MultiTelemetryConnector`
+
+Create a new instance of MultiTelemetryConnector.
+
+#### Parameters
+
+##### options
+
+[`IMultiTelemetryConnectorConstructorOptions`](../interfaces/IMultiTelemetryConnectorConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+`MultiTelemetryConnector`
+
+## Properties
+
+### NAMESPACE {#namespace}
+
+> `readonly` `static` **NAMESPACE**: `string` = `"multi"`
+
+The namespace for the class.
+
+***
+
+### 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
+
+`ITelemetryConnector.className`
+
+***
+
+### createMetric() {#createmetric}
+
+> **createMetric**(`metric`): `Promise`\<`void`\>
+
+Create one or more metrics.
+
+#### Parameters
+
+##### metric
+
+[`ITelemetryMetric`](../interfaces/ITelemetryMetric.md) \| [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md)[]
+
+The metric details, or the details of several metrics.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metrics have been created on all connectors.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`createMetric`](../interfaces/ITelemetryConnector.md#createmetric)
+
+***
+
+### getMetric() {#getmetric}
+
+> **getMetric**(`id`): `Promise`\<\{ `metric`: [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md); `value?`: [`ITelemetryMetricValue`](../interfaces/ITelemetryMetricValue.md); \}\>
+
+Get the metric details and it's most recent value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The metric id.
+
+#### Returns
+
+`Promise`\<\{ `metric`: [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md); `value?`: [`ITelemetryMetricValue`](../interfaces/ITelemetryMetricValue.md); \}\>
+
+The metric details and it's most recent value.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`getMetric`](../interfaces/ITelemetryConnector.md#getmetric)
+
+***
+
+### getMetricValue() {#getmetricvalue}
+
+> **getMetricValue**(`id`, `valueId`): `Promise`\<[`ITelemetryMetricValue`](../interfaces/ITelemetryMetricValue.md)\>
+
+Get a specific metric value by its id.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### valueId
+
+`string`
+
+The id of the metric value.
+
+#### Returns
+
+`Promise`\<[`ITelemetryMetricValue`](../interfaces/ITelemetryMetricValue.md)\>
+
+The metric value.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`getMetricValue`](../interfaces/ITelemetryConnector.md#getmetricvalue)
+
+***
+
+### updateMetric() {#updatemetric}
+
+> **updateMetric**(`metric`): `Promise`\<`void`\>
+
+Update metric.
+
+#### Parameters
+
+##### metric
+
+`Omit`\<[`ITelemetryMetric`](../interfaces/ITelemetryMetric.md), `"type"`\>
+
+The metric details.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric has been updated on all connectors.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`updateMetric`](../interfaces/ITelemetryConnector.md#updatemetric)
+
+***
+
+### addMetricValue() {#addmetricvalue}
+
+> **addMetricValue**(`id`, `value`, `customData?`): `Promise`\<`string`\>
+
+Add a metric value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### value
+
+`number` \| [`MetricCounterOperation`](../type-aliases/MetricCounterOperation.md)
+
+The value for the add operation.
+
+##### customData?
+
+The custom data for the add operation.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The created metric value id.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`addMetricValue`](../interfaces/ITelemetryConnector.md#addmetricvalue)
+
+***
+
+### addMetricValues() {#addmetricvalues}
+
+> **addMetricValues**(`values`): `Promise`\<`string`[]\>
+
+Add multiple metric values.
+
+#### Parameters
+
+##### values
+
+[`ITelemetryMetricValueEntry`](../interfaces/ITelemetryMetricValueEntry.md)[]
+
+The metric values to add.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The created metric value ids, in the order the values were supplied.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`addMetricValues`](../interfaces/ITelemetryConnector.md#addmetricvalues)
+
+***
+
+### removeMetric() {#removemetric}
+
+> **removeMetric**(`id`): `Promise`\<`void`\>
+
+Remove metric.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric has been removed from all connectors.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`removeMetric`](../interfaces/ITelemetryConnector.md#removemetric)
+
+***
+
+### query() {#query}
+
+> **query**(`type?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md)[]; `cursor?`: `string`; \}\>
+
+Query the metrics.
+
+#### Parameters
+
+##### type?
+
+[`MetricType`](../type-aliases/MetricType.md)
+
+The type of the metric.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next chunk of entities.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
+#### Returns
+
+`Promise`\<\{ `entities`: [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md)[]; `cursor?`: `string`; \}\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Throws
+
+NotImplementedError if the implementation does not support retrieval.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`query`](../interfaces/ITelemetryConnector.md#query)
+
+***
+
+### queryValues() {#queryvalues}
+
+> **queryValues**(`id`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `metric`: [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md); `entities`: [`ITelemetryMetricValue`](../interfaces/ITelemetryMetricValue.md)[]; `cursor?`: `string`; \}\>
+
+Query the metric values.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### timeStart?
+
+`number`
+
+The inclusive time as the start of the metric entries.
+
+##### timeEnd?
+
+`number`
+
+The inclusive time as the end of the metric entries.
+
+##### cursor?
+
+`string`
+
+The cursor to request the next chunk of entities.
+
+##### limit?
+
+`number`
+
+Limit the number of entities to return.
+
+#### Returns
+
+`Promise`\<\{ `metric`: [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md); `entities`: [`ITelemetryMetricValue`](../interfaces/ITelemetryMetricValue.md)[]; `cursor?`: `string`; \}\>
+
+All the entities for the storage matching the conditions,
+and a cursor which can be used to request more entities.
+
+#### Throws
+
+NotImplementedError if the implementation does not support retrieval.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`queryValues`](../interfaces/ITelemetryConnector.md#queryvalues)

package/docs/reference/classes/SilentTelemetryConnector.md

@@ -0,0 +1,191 @@
+# Class: SilentTelemetryConnector
+
+Class for performing telemetry operations to nowhere.
+
+## Implements
+
+- [`ITelemetryConnector`](../interfaces/ITelemetryConnector.md)
+
+## Constructors
+
+### Constructor
+
+> **new SilentTelemetryConnector**(): `SilentTelemetryConnector`
+
+#### Returns
+
+`SilentTelemetryConnector`
+
+## Properties
+
+### NAMESPACE {#namespace}
+
+> `readonly` `static` **NAMESPACE**: `string` = `"silent"`
+
+The namespace for the class.
+
+***
+
+### 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
+
+`ITelemetryConnector.className`
+
+***
+
+### createMetric() {#createmetric}
+
+> **createMetric**(`metric`): `Promise`\<`void`\>
+
+Create one or more metrics.
+
+#### Parameters
+
+##### metric
+
+[`ITelemetryMetric`](../interfaces/ITelemetryMetric.md) \| [`ITelemetryMetric`](../interfaces/ITelemetryMetric.md)[]
+
+The metric details, or the details of several metrics.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric has been created.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`createMetric`](../interfaces/ITelemetryConnector.md#createmetric)
+
+***
+
+### updateMetric() {#updatemetric}
+
+> **updateMetric**(`metric`): `Promise`\<`void`\>
+
+Update metric.
+
+#### Parameters
+
+##### metric
+
+`Omit`\<[`ITelemetryMetric`](../interfaces/ITelemetryMetric.md), `"type"`\>
+
+The metric details.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric has been updated.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`updateMetric`](../interfaces/ITelemetryConnector.md#updatemetric)
+
+***
+
+### addMetricValue() {#addmetricvalue}
+
+> **addMetricValue**(`id`, `value`, `customData?`): `Promise`\<`string`\>
+
+Update metric value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+##### value
+
+`number` \| [`MetricCounterOperation`](../type-aliases/MetricCounterOperation.md)
+
+The value for the update operation.
+
+##### customData?
+
+The custom data for the update operation.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The created metric value id.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`addMetricValue`](../interfaces/ITelemetryConnector.md#addmetricvalue)
+
+***
+
+### addMetricValues() {#addmetricvalues}
+
+> **addMetricValues**(`values`): `Promise`\<`string`[]\>
+
+Add multiple metric values.
+
+#### Parameters
+
+##### values
+
+[`ITelemetryMetricValueEntry`](../interfaces/ITelemetryMetricValueEntry.md)[]
+
+The metric values to add.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The created metric value ids.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`addMetricValues`](../interfaces/ITelemetryConnector.md#addmetricvalues)
+
+***
+
+### removeMetric() {#removemetric}
+
+> **removeMetric**(`id`): `Promise`\<`void`\>
+
+Remove metric.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the metric.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric and all its values have been removed.
+
+#### Implementation of
+
+[`ITelemetryConnector`](../interfaces/ITelemetryConnector.md).[`removeMetric`](../interfaces/ITelemetryConnector.md#removemetric)

package/docs/reference/index.md

@@ -0,0 +1,42 @@
+# @3sixty/telemetry-models
+
+## Classes
+
+- [MultiTelemetryConnector](classes/MultiTelemetryConnector.md)
+- [SilentTelemetryConnector](classes/SilentTelemetryConnector.md)
+- [MetricHelper](classes/MetricHelper.md)
+
+## Interfaces
+
+- [IMetricsCollectorComponent](interfaces/IMetricsCollectorComponent.md)
+- [IMetricsProducer](interfaces/IMetricsProducer.md)
+- [IMultiTelemetryConnectorConstructorOptions](interfaces/IMultiTelemetryConnectorConstructorOptions.md)
+- [ITelemetryComponent](interfaces/ITelemetryComponent.md)
+- [ITelemetryConnector](interfaces/ITelemetryConnector.md)
+- [ITelemetryMetric](interfaces/ITelemetryMetric.md)
+- [ITelemetryMetricValue](interfaces/ITelemetryMetricValue.md)
+- [ITelemetryMetricValueEntry](interfaces/ITelemetryMetricValueEntry.md)
+- [ITelemetryAddMetricValueRequest](interfaces/ITelemetryAddMetricValueRequest.md)
+- [ITelemetryCreateMetricRequest](interfaces/ITelemetryCreateMetricRequest.md)
+- [ITelemetryGetMetricRequest](interfaces/ITelemetryGetMetricRequest.md)
+- [ITelemetryGetMetricResponse](interfaces/ITelemetryGetMetricResponse.md)
+- [ITelemetryGetMetricValueRequest](interfaces/ITelemetryGetMetricValueRequest.md)
+- [ITelemetryGetMetricValueResponse](interfaces/ITelemetryGetMetricValueResponse.md)
+- [ITelemetryListRequest](interfaces/ITelemetryListRequest.md)
+- [ITelemetryListResponse](interfaces/ITelemetryListResponse.md)
+- [ITelemetryRemoveMetricRequest](interfaces/ITelemetryRemoveMetricRequest.md)
+- [ITelemetryUpdateMetricRequest](interfaces/ITelemetryUpdateMetricRequest.md)
+- [ITelemetryValuesListRequest](interfaces/ITelemetryValuesListRequest.md)
+- [ITelemetryValuesListResponse](interfaces/ITelemetryValuesListResponse.md)
+
+## Type Aliases
+
+- [MetricCounterOperation](type-aliases/MetricCounterOperation.md)
+- [MetricType](type-aliases/MetricType.md)
+
+## Variables
+
+- [MetricsProducerFactory](variables/MetricsProducerFactory.md)
+- [TelemetryConnectorFactory](variables/TelemetryConnectorFactory.md)
+- [MetricCounterOperation](variables/MetricCounterOperation.md)
+- [MetricType](variables/MetricType.md)

package/docs/reference/interfaces/IMetricsCollectorComponent.md

@@ -0,0 +1,7 @@
+# Interface: IMetricsCollectorComponent
+
+Contract for a metrics collector component.
+
+## Extends
+
+- `IComponent`

package/docs/reference/interfaces/IMetricsProducer.md

@@ -0,0 +1,45 @@
+# Interface: IMetricsProducer
+
+Contract for a metrics producer.
+
+A producer declares its metrics with `register()` once and pushes current
+values with `collect()` on every poll cycle. Producers are discovered via
+`MetricsProducerFactory` and orchestrated by a `MetricsCollectorService`.
+
+Producers are factory-only entries - they are not lifecycle components of
+the engine. The orchestrating service owns the polling timer.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### register() {#register}
+
+> **register**(): `Promise`\<`void`\>
+
+Register every metric this producer emits with the telemetry component.
+Called once when the orchestrating service starts.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when all metrics have been registered.
+
+***
+
+### collect() {#collect}
+
+> **collect**(): `Promise`\<[`ITelemetryMetricValueEntry`](ITelemetryMetricValueEntry.md)[]\>
+
+Read the current values for every metric this producer emits.
+Called on every poll cycle. The values are returned rather than recorded, so the
+orchestrating service can record a whole cycle in one operation.
+
+#### Returns
+
+`Promise`\<[`ITelemetryMetricValueEntry`](ITelemetryMetricValueEntry.md)[]\>
+
+The current values for this producer's metrics.

package/docs/reference/interfaces/IMultiTelemetryConnectorConstructorOptions.md

@@ -0,0 +1,11 @@
+# Interface: IMultiTelemetryConnectorConstructorOptions
+
+The options for the multi telemetry connector constructor.
+
+## Properties
+
+### telemetryConnectorTypes {#telemetryconnectortypes}
+
+> **telemetryConnectorTypes**: `string`[]
+
+The telemetry connector types to multiplex.

package/docs/reference/interfaces/ITelemetryAddMetricValueRequest.md

@@ -0,0 +1,41 @@
+# Interface: ITelemetryAddMetricValueRequest
+
+Add a telemetry metric value.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the metric.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The data to be used in the update.
+
+#### value
+
+> **value**: `number` \| [`MetricCounterOperation`](../type-aliases/MetricCounterOperation.md)
+
+The value for the update operation.
+
+#### customData?
+
+> `optional` **customData?**: `object`
+
+The custom data for the update operation.
+
+##### Index Signature
+
+\[`key`: `string`\]: `unknown`