Key performance metrics

Extensions 1.0 end of life

OneAgent and ActiveGate version 1.299 are the last versions supporting OneAgent and ActiveGate Extensions 1.0 framework. You can continue using Extensions 1.0 if you stay at OneAgent or ActiveGate version 1.299. Note that this means you'll be using an unsupported Python version 3.8. We strongly recommend migrating your extensions to the latest Extensions 2.0 framework.

For more information, see General guidance and how to migrate.

With keymetrics you choose the two most important metrics for your extension-based monitoring needs that are to be displayed on the Process and Custom Device pages.

Key metrics

This enables you to compare the key metric values among your processes or custom devices.

Key metrics

You can also add a custom chart dashboard tile or create custom alerts based on the key metric values.

How to define key metrics in JSON

Identify the metric with the key property. Define the display name. The order is important, because the order in which you define the key metrics in JSON is reflected on the Process and Custom Device pages.

When defining key metrics, you should also decide on the two aspects of aggregation.

Time frame aggregation

In real time, the key metrics represent the present values. When you select a past time frame, you must define the aggregation method using the aggregation attribute.

Dimension aggregation

If your metric value is segmented by multiple dimensions, you need to define the method to merge the dimensions into a single one. You use mergeaggregation to do that.

{
"keyMetrics": [
{
"key": "threads_connected",
"aggregation": "avg",
"mergeaggregation": "sum",
"displayname": "Connections"
},
{
"key": "queries",
"aggregation": "avg",
"mergeaggregation": "sum",
"displayname": "Queries"
}
]
}

See JSON reference.