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

package/docs/reference/interfaces/ITelemetryComponent.md

@@ -0,0 +1,273 @@
+# Interface: ITelemetryComponent
+
+Interface describing a telemetry component contract.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### createMetric() {#createmetric}
+
+> **createMetric**(`metric`): `Promise`\<`void`\>
+
+Create one or more metrics.
+A single metric fails if it already exists; an array declares the set that should exist,
+creating the ones that are missing and leaving the rest untouched, so implementations
+which persist the definitions can resolve the whole set in one operation.
+
+#### Parameters
+
+##### metric
+
+[`ITelemetryMetric`](ITelemetryMetric.md) \| [`ITelemetryMetric`](ITelemetryMetric.md)[]
+
+The metric details, or the details of several metrics.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metrics have been created.
+
+***
+
+### getMetric() {#getmetric}
+
+> **getMetric**(`id`): `Promise`\<\{ `metric`: [`ITelemetryMetric`](ITelemetryMetric.md); `value?`: [`ITelemetryMetricValue`](ITelemetryMetricValue.md); \}\>
+
+Get the metric details and it's most recent value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The metric id.
+
+#### Returns
+
+`Promise`\<\{ `metric`: [`ITelemetryMetric`](ITelemetryMetric.md); `value?`: [`ITelemetryMetricValue`](ITelemetryMetricValue.md); \}\>
+
+The metric details and it's most recent value.
+
+***
+
+### getMetricValue() {#getmetricvalue}
+
+> **getMetricValue**(`id`, `valueId`): `Promise`\<[`ITelemetryMetricValue`](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`](ITelemetryMetricValue.md)\>
+
+The metric value.
+
+***
+
+### updateMetric() {#updatemetric}
+
+> **updateMetric**(`metric`): `Promise`\<`void`\>
+
+Update metric.
+
+#### Parameters
+
+##### metric
+
+`Omit`\<[`ITelemetryMetric`](ITelemetryMetric.md), `"type"`\>
+
+The metric details.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric has been updated.
+
+***
+
+### 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?
+
+\{\[`key`: `string`\]: `unknown`; \}
+
+The custom data for the add operation.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The created metric value id.
+
+***
+
+### addMetricValues() {#addmetricvalues}
+
+> **addMetricValues**(`values`): `Promise`\<`string`[]\>
+
+Add multiple metric values, so implementations which persist them can do so in one
+operation instead of one per value.
+
+#### Parameters
+
+##### values
+
+[`ITelemetryMetricValueEntry`](ITelemetryMetricValueEntry.md)[]
+
+The metric values to add.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The created metric value ids, in the order the values were supplied.
+
+***
+
+### 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.
+
+***
+
+### query() {#query}
+
+> **query**(`type?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: [`ITelemetryMetric`](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`](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.
+
+***
+
+### queryValues() {#queryvalues}
+
+> **queryValues**(`id`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `metric`: [`ITelemetryMetric`](ITelemetryMetric.md); `entities`: [`ITelemetryMetricValue`](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`](ITelemetryMetric.md); `entities`: [`ITelemetryMetricValue`](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.

package/docs/reference/interfaces/ITelemetryConnector.md

@@ -0,0 +1,273 @@
+# Interface: ITelemetryConnector
+
+Interface describing a telemetry connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### createMetric() {#createmetric}
+
+> **createMetric**(`metric`): `Promise`\<`void`\>
+
+Create one or more metrics.
+A single metric fails if it already exists; an array declares the set that should exist,
+creating the ones that are missing and leaving the rest untouched, so implementations
+which persist the definitions can resolve the whole set in one operation.
+
+#### Parameters
+
+##### metric
+
+[`ITelemetryMetric`](ITelemetryMetric.md) \| [`ITelemetryMetric`](ITelemetryMetric.md)[]
+
+The metric details, or the details of several metrics.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metrics have been created.
+
+***
+
+### getMetric()? {#getmetric}
+
+> `optional` **getMetric**(`id`): `Promise`\<\{ `metric`: [`ITelemetryMetric`](ITelemetryMetric.md); `value?`: [`ITelemetryMetricValue`](ITelemetryMetricValue.md); \}\>
+
+Get the metric details and it's most recent value.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The metric id.
+
+#### Returns
+
+`Promise`\<\{ `metric`: [`ITelemetryMetric`](ITelemetryMetric.md); `value?`: [`ITelemetryMetricValue`](ITelemetryMetricValue.md); \}\>
+
+The metric details and it's most recent value.
+
+***
+
+### getMetricValue()? {#getmetricvalue}
+
+> `optional` **getMetricValue**(`id`, `valueId`): `Promise`\<[`ITelemetryMetricValue`](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`](ITelemetryMetricValue.md)\>
+
+The metric value.
+
+***
+
+### updateMetric() {#updatemetric}
+
+> **updateMetric**(`metric`): `Promise`\<`void`\>
+
+Update metric.
+
+#### Parameters
+
+##### metric
+
+`Omit`\<[`ITelemetryMetric`](ITelemetryMetric.md), `"type"`\>
+
+The metric details.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the metric has been updated.
+
+***
+
+### 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?
+
+\{\[`key`: `string`\]: `unknown`; \}
+
+The custom data for the update operation.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The created metric value id.
+
+***
+
+### addMetricValues() {#addmetricvalues}
+
+> **addMetricValues**(`values`): `Promise`\<`string`[]\>
+
+Add multiple metric values, so implementations which persist them can do so in one
+operation instead of one per value.
+
+#### Parameters
+
+##### values
+
+[`ITelemetryMetricValueEntry`](ITelemetryMetricValueEntry.md)[]
+
+The metric values to add.
+
+#### Returns
+
+`Promise`\<`string`[]\>
+
+The created metric value ids, in the order the values were supplied.
+
+***
+
+### 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.
+
+***
+
+### query()? {#query}
+
+> `optional` **query**(`type?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: [`ITelemetryMetric`](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`](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.
+
+***
+
+### queryValues()? {#queryvalues}
+
+> `optional` **queryValues**(`id`, `timeStart?`, `timeEnd?`, `cursor?`, `limit?`): `Promise`\<\{ `metric`: [`ITelemetryMetric`](ITelemetryMetric.md); `entities`: [`ITelemetryMetricValue`](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`](ITelemetryMetric.md); `entities`: [`ITelemetryMetricValue`](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.

package/docs/reference/interfaces/ITelemetryCreateMetricRequest.md

@@ -0,0 +1,12 @@
+# Interface: ITelemetryCreateMetricRequest
+
+Create one or more telemetry metrics.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`ITelemetryMetric`](ITelemetryMetric.md) \| [`ITelemetryMetric`](ITelemetryMetric.md)[]
+
+The data to be used in the create. A single metric fails if it already exists; an array
+declares the set that should exist, creating the ones that are missing.

package/docs/reference/interfaces/ITelemetryGetMetricRequest.md

@@ -0,0 +1,17 @@
+# Interface: ITelemetryGetMetricRequest
+
+Get a telemetry metric.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the metric.

package/docs/reference/interfaces/ITelemetryGetMetricResponse.md

@@ -0,0 +1,23 @@
+# Interface: ITelemetryGetMetricResponse
+
+Get a telemetry metric response.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The body parameters.
+
+#### metric
+
+> **metric**: [`ITelemetryMetric`](ITelemetryMetric.md)
+
+The metric.
+
+#### value?
+
+> `optional` **value?**: [`ITelemetryMetricValue`](ITelemetryMetricValue.md)
+
+The latest metric value.

package/docs/reference/interfaces/ITelemetryGetMetricValueRequest.md

@@ -0,0 +1,23 @@
+# Interface: ITelemetryGetMetricValueRequest
+
+Get a telemetry metric value.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the metric.
+
+#### valueId
+
+> **valueId**: `string`
+
+The id of the metric value.

package/docs/reference/interfaces/ITelemetryGetMetricValueResponse.md

@@ -0,0 +1,11 @@
+# Interface: ITelemetryGetMetricValueResponse
+
+Get a telemetry metric value response.
+
+## Properties
+
+### body {#body}
+
+> **body**: [`ITelemetryMetricValue`](ITelemetryMetricValue.md)
+
+The body parameters.

package/docs/reference/interfaces/ITelemetryListRequest.md

@@ -0,0 +1,29 @@
+# Interface: ITelemetryListRequest
+
+Get the a list of the telemetry metrics.
+
+## Properties
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### type?
+
+> `optional` **type?**: `string`
+
+The type of the metric.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The optional cursor to get next chunk.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+Limit the number of entities to return.

package/docs/reference/interfaces/ITelemetryListResponse.md

@@ -0,0 +1,23 @@
+# Interface: ITelemetryListResponse
+
+Response for telemetry list request.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The response payload.
+
+#### entities
+
+> **entities**: [`ITelemetryMetric`](ITelemetryMetric.md)[]
+
+The metrics.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.