OpenLineage | OpenMetadata Data Lineage Pipeline

• Requirements
• Metadata Ingestion
• Troubleshooting

​

Requirements

​

OpenLineage Connector Events

​

Kafka Configuration

​

Airflow OpenLineage Events (Kafka)

1. Install the appropriate provider in Airflow
2. Configure the OpenLineage provider by following Airflow’s provider structure guide
   • Use kafka transport mode as OpenLineage events are collected from the Kafka topic. Detailed configuration options can be found here

​

Spark OpenLineage Events (Kafka)

from pyspark.sql import SparkSession
from uuid import uuid4

spark = SparkSession.builder\
    .config('spark.openlineage.namespace', 'mynamespace')\
    .config('spark.openlineage.parentJobName', 'hello-world')\
    .config('spark.openlineage.parentRunId', str(uuid4()))\
    .config('spark.jars.packages', 'io.openlineage:openlineage-spark:1.7.0')\
    .config('spark.extraListeners', 'io.openlineage.spark.agent.OpenLineageSparkListener')\
    .config('spark.openlineage.transport.type', 'kafka')\
    .getOrCreate()

​

AWS Kinesis Configuration

​

Kinesis Requirements

• An AWS Kinesis Data Stream receiving OpenLineage events
• AWS credentials with permissions to read from the Kinesis stream:
  • kinesis:GetRecords
  • kinesis:GetShardIterator
  • kinesis:DescribeStream
  • kinesis:ListShards

​

Spark OpenLineage Events (Kinesis)

from pyspark.sql import SparkSession
from uuid import uuid4

spark = SparkSession.builder\
    .config('spark.openlineage.namespace', 'mynamespace')\
    .config('spark.openlineage.parentJobName', 'hello-world')\
    .config('spark.openlineage.parentRunId', str(uuid4()))\
    .config('spark.jars.packages', 'io.openlineage:openlineage-spark:1.7.0')\
    .config('spark.extraListeners', 'io.openlineage.spark.agent.OpenLineageSparkListener')\
    .config('spark.openlineage.transport.type', 'kinesis')\
    .config('spark.openlineage.transport.streamName', 'openlineage-events')\
    .config('spark.openlineage.transport.region', 'us-east-2')\
    .getOrCreate()

​

Metadata Ingestion

​

Step 1: Add New Service

1. Navigate to Settings > Services.
2. Click Add New Service.

​

Step 2: Select a Service and Connector

​

Step 3: Add Service Name and Description

• Enter a unique, descriptive Service Name. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other OpenLineage services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

Step 4: Configure Connection Options

​

Enter Connection Details

​

Test Connection

​

Step 5: Configure Ingestion Options

​

How Filter Patterns Work

• Include: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets.
• Exclude: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing.

• contains: matches any name containing the value. For example, sales matches my_sales_data and sales_2024.
• starts with: matches names beginning with the value. For example, prod_ matches prod_db and prod_schema.
• ends with: matches names ending with the value. For example, _raw matches events_raw and logs_raw.
• is exactly: matches the exact name only. For example, analytics matches only analytics.
• matches regex: matches names using a regular expression. For example, ^prod_.*_v\d+$ matches prod_events_v1.

​

Filter Options

• Scan Mode: Choose one of the following scan modes:
  • Scan all: Ingests every asset of that type the connector can access. This is the default.
  • Only specific: Enables include rules so only assets matching at least one rule are ingested.
• Always exclude: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
• Preview: Shows a real-time summary of what will be in scope based on your current rules.
• Include rules (available only in Only specific mode): Click + Add to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

​

Step 6: Create & Deploy

​

Configure Metadata Agent and Schedule Ingestion

1. Navigate to Settings > Services and select the service type.
2. Click the service you have added.
3. Select the Agents tab and click Add Agent > Metadata. For some services, the dropdown is not available and clicking Add Agent takes you directly to the agent configuration page.
4. On the Configure Ingestion page, do the following and click Next.
   • Name this Ingestion: Enter a unique recognizable name for this ingestion pipeline.
   • Agent Setup: Configure the core parameters for this agent. The following fields are available:

     Field	Default	Description
     Ownership Update Mode	replace	Set how owners from source metadata update Pipeline owners. In replace mode, resolved owners from the current source replace existing owners. In append mode, resolved owners are appended to active existing Pipeline owners.
     Db Service Names	—	List of database service names used for lineage resolution.
     Storage Service Names	—	List of storage service names used for lineage resolution.
     Messaging Service Names	—	List of messaging service names used for lineage resolution.
     Status Lookback Days	1	Number of days of pipeline run status history to ingest. Only runs within the last N days will be fetched.
     Include Lineage	On	Turn off to stop fetching lineage from pipelines.
     Mark Deleted Pipeline	On	Soft-delete pipelines in OpenMetadata when they are removed from the source. Associated entities like lineage are also deleted.
     Include UnDeployed Pipelines	On	Toggle whether un-deployed pipelines should be ingested. If set to false, only deployed pipelines will be ingested.

     
   • Filter Patterns: Apply include or exclude rules to scope which pipelines this agent ingests. These follow the same filter options described in Step 5: Configure Ingestion Options.
   • Scope & Behaviour: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     Toggle	Default	Description
     Enable Debug Log	Off	Sets the ingestion log level to DEBUG. Useful for troubleshooting.
     Override Metadata	Off	When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value.
     Override Lineage	Off	When on, existing lineage is replaced with newly extracted lineage on each run.

     
5. On the Schedule Interval page, set when the agent runs:
   • Schedule: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   • On-Demand: No automatic schedule; trigger the agent manually when needed.
   
6. Click Add to deploy the agent.

​

Providing Connection Details Programmatically via API

​

1. Preparing the Client

from metadata.sdk import configure

configure(host="http://localhost:8585/api", jwt_token="<token>")

​

2. Creating the OpenLineage Pipeline Service (Kafka)

from metadata.sdk import client
from metadata.generated.schema.api.services.createPipelineService import CreatePipelineServiceRequest
from metadata.generated.schema.entity.services.pipelineService import (
    PipelineServiceType,
    PipelineConnection,
)
from metadata.generated.schema.entity.services.connections.pipeline.openLineageConnection import (
    OpenLineageConnection,
    KafkaBrokerConfig,
    SecurityProtocol as KafkaSecurityProtocol,
    ConsumerOffsets
)
from metadata.generated.schema.security.ssl.validateSSLClientConfig import (
    ValidateSslClientConfig,
)

openlineage_service_request = CreatePipelineServiceRequest(
    name='openlineage-kafka-service',
    displayName='OpenLineage Kafka Service',
    serviceType=PipelineServiceType.OpenLineage,
    connection=PipelineConnection(
        config=OpenLineageConnection(
            brokerConfig=KafkaBrokerConfig(
                brokersUrl='broker1:9092,broker2:9092',
                topicName='openlineage-events',
                consumerGroupName='openmetadata-consumer',
                consumerOffsets=ConsumerOffsets.earliest,
                poolTimeout=3.0,
                sessionTimeout=60,
                securityProtocol=KafkaSecurityProtocol.SSL,
                # SSL config is optional and only used when securityProtocol=SSL
                sslConfig=ValidateSslClientConfig(
                    sslCertificate='/path/to/kafka/certs/Certificate.pem',
                    sslKey='/path/to/kafka/certs/Key.pem',
                    caCertificate='/path/to/kafka/certs/RootCA.pem'
                )
            )
        )
    ),
)
client().ometa.create_or_update(openlineage_service_request)

​

3. Creating the OpenLineage Pipeline Service (Kinesis)

from metadata.sdk import client
from metadata.generated.schema.api.services.createPipelineService import CreatePipelineServiceRequest
from metadata.generated.schema.entity.services.pipelineService import (
    PipelineServiceType,
    PipelineConnection,
)
from metadata.generated.schema.entity.services.connections.pipeline.openLineageConnection import (
    OpenLineageConnection,
    KinesisBrokerConfig,
    KinesisConsumerOffsets
)
from metadata.generated.schema.security.credentials.awsCredentials import AWSCredentials

openlineage_service_request = CreatePipelineServiceRequest(
    name='openlineage-kinesis-service',
    displayName='OpenLineage Kinesis Service',
    serviceType=PipelineServiceType.OpenLineage,
    connection=PipelineConnection(
        config=OpenLineageConnection(
            brokerConfig=KinesisBrokerConfig(
                streamName='openlineage-events',
                consumerOffsets=KinesisConsumerOffsets.TRIM_HORIZON,  # or LATEST
                poolTimeout=1.0,
                sessionTimeout=30,
                awsConfig=AWSCredentials(
                    awsRegion='us-east-2',
                    awsAccessKeyId='<your-access-key>',  # Optional if using IAM roles
                    awsSecretAccessKey='<your-secret-key>',  # Optional if using IAM roles
                    # awsSessionToken='<session-token>',  # Optional, for temporary credentials
                )
            )
        )
    ),
)
client().ometa.create_or_update(openlineage_service_request)

​

Related