Skip to main content
?

Log

A log in API AutoFlow is a chronological record that captures events, actions, or messages generated by a API AutoFlow (system), or it’s components. It serves as a valuable tool for monitoring, troubleshooting, and auditing purposes.

Logs can contain various types of information, such as:

  1. System Events: Logs can record important system events, including system startups and shutdowns, failures, and error messages.
  2. Application Events: Application logs capture events specific to a particular process from the configuration, such as errors, warnings, informational messages, user actions, and other relevant activities.
  3. Security Events: Security logs track security-related events, such as login attempts, access control violations, system breaches, and suspicious activities, which help in detecting and investigating security incidents.
  4. Performance Metrics: Performance monitoring, providing metrics related to resource usage, response times, transaction logs, and other performance indicators. These logs are crucial for identifying performance bottlenecks and optimizing system performance.
  5. Audit Trails: Audit logs maintain a record of activities and changes made within a system, including user actions, configuration modifications, file access, database transactions, and administrative activities. Audit logs are often used for compliance purposes and to investigate potential policy violations.

Where are the logs stored?​

Logs are stored in text-based files in the /interactor/data/logs folder.

By default, there are two files. Each log entry includes relevant information such as timestamps, event descriptions, error codes, source identifiers, and other contextual details.

  • user.log: Store the user generated logs
  • usage.log: Stores the usage

How to access the logs?​

Log management and analysis tools are commonly used to parse, aggregate, search, and visualize log data. They enable administrators and developers identify issues, track system behavior, troubleshoot problems, and improve system performance and security.

API AutoFlow provides a flexible way to access the logs

Download Logs​

Download Logs

From the right panel, press the Download Logs button to download the logs

Access the file​

Access the file directly from the logs folder

Access File

Use File Action for automation​

File Action Automation

Create a workflow to extract logs using file/read action.

WARNING: It is important to note that logs can consume a significant amount of disk space. Therefore, log rotation and retention policies are often implemented to manage the storage and archive of logs over time.

What does the log capture?​

Logs capture the beginning and end data of an action. For instance, when a log is enabled for an action, both the input data and the resulting data will be recorded.

Capturing the logs​

There are several ways logs can be captured.

Server Log​

Server Log
Server logs can be enabled from the server page list view kebab button.

Service Log​

Service Log
Service logs can be enabled from the service page list view kebab button.

Operation Log​

Operation Log

Operation logs can be enabled from the server or service details page list view kebab button.

Action Log​

Action Log

Action logs can be enabled from the actions’s information modal.

System/Log Action​

The log action can be placed anywhere in the workflow to capture the data at that moment of the data flow.

System Log Action
- **Label**: Puts a label on the log. In the below example, the label is `Test` - **Level**: Log level setting. **IMPORTANT**: The minimum log level is set in the "Setting" section. For example, if the minimum log level is set to `info`, any log actions with a level of `debug` or lower won't be logged. - **Value**: Data that’s being logged

Log Levels​

Log Levels
There are four log level. Log levels can be used as severity based filters.
  • debug
  • info
  • warning
  • error