forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request apache#4 from OpenLineage/readme
Adding README
- Loading branch information
Showing
4 changed files
with
33 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,32 @@ | ||
# OpenLineage | ||
# OpenLineage | ||
|
||
## Overview | ||
OpenLineage is an Open standard for metadata and lineage collection designed to instrument jobs as they are running. | ||
It defines a generic model of run, job, and dataset entities identified using consistent naming strategies. | ||
The core lineage model is extensible by defining specific facets to enrich those entities. | ||
|
||
## Problem | ||
![Problem](doc/problem.png) | ||
|
||
### Before | ||
- Duplication of effort: Each project has to instrument all jobs | ||
- Integrations are external and can break with new versions | ||
|
||
### With OpenLineage | ||
- Effort of integration is shared | ||
- Integration can be pushed in each project: no need to play catch up | ||
|
||
## Scope | ||
OpenLineage defines the metadata for running jobs and the corresponding events. | ||
A configurable backend allows to choose what protocol to send the events to. | ||
![Scope](doc/Scope.png) | ||
|
||
## Core model | ||
|
||
![Model](doc/OpenLineageModel.svg) | ||
|
||
A facet is an atomic piece of metadata attached to one of the core entities. | ||
See the spec for more details. | ||
|
||
## Spec | ||
The [specification](spec/OpenLineage.md) is defined using OpenAPI and allows extension through custom facets. |
Oops, something went wrong.