System Metrics API

Hono Command: command//<name>:<namespace>/req//request

Ditto Message:

Name	Value	Description
topic	<name>/<namespace>/things/live/messages/request	Information about the affected Thing and the type of operation
path	/features/Metrics/inbox/messages/request	A path to the Metrics Feature, it’s message channel, and request command
Headers		Additional headers
response-required	true/false	If response is required
content-type	application/json	The content type
correlation-id	container UUID	Used for correlating protocol messages, the same correlation-id as the sent back response message
Value
frequency		Time interval of how often the metrics data will be published as duration string (e.g. 5s)
filter		Filter defines the type of metric data to be reported
id		An array of identifiers whose metric data to be reported, supported are: cpu.utilization, memory.utilization, memory.total, memory.used, io.readBytes, io.writeBytes, net.readBytes, net.writeBytes, pids
originator		Metrics data originator

Example : Request metrics data with specified filter and frequency.

Topic: command//edge:device/req//request

{
	"topic":"edge/device/things/live/messages/request",
	"headers":{
		"response-required":true,
		"content-type":"application/json",
		"correlation-id":"<UUID>"
	},
	"path":"/features/Metrics/inbox/messages/request",
	"value":{
		"filter":[
			{
				"id":["io.*","cpu.*","memory.*"],
				"originator":"SYSTEM"
			}
		],
		"frequency":"5s"
	}
}

Hono Command : command//<name>:<namespace>/res//request

Ditto Message:

Name	Value	Description
topic	<name>/<namespace>/things/live/messages/request	Information about the affected Thing and the type of operation
path	/features/Metrics/outbox/messages/request	A path to the Metrics Feature, it’s message channel, and request command
Headers		Additional headers
content-type	application/json	The content type
correlation-id	<UUID>	The same correlation id as the request message
Status		Status of the operation request the metrics data

Example : Successful response of a request metrics message.

Topic: `command//edge:device/res//request``

{
	"topic":"edge/device/things/live/messages/request",
	"headers":{
		"content-type":"application/json",
		"correlation-id":"<UUID>"
	},
	"path":"/features/Metrics/outbox/messages/request",
	"status": 204
}

Hono Command : command//<name>:<namespace>/res//data

Ditto Message:

Name	Value	Description
topic	<name>/<namespace>/things/live/messages/data	Information about the affected Thing and the type of operation
path	/features/Metrics/outbox/messages/data	A path to the Metrics Feature, it’s message channel, and metrics data
Headers		Additional headers
content-type	application/json	The content type
Value		The value of the received data from the device in json format
timestamp		The timestamp in ms when this measure data is published
snapshot		All the measurements collected at a concrete time per originator
originator		The originator for whose metric data to be reported
measurements		An array of measurements identifier and value for originator
id		The identifier whose metric data to be reported, supported are: cpu.utilization, cpu.load1, cpu.load5, cpu.load15, memory.utilization, memory.total, memory.available, memory.used, io.readBytes, io.writeBytes
value		The measured value per metric ID

Example : Metrics data from the device.

Topic: `command//edge:device/res//data``

{
	"topic":"edge/device/things/live/messages/data",
	"headers":{
		"content-type":"application/json",
	},
	"path":"/features/Metrics/outbox/messages/data",
	"value":{
		"snapshot":[
			{
				"originator":"SYSTEM",
				"measurements":[
					{
						"id":"cpu.utilization",
						"value":1.1555555555484411
					},
					{
						"id":"cpu.load1",
						"value":0.17
					},
					{
						"id":"cpu.load5",
						"value":0.27
					},
					{
						"id":"cpu.load15",
						"value":0.24
					},
					{
						"id":"memory.total",
						"value":10371616768
					},
					{
						"id":"memory.available",
						"value":5281644544
					},
					{
						"id":"memory.used",
						"value":4563206144
					},
					{
						"id":"memory.utilization",
						"value":43.99705702662538
					}
				]
			}
		],
		"timestamp":1234567890
	}
}