# Log Module

* [Definition](#definition)
* [Configuring the Log Module](#configuring-the-log-module)
  * [Message configuration](#message-configuration)

### Definition <a href="#definition" id="definition"></a>

The **"Log"** tool module, standard module for use in any flow, was created to make it possible to identify what is happening in each of the operations in a flow, helping to resolve problems with systems external.

During the execution of a flow, you can get various responses from external modules and systems used in the flow. Some of these situations are handled automatically within the flow, but others require notification. The **"Log"** module fulfills this purpose, recording these situations with all the relevant information and alerting you in the desired way.

As an example, if you requested inclusion in company X, the same call could come back:

* 200 successful
* 200 with application error code (code not valid)
* 500 with server error code

Situation 2 occurs in a loop, during the insertion of hundreds of products. With the Log module, instead of interrupting the flow, the **"Log"** module records the products that got this type of error, for later analysis.

{% hint style="success" %}
This is just one example that shows the value of this module. There are many other situations in which there is an interest in recording what information is being manipulated.
{% endhint %}

### Configuring the Log Module <a href="#configuring-the-log-module" id="configuring-the-log-module"></a>

The **"Log"** module consists of a single operation (**Log events**), which allows you to select up to three log storage locations, select the information you want to include and create parameters, which will also be used in the log message.

<figure><img src="/files/Stv2SDpFAZl9FVh3stT2" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
[Find out about the Module Header here](/english/skyone-studio/integrations/flows/module-header.md).
{% endhint %}

#### Message configuration <a href="#message-configuration" id="message-configuration"></a>

In "**Message configuration"** you can select or deselect each item, such as the destination, message content, etc.

<figure><img src="/files/to1Z1C9jgwjgjtalKg7V" alt=""><figcaption><p>Configuration screen</p></figcaption></figure>

Where:

* **Target**: sends the logs to the entered location; if you don't select an option, the logs will appear in the Logger **Components** tab.
  * **Local**: stores the logs in the same repository where the module execution log messages are stored (**Logger**, **Logs** tab)
  * **Syslog**: Syslog server provided (requires additional configuration)
  * **E-mail**: e-mail address provided (requires additional configuration)
* **Message contents** (checkboxes): here you must choose among the optional information that can be displayed in the log message, and you can also choose the log level
  * **Integration ID**: unique integration identification
  * **Flow ID**: unique flow identification
  * **Execution ID**: unique identification of each flow execution
  * **Component ID**: you should drag here a parameter from the desired operation
  * **Severity**: severity level of the log that will be displayed (CRITICAL, ERROR, WARNING, DEBUG); if this option is unchecked, DEBUG will be used by default
  * **Timestamp**: date and time record of the occurrence of a certain event in the flow
    * **Date format (JSONATA)**: here you can change the date format
    * **Timezone**: the timezone field follows the "±HHMM" format, where ± is either the plus or minus sign and HHMM is the offset in hours and minutes from UTC. Positive offset is for timezones east of UTC, negative offset is for timezones west of UTC. **Example**: enter “-0300” for “GMT-3”
* **Parameter**: here you can create/delete one or more log parameters to be displayed in the message, and you can drag parameters from other modules and even use a [SMOP](/english/skyone-studio/integrations/flows/data-operations/smop-small-operations.md).

To finish configuring the module, click on "**Save**".


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.skyone.cloud/english/skyone-studio/integrations/flows/tool-modules/log-module.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.