Getting a task run log for live 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 the GET method to obtain logs of a task run from the /monitoring/executions/{runId}/logs endpoint.

As a task run log could be huge with its raw formatting, analyzing it could be time-consuming. Therefore, it is recommended to use the approach explained in the previous section for this live monitoring.

Before you begin

  • 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.

  • The user or the service account to be used must have the Author, the Viewer and the Executor permissions for the workspace to which the task to be monitored belongs.
  • You must know the ID of the task run you need to monitor.

    This ID is available on the Task execution log page, reading as Task execution ID. Or you can obtain this ID via a GET call from the /processing/executables/tasks/{taskId}/executions endpoint.

About this task

In this example, Talend API Tester is used to issue API requests. For further information about Talend API Tester, see Talend Cloud API Tester User Guide.

Procedure

  1. Open Talend API Tester in your browser and select GET from the Method list.
  2. In the field next to the Method drop-down list, enter the endpoint to be used: https://api.<env>.cloud.talend.com/monitoring/executions/<runId>/logs

    Example

  3. In the HEADERS area, click Add header and in the name field that is displayed, enter Authorization and in the value field, enterBearer and your personal access token or service account access token. Enter a whitespace to separate Bearer and the token.
  4. Click Send to issue your request.
  5. Click the Save button to save this request in your repository on Talend API Tester.

Results

You can then integrate this API call in your own monitoring system to continuously get and analyze the latest information of this run, so that your monitoring system can send notifications accordingly and timely.

The following example presents an entry in the logs:
{"logTimestamp":1619614861123,"isoDate":"2021-04-28 13:01:01.123","severity":"INFO","logType":null,"logMessage":"messageA1","bundleName":null,"bundleVersion":null}
Note that the isoDate field appears only in the logs of the tasks running on a engine v2.11.11 and onwards.