correlator-ge 0.0.1

Great Expectations plugin that emits OpenLineage events for automated incident correlation

🔗 correlator-ge

Connect Great Expectations validations to incident correlation

---

What It Does

Links Great Expectations validation results to data pipeline incidents:

• Connects validation failures to upstream job runs that caused data issues
• Provides navigation from data quality alerts to root cause
• Integrates with your existing OpenLineage infrastructure
• Works alongside your current GE checkpoint workflows

---

Quick Start

# Install
pip install correlator-ge

# Configure endpoint
export CORRELATOR_ENDPOINT=http://localhost:8080/api/v1/lineage/events

# Add to your GE checkpoint (great_expectations.yml)
# See Configuration section for details

Your validation results are now being correlated with data lineage.

---

How It Works

correlator-ge hooks into Great Expectations checkpoint execution and emits OpenLineage events:

1. START - Emits validation start event when checkpoint begins
2. Validate - GE runs your expectation suites
3. Parse - Extracts validation results and data quality metrics
4. Emit - Sends events with DataQualityAssertions facets
5. COMPLETE/FAIL - Emits completion event based on validation outcome

See Architecture for technical details.

---

Why It Matters

The Problem: When data quality checks fail, teams need to trace back through pipeline runs and lineage graphs to find what upstream job introduced the bad data.

What You Get: correlator-ge automatically connects your validation failures to their upstream causes, making it easier to identify which job run introduced the data quality issue.

Key Benefits:

• Faster triage: Validation failures linked to upstream job runs
• Context in one place: Data quality results correlated with lineage
• Standard integration: Uses OpenLineage DataQualityAssertions facets
• Non-invasive setup: Adds to existing checkpoint configuration

Built on Standards: Uses OpenLineage, the industry standard for data lineage. No vendor lock-in, no proprietary formats.

---

Versioning

This package follows Semantic Versioning with the following guidelines:

• 0.x.y versions (e.g., 0.1.0, 0.2.0) indicate initial development phase:

  • The API is not yet stable and may change between minor versions
  • Features may be added, modified, or removed without major version changes
  • Not recommended for production-critical systems without pinned versions

• 1.0.0 and above will indicate a stable API with semantic versioning guarantees:

  • MAJOR version for incompatible API changes
  • MINOR version for backwards-compatible functionality additions
  • PATCH version for backwards-compatible bug fixes

The current version is in early development stage, so expect possible API changes until the 1.0.0 release.

---

Documentation

For detailed usage, configuration, and development:

• Configuration: docs/CONFIGURATION.md - Checkpoint setup, environment variables
• Architecture: docs/ARCHITECTURE.md - Internal design, OpenLineage events
• Development: docs/DEVELOPMENT.md - Development setup, testing
• Contributing: docs/CONTRIBUTING.md - Contribution guidelines
• Deployment: docs/DEPLOYMENT.md - Release process, PyPI publishing

---

Requirements

• Python 3.9+
• Great Expectations 1.0+
• Correlator

---

Current Status

This is a skeleton release for CI pipeline testing and PyPI name reservation. Core functionality will be implemented after research into Great Expectations checkpoint action interfaces is complete.

---

Links

• Correlator: https://github.com/correlator-io/correlator
• OpenLineage: https://openlineage.io/
• Great Expectations: https://greatexpectations.io/
• Issues: https://github.com/correlator-io/correlator-ge/issues
• Discussions: https://github.com/correlator-io/correlator/discussions

---

License

Apache 2.0 - See LICENSE for details.