Skip to content

Sessions

Jump to bottom
namu0421 edited this page Jun 30, 2025 · 2 revisions

Sessions in QIP are critical for tracking and analyzing the execution of integration workflows. They provide granular visibility into chain operations, enabling troubleshooting, auditing, and optimization. Below is a high-level overview of session functionality and configuration options:

Key Features:

Sessions in QIP provide comprehensive tools for monitoring, analyzing, and managing integration workflows. Below are the core functionalities:

  1. Flexible Logging Configuration Sessions allow detailed logging settings, including verbosity levels (Error, Warn, Info).
  2. Session Lifecycle Tracking Each session displays real-time status updates (e.g., In Progress, Completed with Errors) and metadata such as Start/Finish Time, Duration, and Snapshot Version.
  3. Data Security with Masked Fields Users can define masked fields to hide sensitive information in logs.
  4. Detailed Element-Level Diagnostics
    Sessions enable deep inspection of individual workflow elements, including Status, Duration, and Type. The View Diff feature highlights pre- and post-execution changes for each element, simplifying troubleshooting for large datasets.
  5. Session Actions
    Users can perform critical operations:
    • Retry Failed Sessions : Re-execute workflows to resolve transient errors.
    • Export Logs : Save session data for external analysis or compliance reporting.
    • Delete Records : Remove outdated or unnecessary session entries.
  6. Integration with Monitoring Systems
    Sessions support DPT Events for streaming data to external monitoring tools.

User Interface Overview

To make the system start writing sessions for a specific chain, users must configure logging parameters in the Logging Settings tab, accessible via the top navigation menu after the Sessions section. This tab is divided into two panels:

  • Left Panel: Logging Properties — defines log behavior and visibility.
  • Right Panel: Masked Fields — manages sensitive data protection.

Configuring Logging Properties

To set up logging:

  1. Enable Override default properties to set system-wide settings.
  2. Adjust the following parameters:
    • Session Level:
      • Off: No logging.
      • Error: Logs only critical failures.
      • Info: Standard operational details.
      • Debug: Detailed diagnostics for troubleshooting.
    • Log Level:
      • Error, Warn, Info — controls verbosity of logged messages.
    • Log Payload:
      • Body: Full message body content.
      • Header: Message header (e.g., HTTP headers).
      • Properties: Contextual data (e.g., session IDs).
    • Produce DPT Events: Enables event generation for external monitoring.
    • Enable Logging Masking: Activates field-level data protection.

Managing Masked Fields

To secure sensitive data:

  1. Use the action menu (right panel below) to:
    • Add New Masked Field: Enter a name. The field will be masked at every level of JSON, XML, etc., during chain execution. Masked fields affect logs and sessions by hiding the original data.
    • Delete Selected Fields: Remove outdated or unnecessary masks.
  2. Each masked field displays:
    • Created By/At : Creator and timestamp.
    • Modified By/At : Last edit details.

Session Management

Sessions are accessible via the top navigation menu after Deployments. The session list includes:

  • ID: Unique identifier for tracking.
  • Status:
    • In Progress
    • Completed Normally
    • Completed with Errors/Warnings
    • Cancelled or Unknown
  • Start/Finish Time: Execution timeline.
  • Session Level: Logged severity (e.g., Debug).
  • Duration: Total runtime.
  • Snapshot: Version used for the session.
  • Engine: Target deployment domain.

Available Actions:

  • Delete Selected Sessions: Removes session records.
  • Export Selected Sessions: Saves logs for external analysis.
  • Retry Selected Sessions: Repeats failed workflows.

Session Details and Element Inspection

Clicking on a session reveals granular insights:

  • Element-Level Data:
    • Element Name, Status, Duration, Start/Finish Time, Type (e.g., HTTP trigger, Kafka sender).
  • Content Viewing - to see the difference (Before and After):
    • Use tabs at the top to select:
      • Body: Message payload.
      • Header: Metadata.
      • Exchange Properties: Contextual variables.
      • Technical Content: Internal diagnostics.
  • View Diff : For large datasets, click View Diff (right side) to compare pre- and post-execution states.

Clone this wiki locally