Component metrics endpoints - Cloud

Talend Cloud APIs User Guide

Version
Cloud
Language
English
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
Last publication date
2024-04-03
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
POST /monitoring/observability/metrics/component Searches for raw component metrics data. No parameter.
{
    "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
        }
    ]
}

For further information about the fields to be used in the body, see the following section.

Fields used by the observability metrics endpoints

environmentId
Required
ID of the environment to which a task and its workspace belong
startTime
Required
The start time when a component in your Job task starts to work. The ISO format to be used is yyyy-MM-dd'T'HH:mm:ss.SSS'Z', for example, 2021-09-08T06:58:04.604Z.
endTime
Required
The end time when a component in your Job task terminates its work. The ISO format to be used is yyyy-MM-dd'T'HH:mm:ss.SSS'Z', for example, 2021-09-08T06:59:04.804Z.

startTime must be earlier than endTime.

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

filters
Optional
Used to filter metrics data in your search request sent to /monitoring/observability/metrics/component, for example,
{
    "field": "connector_id", 
    "operator": "in", 
    "value": ["tMongoDBConnection_1"]
}
This filter is applied on the connector_id field to find metrics data related to the component of which the ID is tMongoDBConnection_1.
{
    "field": "component_start_time_seconds", 
    "operator": "gt", 
    "value": 1628266578
}
This filter is applied on the component_start_time_seconds field to find metrics data related to the components which started to run at a time later than 1628266578.
{
    "field": "operator_type", 
    "operator": "in", 
    "value": ["HUMAN", "SERVICE"]
}
This filter is applied on the operator_type field to find metrics data related to tasks started by a user or a service account.
The fields to be used in a filter are:
  • engine_id
  • engine_type
  • engine_version
  • workspace_id
  • task_id
  • task_execution_id
  • job_name
  • connector_type, for example, tMongoDBConnection
  • connector_label, for example, tMongoDBConnection_1
  • connector_id, for example, tMongoDBConnection_1
  • component_start_time_seconds: this field supports gt, gte, lt and lte only while the other fields support in only
  • operator: the ID of the user or the service account that starts a task
  • operator_type: HUMAN for a user and SERVICE for a service account
The operators to be used in a filter are:
  • in: matches values in an array.
  • gt: later than. It requires a number or a string of number.
  • gte: equal or later than. It requires a number or a string of number.
  • lt: earlier than. It requires a number or a string of number.
  • lte: equal or earlier than. It requires a number or a string of number.