Advanced Log File Analysis

Log File Structure

Each log entry in Autom Mate consists of several key fields:

  1. ActionId : Unique identifier for the action or process. This field helps track specific actions within a workflow.

  2. Definition : A label for the action being executed, such as FTPSFTP_CONNECT which indicates a file transfer action.

  3. Label : The Label field in Autom Mate logs reflects any custom edits made to the name of the action. If the action's default name has been modified by the user, the edited name will appear in this field. If no specific label or edit has been assigned to the action, this field may remain empty.

    Example: If an action originally named FTPSFTP_CONNECT has been renamed to FileTransferStep1 by the user, this custom name will appear in the Label field of the log entry.

  4. Level : Indicates the severity or importance of the log. Common values include:

    • INFO: Informational messages about normal operations.

    • ERROR: Errors encountered during workflow execution.

    • WARNING: Warnings that might not stop the flow but indicate potential issues.

  5. Text : Descriptive text explaining the event or action. In case of errors, this field contains details about what went wrong.

  6. Timestamp : The precise date and time the event occurred, calculated according to the Mate Agent’s time zone. This field is crucial for tracking the sequence of actions within the workflow and ensuring that the timing of events is consistent with the Mate Agent’s environment.

  7. Type : Specifies the type of log. Common types include:

    • Standard : General logging of actions or errors.

    • Advanced : Contains more detailed information about input values or specific steps.

Understanding the Log Fields

Here’s a breakdown of how to interpret each field:

  • ActionId : Each action in a workflow is assigned an ActionId. Multiple log entries with the same ActionId refer to steps or events within the same action. This is essential for following the lifecycle of a specific action.

  • Defination : This field provides insight into what the action does. For example, in this log, FTPSFTP_CONNECT refers to an FTP or SFTP connection attempt.

  • Level :

    • INFO indicates routine actions like the start of the workflow or input values being passed to the system.

    • ERROR points to problems, such as a failed connection or missing host.

  • Text : This field is crucial for troubleshooting. It provides plain-text details about what is happening at each step, including:

    • When actions start.

    • What input values are being used.

    • Descriptions of errors that occur.

  • Timestamp : The time helps pinpoint exactly when each event happened. This is particularly useful when multiple actions are logged within short timeframes.

  • Type : This field differentiates between general logs (standard) and more detailed information (advanced). For example, the advanced type often logs input values, which helps in debugging configuration or setup issues.

Detecting and Analyzing Errors

Step 1: Locate the ERROR Level Entries

Errors are indicated by the "Level": "ERROR" field in the log. These entries provide detailed error messages in the Text field, which often explain the issue and may point to configuration errors, missing resources, or connectivity problems.

Example Error:

jsonCopy code {

  "ActionId": "6abeb83b-2783-4da1-b57a-3918d32699c2",
  "Defination": "FTPSFTP_CONNECT",
  "Label": "",
  "Level": "ERROR",
  "Text": "dial tcp: lookup asdad: no such host",
  "Timestamp": "2024-07-16T18:05:48.3342404+03:00",
  "Type": "standard"
}

  • Analysis : This error occurred while attempting to connect to an FTP or SFTP server. The issue is a dial tcp error indicating that the system cannot resolve the host asdad. The likely cause is a misconfigured server name.

Step 2: Trace the ActionId

Use the ActionId to trace back the entire sequence of steps leading to the error. For example, in the log above, the action starts with the ActionId "6abeb83b-2783-4da1-b57a-3918d32699c2", and you can follow all related events by searching for this ActionId.

Step 3: Review Input Values (Advanced)

Errors often arise due to incorrect input values, which can be found in log entries marked as "Type": "advanced". These entries include all the configuration details passed into the action, making it easier to spot misconfigurations.

Example:

jsonCopy code {

  "ActionId": "6abeb83b-2783-4da1-b57a-3918d32699c2",
  "Defination": "FTPSFTP_CONNECT",
  "Label": "",
  "Level": "INFO",
  "Text": "input values =>  -serverName: asdad | -transferType: binary | -loginPass: ****** | -afterRetry: continue | -errorFlow: false | -port: 123 | -fileType: FILE | -serverType: ftp | -authenticationType: uname_pass | -loginUser: asdad |",
  "Timestamp": "2024-07-16T18:05:46.0534686+03:00",
  "Type": "advanced"
}

  • Analysis : The serverName is set to asdad, which seems incorrect and leads to the error noted later (no such host). Checking the input values can reveal setup issues or misconfigurations.

How the Log File Works

  • Sequential Logging : Each event in the workflow is logged sequentially based on its timestamp, allowing users to follow the exact flow of actions and pinpoint where an error occurred.

  • Linking Events by ActionId : Actions can involve multiple steps, each logged separately. By linking entries with the same ActionId, you can trace the entire process for that specific action.

  • Using Log Levels : Pay special attention to "Level": "ERROR" entries as they indicate failure points. "INFO" logs can provide supporting information about what the system was doing before and after the error.

Steps for Troubleshooting Using the Log

  1. Identify Errors : Start by locating any ERROR log entries. These give direct information about what went wrong.

  2. Check Input Values : Review entries with "Type": "advanced" to inspect the configuration and input values passed to the action.

  3. Trace the Action Flow : Follow the ActionId to see the complete sequence of events for the action that failed. This helps understand the context of the error.

  4. Look for Warnings : Sometimes, warnings precede errors. Although not critical, warnings can indicate potential issues that might later cause errors.

  5. Use Timestamps : Correlate timestamps across logs to understand the order of events, especially in complex workflows with multiple actions happening in close succession.

Best Practices for Reading and Understanding Autom Mate Logs

  • Focus on ActionId : Always use the ActionId to trace specific actions, as workflows can have multiple actions happening in parallel.

  • Leverage Log Levels : Filter by log level (e.g., ERROR, INFO) to prioritize what to investigate.

  • Review Input Values : Misconfigurations in input values are a common cause of errors. Advanced logs give detailed insights into these settings.

  • Look for Patterns : Consistent issues like connection failures or data format mismatches often show patterns in the logs. Regularly check the Text field for repeated problems.

  • Monitor Workflow Health : Regularly scan logs, not just for errors, but also for INFO logs to ensure that workflows are operating as expected.

The advanced log files in Autom Mate provide a comprehensive view of workflow execution, including actions taken, errors encountered, and input values used. By focusing on key fields such as ActionId, Level, and Textusers can effectively troubleshoot issues and ensure smooth operations. Logs are essential for identifying misconfigurations and understanding how workflows behave, allowing for precise debugging and optimization.

PreviousSettingsNextTime Zone Management in Autom Mate

Last updated