apmspan.get

Description

integer/array apmspan.get(object parameters)

Cette méthode vous permet de récupérer des spans 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 spans ayant commencé à l'heure indiquée ou après.

Comportement du paramètre :
- requis
time_till timestamp Retourne uniquement les spans ayant commencé avant l'heure indiquée.

Comportement du paramètre :
- requis
traceids string/array Retourne uniquement les spans appartenant aux traces indiquées.
spanids string/array Retourne uniquement les spans possédant les ID indiqués.
parent_spanids string/array Retourne uniquement les spans possédant les spans parents indiqués.
resource_attributes object/array Retourne uniquement les spans possédant les attributs de ressource indiqués.
Format : [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne tous les spans.

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 spans possédant les attributs de span indiqués.
Format : [{"key": "<key>", "value": "<value>", "operator": "<operator>"}, ...].
Un tableau vide retourne tous les spans.

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 spans dont la durée est supérieure ou égale à la valeur indiquée, en nanosecondes.
max_duration integer Retourne uniquement les spans dont la durée 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, parent_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, parent_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 les informations 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 de la hiérarchie des spans d'une trace

Récupérez les quatre premiers spans de la trace "dee625f33cb0994e86c5cd4640e3b09c", triés par heure de début. La propriété parent_spanid indique la relation entre les spans : le span racine n'a pas de parent, et chaque autre span fait référence au span qui l'a démarré.

Requête :

{
    "jsonrpc": "2.0",
    "method": "apmspan.get",
    "params": {
        "output": ["spanid", "parent_spanid", "service_name", "span_name", "duration", "status_code"],
        "time_from": 1790848800,
        "time_till": 1790852400,
        "traceids": "dee625f33cb0994e86c5cd4640e3b09c",
        "sortfield": "timestamp",
        "sortorder": "ASC",
        "limit": 4
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "spanid": "7c1a9e2f4b6d8a03",
            "parent_spanid": "",
            "service_name": "zabbix-nginx",
            "span_name": "POST /zabbix.php",
            "duration": "1104826531",
            "status_code": "Unset"
        },
        {
            "spanid": "3f8b2c6d1e9a7054",
            "parent_spanid": "7c1a9e2f4b6d8a03",
            "service_name": "zabbix-frontend",
            "span_name": "POST /zabbix.php",
            "duration": "1098230418",
            "status_code": "Unset"
        },
        {
            "spanid": "b3390ad41931ed08",
            "parent_spanid": "3f8b2c6d1e9a7054",
            "service_name": "zabbix-frontend",
            "span_name": "mysqli::real_connect",
            "duration": "36671360",
            "status_code": "Ok"
        },
        {
            "spanid": "e41f7a2c9d5b3086",
            "parent_spanid": "3f8b2c6d1e9a7054",
            "service_name": "zabbix-frontend",
            "span_name": "mysqli_query",
            "duration": "19704118",
            "status_code": "Ok"
        }
    ],
    "id": 1
}

Voir aussi

Source

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