observe_metrics_list

Tool

observe_metrics_list

Catalogue the metrics of the current product: what exists, whether it is a counter or a histogram, its unit, which services report it and which attribute keys its series carry.

Catalogue the metrics of the current product: what exists, whether it is a counter or a histogram, its unit, which services report it and which attribute keys its series carry. Read this before observe_metrics_query — it is where a name, a type and a groupBy key come from.

Behavior

HTTP: GET /observe/metrics/catalog

Arguments

Name	Type	Required	Description
search	string	—	Only metrics whose name contains this text, case-insensitively
window	string	—	How far back to look for metrics; default "24h"
service	string	—	Only metrics reported by this service, e.g. "api"
environment	string	—	Only metrics reported in this environment, e.g. "production"

Response

Field	Type	Always	Description
window	string	•	The window that was catalogued
metrics	array	•	The metrics seen in the window, by name

Try it

Catalogue the metrics of the current product: what exists, whether it is a counter or a histogram, its unit, which services report it and which attribute keys its series carry.

When to use

Example

Ask your agent something like this:

Catalogue the metrics of the current product: what exists, whether it is a counter or a histogram, its unit, which services report it and which attribute keys its series carry.

The agent will invoke observe_metrics_list with these arguments:

{}