![OpenLineage](/_next/image?url=%2Fimages%2Fconnectors%2Fopenlineage.webp&w=64&q=75)
In this section, we provide guides and references to use the OpenLineage connector.
Configure and schedule OpenLineage metadata workflows from the OpenMetadata UI:
Ingestion Deployment
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If you want to install it manually in an already existing Airflow host, you can follow this guide.
If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to run the Ingestion Framework in any orchestrator externally.
Run Connectors from the OpenMetadata UI
Learn how to manage your deployment to run connectors from the UIRun the Connector Externally
Get the YAML to run the ingestion externallyExternal Schedulers
Get more information about running the Ingestion Framework ExternallyRequirements
OpenMetadata is integrated with OpenLineage up to version 1.7.0 and will continue to work for future OpenLineage versions.
OpenLineage is an open framework for data lineage collection and analysis. At its core is an extensible specification that systems can use to interoperate with lineage metadata.
Apart from being a specification, it is also a set of integrations collecting lineage from various systems such as Apache Airflow and Spark.
Openlineage connector events
OpenLineage connector consumes open lineage events from kafka broker and translates it to OpenMetadata Lineage information.
To Configure your Airflow instance
1. To Configure your Airflow instance install appropriate provider in Airflow 2. Configure OpenLineage Provider in Airflow - Remember to use kafka
transport mode here as OL events are collected from kafka topic. Detailed list of configuration options for OpenLineage can be found here
Spark OpenLineage events
Configure Spark Session to produce OpenLineage events compatible with OpenLineage connector available in OpenMetadata. complete the kafka config using the below code.
Metadata Ingestion
1. Visit the Services Page
The first step is to ingest the metadata from your sources. To do that, you first need to create a Service connection first.
This Service will be the bridge between OpenMetadata and your source system.
Once a Service is created, it can be used to configure your ingestion workflows.
![Visit Services Page](/images/v1.5/connectors/visit-services-page.png)
Select your Service Type and Add a New Service
![Create a new Service](/images/v1.5/connectors/create-new-service.png)
Add a new Service from the Services page
![Select Service](/images/v1.3/connectors/openlineage/select-service.webp)
Select your Service from the list
4. Name and Describe your Service
Provide a name and description for your Service.
Service Name
OpenMetadata uniquely identifies Services by their Service Name. Provide a name that distinguishes your deployment from other Services, including the other Openlineage Services that you might be ingesting metadata from.
Note that when the name is set, it cannot be changed.
![Add New Service](/images/v1.3/connectors/openlineage/add-new-service.webp)
Provide a Name and description for your Service
5. Configure the Service Connection
In this step, we will configure the connection settings required for Openlineage.
Please follow the instructions below to properly configure the Service to read from your sources. You will also find helper documentation on the right-hand side panel in the UI.
![Configure Service connection](/images/v1.3/connectors/openlineage/service-connection.webp)
Configure the Service connection by filling the form
6. Test the Connection
Once the credentials have been added, click on Test Connection and Save the changes.
![Test Connection](/images/v1.5/connectors/test-connection.png)
Test the connection and save the Service
7. Configure Metadata Ingestion
In this step we will configure the metadata ingestion pipeline, Please follow the instructions below
![Configure Metadata Ingestion](/images/v1.5/connectors/configure-metadata-ingestion-pipeline.png)
Configure Metadata Ingestion Page
Metadata Ingestion Options
- Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
- Pipeline Filter Pattern (Optional): Use to pipeline filter patterns to control whether or not to include pipeline as part of metadata ingestion.
- Include: Explicitly include pipeline by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
- Exclude: Explicitly exclude pipeline by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be included.
- Include lineage (toggle): Set the Include lineage toggle to control whether to include lineage between pipelines and data sources as part of metadata ingestion.
- Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug.
- Mark Deleted Pipelines (toggle): Set the Mark Deleted Pipelines toggle to flag pipelines as soft-deleted if they are not present anymore in the source system.
8. Schedule the Ingestion and Deploy
Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.
Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.
If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.
After configuring the workflow, you can click on Deploy to create the pipeline.
![Schedule the Workflow](/images/v1.5/connectors/schedule.png)
Schedule the Ingestion Pipeline and Deploy
Providing connection details programmatically via API
1. Preparing the Client
2. Creating the OpenLineage Pipeline service
1. Preparing the Client
2. Creating the OpenLineage Pipeline service
1. Preparing the Client
2. Creating the OpenLineage Pipeline service
Troubleshooting
Workflow Deployment Error
If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.
- You can then Edit the Ingestion Pipeline and Deploy it again.
- From the Connection tab, you can also Edit the Service if needed.