Sommaire
apmmetric.get
Description
integer/array apmmetric.get(object parameters)
Cette méthode vous permet de récupérer des points de données de métriques selon les paramètres indiqués.
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez la page Rôles utilisateur pour plus d'informations.
Paramètres
(object) Paramètres définissant le résultat souhaité.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| time_from | timestamp | Retourne uniquement les points de données dont l'heure est égale ou postérieure à l'heure indiquée. Comportement du paramètre : - requis |
| time_till | timestamp | Retourne uniquement les points de données dont l'heure est antérieure à l'heure indiquée. Comportement du paramètre : - requis |
| types | integer/array | Retourne uniquement les points de données des types indiqués. Consultez la page de l'objet de métrique APM pour obtenir la liste des types de métriques pris en charge. |
| with_flags_on | integer | Retourne uniquement les points de données pour lesquels tous les indicateurs indiqués sont définis. Pour spécifier plusieurs indicateurs, utilisez la somme de leurs valeurs. |
| with_flags_off | integer | Retourne uniquement les points de données pour lesquels aucun des indicateurs indiqués n'est défini. Pour spécifier plusieurs indicateurs, utilisez la somme de leurs valeurs. |
| resource_attributes | object/array | Retourne uniquement les points de données possédant les attributs de ressource indiqués. Format : [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide retourne tous les points de données. Valeurs possibles de l'opérateur : 0 - (par défaut) Contient ; 1 - Est égal à ; 2 - Ne contient pas ; 3 - N'est pas égal à ; 4 - Existe ; 5 - N'existe pas. |
| resource_attributes_evaltype | integer | Méthode d'évaluation des conditions dans resource_attributes.Valeurs possibles : 0 - (par défaut) Et/Ou ; 2 - Ou. |
| scope_attributes | object/array | Retourne uniquement les points de données possédant les attributs de portée indiqués. Format : [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide retourne tous les points de données. Valeurs possibles de l'opérateur : 0 - (par défaut) Contient ; 1 - Est égal à ; 2 - Ne contient pas ; 3 - N'est pas égal à ; 4 - Existe ; 5 - N'existe pas. |
| scope_attributes_evaltype | integer | Méthode d'évaluation des conditions dans scope_attributes.Valeurs possibles : 0 - (par défaut) Et/Ou ; 2 - Ou. |
| attributes | object/array | Retourne uniquement les points de données possédant les attributs indiqués. Format : [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide retourne tous les points de données. Valeurs possibles de l'opérateur : 0 - (par défaut) Contient ; 1 - Est égal à ; 2 - Ne contient pas ; 3 - N'est pas égal à ; 4 - Existe ; 5 - N'existe pas. |
| attributes_evaltype | integer | Méthode d'évaluation des conditions dans attributes.Valeurs possibles : 0 - (par défaut) Et/Ou ; 2 - Ou. |
| filter | object | Retourne uniquement les résultats correspondant exactement au filtre indiqué. Accepte un objet dont les clés sont des noms de propriétés et dont les valeurs sont soit une valeur unique, soit un tableau de valeurs auxquelles effectuer la correspondance. Propriétés prises en charge : resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, flags. |
| search | object | Retourne les résultats correspondant au modèle indiqué (sans distinction entre majuscules et minuscules). Accepte un objet dont les clés sont des noms de propriétés et dont les valeurs sont des chaînes à rechercher. Si aucune option supplémentaire n'est indiquée, une recherche LIKE "%…%" est effectuée.Propriétés prises en charge : resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_description, metric_unit. |
| sortfield | string/array | Trie le résultat selon les propriétés indiquées. Valeurs possibles : type, resource_schema_url, scope_schema_url, scope_name, scope_version, service_name, metric_name, metric_unit, start_time_unix, time_unix. |
| offset | integer | Nombre d'enregistrements à ignorer avant de retourner le résultat. |
| countOutput | boolean | Ces paramètres sont décrits dans le commentaire de référence. |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs de retour
(integer/array) Renvoie soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération des points de données d’un histogramme
Récupérer le dernier point de données de la métrique d’histogramme http.server.request.duration du service zabbix-frontend.
Requête :
{
"jsonrpc": "2.0",
"method": "apmmetric.get",
"params": {
"output": ["metric_name", "metric_unit", "time_unix", "count", "sum", "min", "max", "explicit_bounds", "bucket_counts", "exemplars"],
"time_from": 1790848800,
"time_till": 1790852400,
"types": 2,
"filter": {
"service_name": "zabbix-frontend",
"metric_name": "http.server.request.duration"
},
"sortfield": "time_unix",
"sortorder": "DESC",
"limit": 1
},
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"metric_name": "http.server.request.duration",
"metric_unit": "s",
"time_unix": "1790852390000000000",
"count": "1842",
"sum": "412.773",
"min": "0.0061",
"max": "1.098",
"explicit_bounds": ["0.005", "0.05", "0.1", "0.25", "0.5", "1"],
"bucket_counts": ["0", "211", "904", "512", "167", "41", "7"],
"exemplars": [
{
"traceid": "dee625f33cb0994e86c5cd4640e3b09c",
"spanid": "3f8b2c6d1e9a7054",
"value": "1.098",
"time_unix": "1790850513439147623",
"filtered_attributes": {}
}
]
}
],
"id": 1
}Voir aussi
Source
CApmMetric::get() dans ui/include/classes/api/services/CApmMetric.php.