IMPORTANT: This documentation has been discontinued. Read the updated Monitor: Completed Executions documentation on our new documentation portal.
The Monitor menu allows you to track the pipeline completed executions and their metrics, in addition to monitoring all integrations performed in a given period. On the “Completed Executions” tab, monitoring is automatically activated from the moment a pipeline is deployed. Thus, it is possible to search for a certain pipeline using search parameters and follow its completed executions through actions, as explained in this article.
Environment selector
In the upper left corner, it’s possible to choose the desired environment on the page at any given moment. When choosing the environment, the whole page is updated bringing data about the pipelines deployed in the selected environment.
Period selector
On the center of the “Completed Executions” screen, we can update the monitoring data by selecting the desired period from the options below:
5 minutes
15 minutes
1 hour
Specific: By clicking on “Specific”, it is possible to choose a time interval between two dates and two times.
Search Fields
The “Search Field” has parameters that help the user to find a specific execution. Through them, you can specify attributes of the pipeline that you want to monitor to find its executions more accurately and quickly. They are:
Message type: This parameter filters the messages presented according to the pipeline execution status:
All: Displays all types of messages;
Response: It only displays messages of the "Response" type, which represents finished executions without interruptions;
Error: It only displays messages of the "Error" type, which represents an interrupted execution.
Pipeline name: This parameter filters pipelines by name. You must fill in the full name of a pipeline.
Version: Pipeline version that performed the execution (major or minor, e.g: 2.12);
Pipeline Key: Pipeline execution identification key;
Payload: This parameter allows you to filter information in the JSON sent on the input or output of the pipeline;
Source: Execution source, that is, the Trigger configured in the pipeline:
rest;
event;
scheduler (for all Scheduler type Triggers.);
http;
http-file;
email;
email-v2;
kafka;
rabbitmq;
jms.
Error code: Code regarding an error that occurred during the pipeline execution - the codes follow the HTTP Status Code pattern.
IMPORTANT: Some resources allow you to perform faster and more flexible searches in the pipeline execution logs. To learn more, read the "Search in the logs screen" article.
Logs History
In this section, the executions completed according to the time interval and search parameters previously defined are shown. The information for each pipeline is arranged in the report according to the following columns:
Timestamp: Date and time of the pipeline execution;
Pipeline Key: The pipeline execution identification key;
Name: The pipeline full name;
Version: Pipeline version that performed the execution (major or minor, e.g: 2.12);
Source: Execution source, that is, the Trigger configured in the pipeline:
rest;
event;
scheduler (for all Scheduler type Triggers.);
http;
http-file;
email;
email-v2;
kafka;
rabbitmq;
jms.
Time elapsed: Duration of the pipeline execution;
Message type: The pipeline execution status.
“Response” for successful execution;
“Error” for interrupted execution.
IMPORTANT: In a production environment (prod), the log history on this screen expires in 30 days; in the test environment (test), 7 days.
Actions
Execution Details (search button)
Each execution generates detailed logs, providing the Pipeline Key and the pipeline's request and response messages, in addition to the date and time these messages were generated and the size of each one.
IMPORTANT: In cases of very large payloads, the Platform presents them in a truncated way, because the size and exhibition would be too big. To learn more, read the "Search in the logs screen" article.
Logs: On this tab, it is possible to view the data of the logs of an execution individually. They are:
Date and time the step was executed in the pipeline;
Log level (info, error or warn);
The messages from each log.
It is also possible to copy a certain log through the option present in Actions.
Messages: In this tab, you can view the pipeline step by step, that is, how each component operates the payloads. However, only the first 50 pipeline steps will be shown, which are only available when the pipeline is executed in test mode.
Through the "See all logs" button, it is possible to consult all the individual logs of the pipeline execution in a dedicated section. In addition, it is important to inform that in a production environment (prod), the log history on this screen expires in 10 days; in the test environment (test), 3 days.
Re-execute pipeline (refresh button)
By clicking on this button, it is possible to re-execute the pipeline in the same way that it was executed previously, being able to even manipulate the payload used in the execution - except in cases where the payload was saved in a truncated way. In addition, this functionality has specific permission that can be disabled for users.