Component metrics endpoints - Cloud

Talend Cloud APIs User Guide

Version
Cloud
Language
English (United States)
Product
Talend Cloud
Module
Talend API Designer
Talend API Tester
Talend Data Preparation
Talend Data Stewardship
Talend Management Console
Content
Design and Development > Designing APIs
Design and Development > Testing APIs
Method Endpoint Description Query parameters Body
GET /monitoring/observability/executions/{runId}/component Gets component metrics of a given task run.
  • limit: number of entries to return. The default value is 50 and the maximum value is 200
  • offset: the start position of the pagination of the entries, greater or equal to 0
  • sortBy: the field by which the returned entries are sorted. The default value is component_start_time_seconds. For all the available values, see sortBy.
  • sortOrder: the way in which the returned logs are sorted, desc or asc. The default value is desc, meaning the order is descending.

    Whether the order is ascending or descending, a null or an empty field is always placed at the end of the list to be returned in the response.

These parameters are all optional.

N/A

Fields used by the observability metrics endpoints

limit
Optional
Number of entries to return. The default value is 50 and the maximum value is 200
offset
Optional
The start position of the pagination of the entries, greater or equal to 0
sortBy
Optional
The field by which the returned entries are sorted. The default value is component_start_time_seconds. The fields to be used are:
  • account_id
  • engine_id
  • engine_type
  • engine_version
  • workspace_id
  • task_id
  • task_execution_id
  • process_id: JVM's UUID
  • job_name
  • pid: unique Job identifier for the current run
  • father_pid: ID of the first direct parent Job
  • root_pid: ID of the first root Job if there are several Subjobs
  • 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
Optional
The way in which the returned logs are sorted, desc or asc. The default value is desc, meaning the order is descending.

Whether the order is ascending or descending, a null or an empty field is always placed at the end of the list to be returned in the response