Skip to content

Add Validation Error History Tracking #362

Description

@masinger

Summary

Add tracking capability for validation errors that occur during workflow execution to maintain a comprehensive history of data validation failures, helping with debugging, compliance, and understanding data quality patterns over time.

Problem

Currently, validation errors are thrown and handled immediately but are not persisted, making it impossible to:

  • Track recurring validation issues across workflow executions
  • Debug patterns of validation failures over time
  • Provide audit trails of data quality issues for compliance
  • Understand which validation constraints are frequently violated
  • Correlate validation errors with specific workflow operations or data changes
  • Monitor data quality trends across different workflow versions

Proposed Solution

Maintain a history of validation errors alongside workflow execution history. Each time a validation error occurs (during step actions, data updates, or workflow transitions), capture:

  • Details of the validation constraint that was violated
  • The invalid data value that caused the error
  • Context about when and where the validation occurred
  • Reference to the step, action, or operation that triggered validation
  • Timestamp and workflow state at the time of validation failure

Benefits

  • Enhanced Debugging: Identify patterns in validation failures to improve data quality
  • Compliance Auditing: Complete trail of data quality issues for regulatory requirements
  • Quality Monitoring: Track validation error trends across workflow executions
  • Operational Insights: Understand which validation rules are most commonly violated
  • Historical Analysis: Correlate validation issues with specific application versions or configurations
  • Proactive Improvement: Identify areas where validation rules or data handling need refinement

Use Cases

  • Financial Workflows: Track validation failures in payment processing for compliance reporting
  • Form Processing: Monitor which form fields consistently fail validation across submissions
  • Data Import Workflows: Track validation errors during bulk data processing operations
  • Configuration Workflows: Monitor validation failures in parameter configuration steps
  • Quality Assurance: Analyze validation error patterns to improve data validation rules
  • Debugging: Understand why certain workflows consistently fail validation at specific points

Requirements

  • Capture validation error details when DataValidationException occurs
  • Link validation errors to the specific step data or workflow model being validated
  • Associate validation errors with the operations that triggered validation
  • Provide APIs to query validation error history for analysis
  • Support filtering validation errors by constraint type, step, or time period
  • Include context about validation behavior settings when errors occurred
  • Maintain backward compatibility with existing validation error handling
  • Consider storage efficiency for high-frequency validation scenarios

This feature complements the step data versioning and workflow model versioning by adding validation-specific traceability, providing insight into data quality evolution alongside data changes.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions