BrainGrid Controller
Workflow Builder
Events
Workflow Logger Event

Workflow Logger Event Configuration

The Workflow Logger Event enables workflows to record key activities, errors, or events to support monitoring, debugging, and auditing needs. This feature ensures visibility into workflow processes, helps maintain audit trails, and aids in diagnosing issues.

Overview

The Workflow Logger is designed to capture critical workflow actions, changes, or errors in real-time. Administrators can configure logging levels, customize the log format, and review entries to improve workflow performance, troubleshoot issues, and ensure security compliance.

Usage: This event type is used to log actions and events within workflows, such as:

  • Audit Trails: Capture user actions to maintain an audit trail.
  • Error Tracking: Log error occurrences for debugging.
  • Performance Monitoring: Track workflow performance metrics.
  • Access and Security: Monitor access-related actions and security-relevant events.

Configuring a Workflow Logger Event

Step 1: Select Logging Level

Choose the type of information to log. The logging level determines the detail and type of entries recorded. Options include:

  • Info: General information about workflow activities.
  • Error: Records error occurrences to support debugging.
  • Access: Logs access-related actions for security and compliance.
  • Security: Captures security-relevant events to monitor potential risks.
  • Performance: Tracks workflow performance metrics to help optimize processes.

Step 2: Define Log Format

  1. Log Format: Choose JSON format to structure logs for easier reading and analysis. The JSON format enables standardized, structured logs that can be parsed programmatically if needed.

Step 3: Configure Logging Details

  1. Message: Enter a descriptive message to provide context for the log entry.
  2. Additional Details: Specify any additional information, like workflow ID or user ID, to add context to each log entry.
  3. Conditions: Define any conditions or filters for when this log should trigger, ensuring that only relevant activities or errors are logged.

Example Log Entry in JSON Format

Below is an example JSON log entry that captures an error in a workflow, including relevant context information:

{
  "timestamp": "2024-11-11T12:00:00Z",
  "level": "Error",
  "workflow_id": "12345",
  "message": "Failed to complete data processing step",
  "user_id": "98765",
  "error_code": "PROCESS_ERR_01",
  "details": {
    "step": "Data Processing",
    "action": "Calculate Totals",
    "reason": "Missing required fields for reason: @ReasonForLog"
  }
}

Step 4: Validate and Test

  • Action: Run the Workflow Logger event to verify that it captures entries as expected.
  • Verification: Confirm that the log entries contain accurate information and match the specified format.

Step 5: Deploy the Logger

  • Deploy: Enable the Workflow Logger event in the workflow to start capturing logs.
  • Review Entries: Regularly review log entries to monitor for any issues, security incidents, or performance bottlenecks.

Summary

The Workflow Logger Event is essential for maintaining robust audit trails, supporting workflow performance analysis, and ensuring security and compliance. By configuring detailed logs and customizing their format, administrators can track important workflow actions, troubleshoot issues, and enhance operational visibility.

JSON Contract EventCreate a User Event