Bilješka
Pristup ovoj stranici zahtijeva provjeru vjerodostojnosti. Možete pokušati da se prijavite ili promijenite direktorije.
Pristup ovoj stranici zahtijeva provjeru vjerodostojnosti. Možete pokušati promijeniti direktorije.
The connector for OPC UA emits observability metrics that you can use to monitor the health of your solution. This article lists the available metrics. Each section gives the name, type, description, and dimensions for each metric.
Common metrics
These metrics are emitted by all three components: the supervisor, the OPC UA connector, and the OPC UA commander.
| Metric | Type | Description | Dimensions |
|---|---|---|---|
| aio.opc.heartbeat.count | Counter | Number of heartbeat signals emitted by the component instance. | instance |
| aio.opc.instance.count | Gauge | Current number of active component instances. | service.name, instance |
| aio.opc.mqtt.message.publishing.retry.count | Counter | Number of times publishing an MQTT message had to be retried. | aio.opc.mqtt.message.qos |
| aio.opc.mqtt.message.publishing.failure.count | Counter | Number of failed attempts to publish an MQTT message. | aio.opc.mqtt.client.id, aio.opc.mqtt.publish.result |
| aio.opc.mqtt.message.publishing.duration | Histogram | Duration of publishing a message to the MQTT broker and receiving an acknowledgment. | aio.opc.mqtt.message.qos, aio.opc.mqtt.publish.result |
| aio.opc.mqtt.client.connect.count | Counter | Number of times the MQTT client tried to connect. | aio.opc.mqtt.client.purpose |
| aio.opc.mqtt.client.connect.failure.count | Counter | Number of times the MQTT client failed to connect. | aio.opc.mqtt.client.purpose |
| aio.opc.mqtt.client.subscription.failure.count | Counter | Number of times the MQTT client failed to subscribe to a topic. | aio.opc.mqtt.client.id, aio.opc.mqtt.topic, aio.opc.mqtt.subscribe.result |
| aio.opc.mqtt.client.disconnect.count | Counter | Number of times the MQTT client disconnected. | aio.opc.mqtt.client.id |
| aio.opc.mqtt.client.publish.attempt.when.disconnected.count | Counter | Number of times a publish attempt was made when the MQTT client was disconnected. | |
| aio.opc.component.shutdown.count | Counter | Number of times the component is shut down. | aio.opc.component.shutdown.originator, aio.opc.component.shutdown.code |
Supervisor
| Metric | Type | Description | Dimensions |
|---|---|---|---|
| aio.opc.asset.count | ObservableGauge | Number of assets currently deployed. | |
| aio.opc.endpoint.count | ObservableGauge | Number of deployed asset endpoint profiles. | |
| aio.opc.asset.datapoint.count | ObservableGauge | Number of datapoints defined across all assets. | |
| aio.opc.asset.event.count | ObservableGauge | Number of events defined across all assets. | |
| aio.opc.connector.failover.duration | Histogram | Duration of a connector instance failover, measured from when the connector is detected as missing until the passive instance confirms its activation. | aio.opc.connector-schema, aio.opc.connector-name |
| aio.opc.connector.asset.count | Histogram | Number of assets assigned per connector instance. | aio.opc.connector-name |
| aio.opc.connector.endpoint.count | Histogram | Number of endpoints assigned per connector instance. | aio.opc.connector-name |
| aio.opc.connector.load | Histogram | Number that indicates the load per connector instance. | aio.opc.connector-name |
| aio.opc.schema.connector.count | Histogram | Number of connector instances per schema. | aio.opc.connector-schema |
OPC UA connector
Dimensions marked with (1) are emitted only when ExperimentalConfiguration.EnableUnboundedMetricDimensions is set to true, because of unbounded cardinality.
| Metric | Type | Description | Dimensions |
|---|---|---|---|
| aio.opc.subscription.transfer.count | Counter | Number of times a subscription is transferred. | |
| aio.opc.asset.telemetry.data_change.count | Counter | Number of asset data changes received. | |
| aio.opc.asset.telemetry.event.count | Counter | Number of asset events received. | |
| aio.opc.asset.telemetry.value_change.count | Counter | Number of asset value changes received. | aio.opc.value-change.status |
| aio.opc.asset.session.connect.count | Counter | Number of asset session connect events. | aio.opc.session-name (1), aio.opc.endpoint (1) |
| aio.opc.asset.session.disconnect.count | Counter | Number of asset session disconnect events. | aio.opc.session-name (1), aio.opc.endpoint (1), aio.opc.error-source |
| aio.opc.session.connect.duration | Histogram | OPC UA session connect duration. | aio.opc.connect.result, aio.opc.endpoint (1) |
| aio.opc.data_change.processing.duration | Histogram | Processing duration of data changes received from an asset, measured from when the connector receives the data change until it receives a publish acknowledgment from the MQTT broker. | aio.opc.mqtt.messages.count, aio.opc.mqtt.messages.error.any, aio.opc.processing.error |
| aio.opc.event.processing.duration | Histogram | Processing duration of events received from an asset, measured from when the connector receives the event until it receives a publish acknowledgment from the MQTT broker. | aio.opc.mqtt.messages.count |
| aio.opc.data_change.delivery_time.duration | Histogram | Data change delivery latency, measured from when the OPC UA server publishes the data until the connector receives it. | aio.opc.endpoint (1) |
| aio.opc.event_delivery_time.duration | Histogram | Event delivery latency, measured from when the OPC UA server publishes the event until the connector receives it. | aio.opc.endpoint (1) |
| aio.opc.message.egress.size | Histogram | Number of bytes for telemetry sent by the assets. | aio.opc.compression |
| aio.opc.method.request.count | Counter | Number of method invocations received. | aio.opc.method |
| aio.opc.method.response.count | Counter | Number of method invocations responded to. | aio.opc.method |
| aio.opc.mqtt.message.processing.duration | Histogram | Processing duration of messages received from the MQTT broker (method invocations, writes). | |
| aio.opc.mqtt.queue.ack.size | ObservableGauge | Number of incoming MQTT messages with QoS > 0 whose delivery acknowledgment hasn't been sent to the MQTT broker yet. | |
| aio.opc.mqtt.queue.notack.size | ObservableGauge | Number of incoming MQTT messages with QoS > 0 in the acknowledgment queue whose acknowledgment period timed out because of delays acknowledging previous messages. | |
| aio.opc.output_queue.count | ObservableGauge | Number of asset telemetry items (data changes or events) queued for publish to the MQTT broker. |
OPC UA commander
| Metric | Type | Description | Dimensions |
|---|---|---|---|
| aio.opc.browse.count | Counter | Number of browse calls executed. | |
| aio.opc.browse.succeeded | Counter | Number of browse calls that succeeded. | |
| aio.opc.browse.failed | Counter | Number of browse calls that failed. | |
| aio.opc.browse.nodes.count | Gauge | Total number of OPC UA nodes browsed. | |
| aio.opc.asset.call.count | Counter | Number of asset action calls attempted. | |
| aio.opc.asset.call.completed | Counter | Number of asset action calls that succeeded. | |
| aio.opc.asset.call.failed | Counter | Number of asset action calls that failed. | |
| aio.opc.method.call.count | Counter | Number of OPC UA method calls attempted. | |
| aio.opc.method.call.completed | Counter | Number of OPC UA method calls that succeeded. | |
| aio.opc.method.call.failed | Counter | Number of OPC UA method calls that failed. | |
| aio.opc.action.count | Counter | Number of dataset action calls executed. | |
| aio.opc.action.succeeded | Counter | Number of dataset action calls that succeeded fully. | |
| aio.opc.action.failed | Counter | Number of dataset action calls that failed at least partially. | |
| aio.opc.node.read.count | Counter | Number of OPC UA node read calls attempted. | |
| aio.opc.node.read.succeeded | Counter | Number of OPC UA node read calls that succeeded. | |
| aio.opc.node.read.failed | Counter | Number of OPC UA node read calls that failed. | |
| aio.opc.node.write.count | Counter | Number of OPC UA node write calls attempted. | |
| aio.opc.node.write.succeeded | Counter | Number of OPC UA node write calls that succeeded. | |
| aio.opc.node.write.failed | Counter | Number of OPC UA node write calls that failed. | |
| aio.opc.write.count | Counter | Number of explicit write calls executed. | |
| aio.opc.write.succeeded | Counter | Number of explicit write calls that succeeded fully. | |
| aio.opc.write.failed | Counter | Number of explicit write calls that failed at least partially. | |
| aio.opc.read.count | Counter | Number of dataset read calls executed. | |
| aio.opc.read.succeeded | Counter | Number of dataset read calls that succeeded fully. | |
| aio.opc.read.failed | Counter | Number of dataset read calls that failed at least partially. | |
| aio.opc.syncprops.count | Counter | Number of SyncProperties calls executed. |
|
| aio.opc.syncprops.succeeded | Counter | Number of SyncProperties calls that succeeded fully. |
|
| aio.opc.syncprops.failed | Counter | Number of SyncProperties calls that failed at least partially. |
|
| aio.opc.syncprops.total | Counter | Total number of properties read from OPC UA and written to the state store. | |
| aio.opc.managed_service.running | UpDownCounter | Number of currently running managed services. | service_type |
| aio.opc.managed_service.crashes | Counter | Number of managed service crashes. | service_type |
| aio.opc.managed_service.restarts | Counter | Number of managed service restarts. | service_type |
MCP Tool
| Metric | Type | Description | Dimensions |
|---|---|---|---|
| aio.opc.mcp.generateschema.count | Counter | Number of times the GenerateSchema tool was called. |
|
| aio.opc.mcp.generateschema.success | Counter | Number of times the GenerateSchema tool completed successfully. |
|
| aio.opc.mcp.generateschema.failed | Counter | Number of times the GenerateSchema tool failed. |
|
| aio.opc.mcp.datasetaction.count | Counter | Number of times the DatasetAction tool was called. |
|
| aio.opc.mcp.datasetaction.success | Counter | Number of times the DatasetAction tool completed successfully. |
|
| aio.opc.mcp.datasetaction.failed | Counter | Number of times the DatasetAction tool failed. |
|
| aio.opc.mcp.datasetread.count | Counter | Number of times the DatasetRead tool was called. |
|
| aio.opc.mcp.datasetread.success | Counter | Number of times the DatasetRead tool completed successfully. |
|
| aio.opc.mcp.datasetread.failed | Counter | Number of times the DatasetRead tool failed. |
|
| aio.opc.mcp.datasetwrite.count | Counter | Number of times the DatasetWrite tool was called. |
|
| aio.opc.mcp.datasetwrite.success | Counter | Number of times the DatasetWrite tool completed successfully. |
|
| aio.opc.mcp.datasetwrite.failed | Counter | Number of times the DatasetWrite tool failed. |
|
| aio.opc.mcp.browse.count | Counter | Number of times the Browse tool was called. |
|
| aio.opc.mcp.browse.success | Counter | Number of times the Browse tool completed successfully. |
|
| aio.opc.mcp.browse.failed | Counter | Number of times the Browse tool failed. |
|
| aio.opc.mcp.discoverassets.count | Counter | Number of times the DiscoverAssets tool was called. |
|
| aio.opc.mcp.discoverassets.success | Counter | Number of times the DiscoverAssets tool completed successfully. |
|
| aio.opc.mcp.discoverassets.failed | Counter | Number of times the DiscoverAssets tool failed. |
|
| aio.opc.mcp.typebased.discoverassets.count | Counter | Number of times the TypeBasedDiscoverAssets tool was called. |
|
| aio.opc.mcp.typebased.discoverassets.success | Counter | Number of times the TypeBasedDiscoverAssets tool completed successfully. |
|
| aio.opc.mcp.typebased.discoverassets.failed | Counter | Number of times the TypeBasedDiscoverAssets tool failed. |
|
| aio.opc.mcp.readmanagementaction.count | Counter | Number of times the ReadManagementAction tool was called. |
|
| aio.opc.mcp.readmanagementaction.success | Counter | Number of times the ReadManagementAction tool completed successfully. |
|
| aio.opc.mcp.readmanagementaction.failed | Counter | Number of times the ReadManagementAction tool failed. |
|
| aio.opc.mcp.writemanagementaction.count | Counter | Number of times the WriteManagementAction tool was called. |
|
| aio.opc.mcp.writemanagementaction.success | Counter | Number of times the WriteManagementAction tool completed successfully. |
|
| aio.opc.mcp.writemanagementaction.failed | Counter | Number of times the WriteManagementAction tool failed. |
|
| aio.opc.mcp.callmanagementaction.count | Counter | Number of times the CallManagementAction tool was called. |
|
| aio.opc.mcp.callmanagementaction.success | Counter | Number of times the CallManagementAction tool completed successfully. |
|
| aio.opc.mcp.callmanagementaction.failed | Counter | Number of times the CallManagementAction tool failed. |
|
| aio.opc.mcp.syncproperties.count | Counter | Number of times the SyncProperties tool was called. |
|
| aio.opc.mcp.syncproperties.success | Counter | Number of times the SyncProperties tool completed successfully. |
|
| aio.opc.mcp.syncproperties.failed | Counter | Number of times the SyncProperties tool failed. |
Dimension reference
instance
Identifier of the component instance that emitted the metric.
service.name
Name of the service that emitted the metric.
aio.opc.mqtt.message.qos
QoS setting used for MQTT publishing.
aio.opc.mqtt.publish.result
Result code of the MQTT publish request.
aio.opc.mqtt.client.id
MQTT client identifier.
aio.opc.mqtt.client.purpose
Purpose of the MQTT client connection.
aio.opc.mqtt.topic
Topic the MQTT message was published or subscribed to.
aio.opc.mqtt.subscribe.result
Result code of the MQTT subscribe request.
aio.opc.component.shutdown.originator
Component or subsystem that initiated the shutdown.
aio.opc.component.shutdown.code
Exit code at the time of component shutdown.
aio.opc.connector-schema
Name of the connector schema.
aio.opc.connector-name
Name of the connector.
aio.opc.value-change.status
Status code associated with an OPC UA value change. Values are good, bad, or localOverride.
aio.opc.session-name
OPC UA session name. This attribute has unbounded cardinality and is emitted only when ExperimentalConfiguration.EnableUnboundedMetricDimensions is set to true.
aio.opc.endpoint
Endpoint address of the OPC UA server. This attribute has unbounded cardinality and is emitted only when ExperimentalConfiguration.EnableUnboundedMetricDimensions is set to true.
aio.opc.connect.result
Result of the OPC UA session connect attempt. Values are succeeded or failed.
aio.opc.error-source
Origin of the error. Values are internal or external.
aio.opc.mqtt.messages.count
Number of messages the OPC UA DataChangeNotification was split into. Values are single or multiple.
aio.opc.mqtt.messages.error.any
Whether any messages of the OPC UA DataChangeNotification couldn't be published to MQTT. Values are true or false.
aio.opc.processing.error
Whether an error occurred while processing the OPC UA DataChangeNotification. Values are true or false.
aio.opc.compression
Compression used for the MQTT message payload. Values are none, brotli, or gzip.
aio.opc.method
Name of the method invoked on the OPC UA server.
service_type
Type of managed service. Currently, the only value is OPC UA Commander.