Getting component metrics of task runs for performance monitoring - 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

Use Talend API service to get the observability metrics of your Data Integration tasks, running on a Cloud Engine.

The support for Remote Engine of this endpoint is for the EAP (Early Adopter Program) users only.

Raw observability data is returned in the responses, including details about running durations, components used in Jobs, engine information and operators that start tasks, for example, an administrator.

This observability metrics shows the characteristics of your task runs. With these characteristics, you can
  • debug and identify issues in your production
  • analyze task runs to predict issues in your production
  • build reports about your task runs

The retention period of your metrics data is 31 days.

The following sections explain the related endpoints and some use cases for demonstration purposes.

Prerequisites:
  • The user or the service account to be used to issue the API request has the appropriate permissions:
    • A user must have the Operator role. Its role ID is a3461557-8ee1-4321-ba40-860e7151fc51.
    • A service account must have the TMC_OPERATOR permission. Note that roles cannot be assigned to a service account.
  • Generate access tokens:

    Once generated, a service account token expires after 30 minutes. If it expires, generate a new token using the POST method at the endpoint https://api.<env>.cloud.talend.com/security/oauth/token. For more information about generating a token, see Generating a service account token.