apmtrace.get

Description

integer/array apmtrace.get(object parameters)

Cette méthode vous permet de récupérer des traces 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 des rôles 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 traces dont le span racine a commencé à l'heure indiquée ou après.

Comportement du paramètre :
- obligatoire
time_till timestamp Retourne uniquement les traces dont le span racine a commencé avant l'heure indiquée.

Comportement du paramètre :
- obligatoire
traceids string/array Retourne uniquement les traces correspondant aux ID indiqués.
resource_attributes object/array Retourne uniquement les traces dont le span racine possède les attributs de ressource indiqués.
Format : [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne toutes les traces.

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.
span_attributes object/array Retourne uniquement les traces dont le span racine possède les attributs de span indiqués.
Format : [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne toutes les traces.

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.
span_attributes_evaltype integer Méthode d'évaluation des conditions dans span_attributes.

Valeurs possibles :
0 - (par défaut) Et/Ou ;
2 - Ou.
min_duration integer Retourne uniquement les traces dont la duration du span racine est supérieure ou égale à la valeur indiquée, en nanosecondes.
max_duration integer Retourne uniquement les traces dont la duration du span racine est inférieure à la valeur indiquée, en nanosecondes.
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 à comparer.

Propriétés prises en charge : traceid, spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, status_code, status_message.
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 : trace_state, span_name, service_name, scope_name, scope_version, status_message.
sortfield string/array Trie le résultat selon les propriétés indiquées.

Valeurs possibles : timestamp, traceid, spanid, trace_state, span_name, span_kind, service_name, scope_name, scope_version, duration, status_code, status_message.
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 l'un des éléments suivants :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des traces lentes

Récupérez les deux traces les plus lentes du service zabbix-nginx. Recherchez les traces entre 10:00 et 11:00 le 1er octobre 2026 (UTC), et incluez uniquement celles dont la durée est d’au moins 1 seconde.

Requête:

{
    "jsonrpc": "2.0",
    "method": "apmtrace.get",
    "params": {
        "output": ["timestamp", "traceid", "span_name", "service_name", "duration", "status_code", "span_count", "error_count"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "filter": {
            "service_name": "zabbix-nginx"
        },
        "min_duration": 1000000000,
        "sortfield": "duration",
        "sortorder": "DESC",
        "limit": 2
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "timestamp": "1790849274910226417",
            "traceid": "8a4f1c7e2b9d4e6fa0c3b5d7e9f1a2c4",
            "span_name": "POST /zabbix.php",
            "service_name": "zabbix-nginx",
            "duration": "30412907815",
            "status_code": "Error",
            "span_count": "49",
            "error_count": "2"
        },
        {
            "timestamp": "1790850512338104952",
            "traceid": "dee625f33cb0994e86c5cd4640e3b09c",
            "span_name": "POST /zabbix.php",
            "service_name": "zabbix-nginx",
            "duration": "1104826531",
            "status_code": "Unset",
            "span_count": "27",
            "error_count": "0"
        }
    ],
    "id": 1
}

Voir aussi

Source

CApmTrace::get() dans ui/include/classes/api/services/CApmTrace.php.