What's on this page

Publishing Metrics

Resources publish metrics via Kakfa. Each of the two metrics described below are published to a separate Kafka topic. Integrity metrics are published to the alm__integrity topic and load metrics are published to the alm__load topic. The message contents are:

Integrity Metrics

{

  "metricKey" : "142971c5-a84b-4d34-af15-435ba8640aec",

  "metricName" : "h_integrity",

  “metricId” : "142971c5-a84b-4d34-af15-435ba8640aec.h_integrity",

  "integrity" : "OK",

  "message" : "Everything is working"

}
Field Description Mandatory
metricKey The key provided when the resource was created Yes
metricName The name of the metric as defined in the resource descriptor No
metricId The unique ID for this metric value. Made from concatenating the metricKey and the metricName. This is used as the Kafka Key so all Resources must send this value so that multiple metrics with the same name can be supported correctly. Yes
integrity Allowed values: OK when the resource is healthy and passing its Integrity checks and BROKEN when the checks fail Yes
message An optional message to add value to the metric – useful in the event of BROKEN No

Load Metrics

{

  "metricKey" : "818127b3-1904-4737-a60c-8c7bab73532d",

  "metricName" : "h_load",

  “metricId” : "818127b3-1904-4737-a60c-8c7bab73532d.h_load",

  "load" : 76,

  "message" : "Load is high"

}
Field Description Mandatory
metricKey The key provided when the resource was created Yes
metricName The name of the metric as defined in the resource descriptor No
metricId The unique ID for this metric value. Made from concatenating the metricKey and the metricName. This is used as the Kafka Key so all Resources must send this value so that multiple metrics with the same name can be supported correctly. Yes
load A value between 0 and 100 (i.e. a percentage) indicating the level of the load a resource is experiencing. A higher value indicates a higher load Yes
message An optional test string to include information about the integrity of the resource. for example, it may include an error code No