Endpoints des métriques des compossants - Cloud

Guide d'utilisation des API Talend Cloud
Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Création et développement > Création d'APIs
Création et développement > Test d'API
Méthode Endpoint Description Paramètres de requête Corps ;
GET /monitoring/observability/executions/{runId}/component Obtient les métriques d'un composant d'une exécution de tâche donnée.
  • limit (limite) : nombre d'entrées à retourner. La valeur par défaut est 50. La valeur maximale est 200.
  • offset : position de départ de pagination des logs, supérieure ou égale à 0
  • sortBy : champ selon lequel les entrées retournées sont triées. La valeur par défaut est component_start_time_seconds. Pour connaître les valeurs disponibles, consultez sortBy.
  • sortOrder : manière dont les logs retournés sont triés, desc ou asc. La valeur par défaut est desc, ce qui signifie un ordre décroissant.

    Que l'ordre soit ascendant (croissant) ou descendant (décroissant), un champ null ou vide est toujours placé à la fin de la liste à retourner dans la réponse.

Ces paramètres sont facultatifs.

 N/A
POST /monitoring/observability/metrics/component Recherche des données brutes de métriques d'un composant.   
{
    "environmentId": "6093f6a36f01d639680d31cd", 
    "startTime": "2021-09-08T06:58:04.604Z", 
    "endTime": "2021-09-08T06:58:06.463Z", 
    "limit": 50, 
    "offset": 0, 
    "sortBy": "component_start_time_seconds", 
    "sortOrder": "asc", 
    "filters": [
       {
            "field": "engine_id", 
            "operator": "in", 
            "value": ["a60bb1c0-7669-407f-9326-138af05da18a"]
        },
        {
            "field": "component_start_time_seconds", 
            "operator": "gte", 
            "value": 1628266578
        }
    ]
}

Pour plus d'informations concernant les champs à utiliser dans le corps, consultez la section suivante.

Champs utilisés par les endpoints de métriques d'observabilité

environmentId
Requis
ID de l'environnement auquel une tâche et son espace de travail appartiennent
startTime
Requis
Heure de démarrage de génération des données de métriques, c'est-à-dire démarrage d'une tâche de Job. Le format ISO à utiliser est yyyy-MM-dd'T'HH:mm:ss.SSS'Z', par exemple, 2021-09-08T06:58:04.604Z.
endTime
Requis
Heure de fin de génération des données de métriques, c'est-à-dire arrêt de l'exécution d'une tâche de Job. Le format ISO à utiliser est yyyy-MM-dd'T'HH:mm:ss.SSS'Z', par exemple, 2021-09-08T06:59:04.804Z.

L'heure de début (startTime) doit être antérieure à l'heure de fin (endTime).

limit
Facultatif
Nombre d'entrées à retourner. La valeur par défaut est 50. La valeur maximale est 200.
offset
Facultatif
Position de départ de pagination des entrées, supérieure ou égale à 0.
sortBy
Facultatif
Champ selon lequel les entrées retournées sont triées. La valeur par défaut est component_start_time_seconds. Les champs à utiliser sont :
  • account_id
  • engine_id
  • engine_type
  • engine_version
  • workspace_id
  • task_id
  • task_execution_id
  • process_id : identifiant unique universel de la JVM
  • job_name
  • pid : identifiant unique du Job pour l'exécution courante
  • father_pid : ID du premier Job parent direct
  • root_pid : ID du premier Job racine s'il y a plusieurs sous-Jobs
  • connector_type
  • connector_label
  • connector_id
  • target_connector_type
  • target_label
  • target_id
  • connection_type
  • connection_name
  • component_start_time_seconds
  • component_connection_rows_total
  • component_execution_duration_milliseconds
sortOrder
Facultatif
Manière dont les logs retournés sont triés, desc or asc. La valeur par défaut est desc, ce qui signifie un ordre décroissant.

Que l'ordre soit ascendant (croissant) ou descendant (décroissant), un champ null ou vide est toujours placé à la fin de la liste à retourner dans la réponse.

Filtres
Facultatif
Utilisé pour filtrer des données de métriques dans vos requêtes de recherche envoyées à /monitoring/observability/metrics/component, par exemple, 
{
    "field": "connector_id", 
    "operator": "in", 
    "value": ["tMongoDBConnection_1"]
}
Ce filtre est appliqué sur le champ connector_id pour trouver les données de métriques associées au composant dont l'ID est tMongoDBConnection_1. 
{
    "field": "component_start_time_seconds", 
    "operator": "gt", 
    "value": 1628266578
}
Ce filtre est appliqué sur le champ component_start_time_seconds pour trouver les données de métriques associées aux composants dont l'exécution a commencé après 1628266578. 
{
    "field": "operator_type", 
    "operator": "in", 
    "value": ["HUMAN", "SERVICE"]
}
Ce filtre est appliqué sur le champ operator_type pour trouver les données de métriques associées aux tâches démarrées par un·e utilisateur·trice ou un compte de service.
Les champs à utiliser dans un filtre sont :
  • engine_id
  • engine_type
  • engine_version
  • workspace_id
  • task_id
  • task_execution_id
  • job_name
  • connector_type, par exemple, tMongoDBConnection
  • connector_label, par exemple, tMongoDBConnection_1
  • connector_id, par exemple, tMongoDBConnection_1
  • component_start_time_seconds : ce champ supporte gt, gte, lt et lte. Les autres champs supportent uniquement in.
  • operator : ID de l'utilisateur·trice ou du compte de service démarrant une tâche.
  • operator_type : HUMAN pour un·e utilisateur·trice et SERVICE pour un compte de service.
Les opérateurs à utiliser dans un filtre sont :
  • in : rapproche les valeurs dans un tableau.
  • gt : plus récent que. Requiert un nombre ou une chaîne de caractères de nombres.
  • gte : égal à ou plus récent que. Requiert un nombre ou une chaîne de caractères de nombres.
  • lt : plus ancien que. Requiert un nombre ou une chaîne de caractères de nombres.
  • lte : égal ou plus ancien que. Requiert un nombre ou une chaîne de caractères de nombres.