@twin.org/engine-types 0.0.3-next.36 → 0.0.3-next.38

package/docs/reference/functions/initialiseMetricsProducerComponent.md

@@ -0,0 +1,31 @@
+# Function: initialiseMetricsProducerComponent()
+
+> **initialiseMetricsProducerComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`MetricsProducerComponentConfig`](../type-aliases/MetricsProducerComponentConfig.md), `Factory`\<`IMetricsProducer`\>\>
+
+Initialise a metrics producer.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`MetricsProducerComponentConfig`](../type-aliases/MetricsProducerComponentConfig.md)
+
+The instance config.
+
+## Returns
+
+`EngineTypeInitialiserReturn`\<[`MetricsProducerComponentConfig`](../type-aliases/MetricsProducerComponentConfig.md), `Factory`\<`IMetricsProducer`\>\>
+
+The instance created and the factory for it.

package/docs/reference/index.md

@@ -49,6 +49,8 @@
 - [MessagingEmailConnectorConfig](type-aliases/MessagingEmailConnectorConfig.md)
 - [MessagingPushNotificationConnectorConfig](type-aliases/MessagingPushNotificationConnectorConfig.md)
 - [MessagingSmsConnectorConfig](type-aliases/MessagingSmsConnectorConfig.md)
+- [MetricsCollectorComponentConfig](type-aliases/MetricsCollectorComponentConfig.md)
+- [MetricsProducerComponentConfig](type-aliases/MetricsProducerComponentConfig.md)
 - [NftComponentConfig](type-aliases/NftComponentConfig.md)
 - [NftConnectorConfig](type-aliases/NftConnectorConfig.md)
 - [NotarizationComponentConfig](type-aliases/NotarizationComponentConfig.md)
@@ -120,6 +122,8 @@
 - [MessagingEmailConnectorType](type-aliases/MessagingEmailConnectorType.md)
 - [MessagingPushNotificationConnectorType](type-aliases/MessagingPushNotificationConnectorType.md)
 - [MessagingSmsConnectorType](type-aliases/MessagingSmsConnectorType.md)
+- [MetricsCollectorComponentType](type-aliases/MetricsCollectorComponentType.md)
+- [MetricsProducerComponentType](type-aliases/MetricsProducerComponentType.md)
 - [NftComponentType](type-aliases/NftComponentType.md)
 - [NftConnectorType](type-aliases/NftConnectorType.md)
 - [NotarizationComponentType](type-aliases/NotarizationComponentType.md)
@@ -194,6 +198,8 @@
 - [MessagingEmailConnectorType](variables/MessagingEmailConnectorType.md)
 - [MessagingPushNotificationConnectorType](variables/MessagingPushNotificationConnectorType.md)
 - [MessagingSmsConnectorType](variables/MessagingSmsConnectorType.md)
+- [MetricsCollectorComponentType](variables/MetricsCollectorComponentType.md)
+- [MetricsProducerComponentType](variables/MetricsProducerComponentType.md)
 - [NftComponentType](variables/NftComponentType.md)
 - [NftConnectorType](variables/NftConnectorType.md)
 - [NotarizationComponentType](variables/NotarizationComponentType.md)
@@ -267,6 +273,8 @@
 - [initialiseMessagingPushNotificationConnector](functions/initialiseMessagingPushNotificationConnector.md)
 - [initialiseMessagingComponent](functions/initialiseMessagingComponent.md)
 - [initialiseMessagingAdminComponent](functions/initialiseMessagingAdminComponent.md)
+- [initialiseMetricsCollectorComponent](functions/initialiseMetricsCollectorComponent.md)
+- [initialiseMetricsProducerComponent](functions/initialiseMetricsProducerComponent.md)
 - [initialiseNftConnector](functions/initialiseNftConnector.md)
 - [initialiseNftComponent](functions/initialiseNftComponent.md)
 - [initialiseNotarizationConnector](functions/initialiseNotarizationConnector.md)

package/docs/reference/interfaces/IEngineConfig.md

@@ -102,6 +102,18 @@ Telemetry connector options which can be overridden by individual components by
 
 Telemetry component options which can be overridden by individual components by specifying types other than default.
 
+#### metricsProducerComponent?
+
+> `optional` **metricsProducerComponent?**: `IEngineCoreTypeConfig`\<[`MetricsProducerComponentConfig`](../type-aliases/MetricsProducerComponentConfig.md)\>[]
+
+Metrics producer component options. Creates the `MetricsProducerService` that orchestrates polling.
+
+#### metricsCollectorComponent?
+
+> `optional` **metricsCollectorComponent?**: `IEngineCoreTypeConfig`\<[`MetricsCollectorComponentConfig`](../type-aliases/MetricsCollectorComponentConfig.md)\>[]
+
+Metrics collector options. Each entry registers a collector in `MetricsCollectorFactory`.
+
 #### messagingEmailConnector?
 
 > `optional` **messagingEmailConnector?**: `IEngineCoreTypeConfig`\<[`MessagingEmailConnectorConfig`](../type-aliases/MessagingEmailConnectorConfig.md)\>[]

package/docs/reference/type-aliases/MetricsCollectorComponentConfig.md

@@ -0,0 +1,17 @@
+# Type Alias: MetricsCollectorComponentConfig
+
+> **MetricsCollectorComponentConfig** = `object`
+
+Metrics collector component config types.
+
+## Properties
+
+### type {#type}
+
+> **type**: *typeof* [`Service`](../variables/MetricsCollectorComponentType.md#service)
+
+***
+
+### options? {#options}
+
+> `optional` **options?**: `IMetricsCollectorServiceConstructorOptions`

package/docs/reference/type-aliases/MetricsCollectorComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: MetricsCollectorComponentType
+
+> **MetricsCollectorComponentType** = *typeof* [`MetricsCollectorComponentType`](../variables/MetricsCollectorComponentType.md)\[keyof *typeof* [`MetricsCollectorComponentType`](../variables/MetricsCollectorComponentType.md)\]
+
+Metrics collector component types.

package/docs/reference/type-aliases/MetricsProducerComponentConfig.md

@@ -0,0 +1,5 @@
+# Type Alias: MetricsProducerComponentConfig
+
+> **MetricsProducerComponentConfig** = \{ `type`: *typeof* [`System`](../variables/MetricsProducerComponentType.md#system); `options?`: `ISystemMetricsProducerConstructorOptions`; \} \| \{ `type`: *typeof* [`Process`](../variables/MetricsProducerComponentType.md#process); `options`: `IProcessMetricsProducerConstructorOptions`; \}
+
+Metrics producer config types.

package/docs/reference/type-aliases/MetricsProducerComponentType.md

@@ -0,0 +1,5 @@
+# Type Alias: MetricsProducerComponentType
+
+> **MetricsProducerComponentType** = *typeof* [`MetricsProducerComponentType`](../variables/MetricsProducerComponentType.md)\[keyof *typeof* [`MetricsProducerComponentType`](../variables/MetricsProducerComponentType.md)\]
+
+Metrics producer component types.

package/docs/reference/type-aliases/TelemetryConnectorConfig.md

@@ -1,17 +1,5 @@
 # Type Alias: TelemetryConnectorConfig
 
-> **TelemetryConnectorConfig** = `object`
+> **TelemetryConnectorConfig** = \{ `type`: *typeof* [`EntityStorage`](../variables/TelemetryConnectorType.md#entitystorage); `options?`: `IEntityStorageTelemetryConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`OpenTelemetry`](../variables/TelemetryConnectorType.md#opentelemetry); `options?`: `IOpenTelemetryTelemetryConnectorConstructorOptions`; \}
 
 Telemetry connector config types.
-
-## Properties
-
-### type {#type}
-
-> **type**: *typeof* [`EntityStorage`](../variables/TelemetryConnectorType.md#entitystorage)
-
-***
-
-### options? {#options}
-
-> `optional` **options?**: `IEntityStorageTelemetryConnectorConstructorOptions`

package/docs/reference/variables/MetricsCollectorComponentType.md

@@ -0,0 +1,13 @@
+# Variable: MetricsCollectorComponentType
+
+> `const` **MetricsCollectorComponentType**: `object`
+
+Metrics collector component types.
+
+## Type Declaration
+
+### Service {#service}
+
+> `readonly` **Service**: `"service"` = `"service"`
+
+Service.

package/docs/reference/variables/MetricsProducerComponentType.md

@@ -0,0 +1,19 @@
+# Variable: MetricsProducerComponentType
+
+> `const` **MetricsProducerComponentType**: `object`
+
+Metrics producer component types.
+
+## Type Declaration
+
+### System {#system}
+
+> `readonly` **System**: `"system"` = `"system"`
+
+System.
+
+### Process {#process}
+
+> `readonly` **Process**: `"process"` = `"process"`
+
+Process.

package/docs/reference/variables/TelemetryConnectorType.md

@@ -11,3 +11,9 @@ Telemetry connector types.
 > `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
 
 Entity storage.
+
+### OpenTelemetry {#opentelemetry}
+
+> `readonly` **OpenTelemetry**: `"open-telemetry"` = `"open-telemetry"`
+
+OpenTelemetry.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.3-next.36",
+	"version": "0.0.3-next.38",
 	"description": "Component and connector type definitions with configuration helpers for engine composition.",
 	"repository": {
 		"type": "git",
@@ -62,8 +62,8 @@
 		"@twin.org/document-management-models": "next",
 		"@twin.org/document-management-rest-client": "next",
 		"@twin.org/document-management-service": "next",
-		"@twin.org/engine-core": "0.0.3-next.36",
-		"@twin.org/engine-models": "0.0.3-next.36",
+		"@twin.org/engine-core": "0.0.3-next.38",
+		"@twin.org/engine-models": "0.0.3-next.38",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",
@@ -132,7 +132,9 @@
 		"@twin.org/synchronised-storage-rest-client": "next",
 		"@twin.org/synchronised-storage-service": "next",
 		"@twin.org/telemetry-connector-entity-storage": "next",
+		"@twin.org/telemetry-connector-opentelemetry": "next",
 		"@twin.org/telemetry-models": "next",
+		"@twin.org/telemetry-producers": "next",
 		"@twin.org/telemetry-rest-client": "next",
 		"@twin.org/telemetry-service": "next",
 		"@twin.org/trust-generators": "next",