Dagster

PROD

Available In

Feature List

Pipelines

Pipeline Status

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.

Requirements

Dagster Versions

OpenMetadata is integrated with dagster up to version 1.0.13 and will continue to work for future dagster versions.

The ingestion framework uses dagster graphql python client to connect to the dagster instance and perform the API calls

Metadata Ingestion

1. Visit the Services Page

Click Settings in the side navigation bar and then Services.

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.

Select your Service Type and Add a New Service

2. Create a New Service

Click on Add New Service to start the Service creation.

Add a new Service from the Services page

3. Select the Service Type

Select Dagster as the Service type and click Next.

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 Dagster Services that you might be ingesting metadata from.

Note that when the name is set, it cannot be changed.

Provide a Name and description for your Service

5. Configure the Service Connection

In this step, we will configure the connection settings required for Dagster.

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 the Service connection by filling the form

Connection Details

Host: Host of the dagster eg.https://localhost:300 or https://127.0.0.1:3000 or https://<yourorghere>.dagster.cloud/prod
Token : Need pass token if connecting to dagster cloud instance
- Log in to your Dagster account.
- Click on the "Settings" link in the top navigation bar.
- Click on the "API Keys" tab.
- Click on the "Create a New API Key" button.
- Give your API key a name and click on the "Create API Key" button.
- Copy the generated API key to your clipboard and paste it in the field.

6. Test the Connection

Once the credentials have been added, click on Test Connection and Save the changes.

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 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 Ingestion Pipeline and Deploy

9. View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

View the Ingestion Pipeline from the Service Page

Lineage

OpenMetadata extracts asset-based lineage from Dagster. When your Dagster assets have dependencies on other assets, OpenMetadata creates lineage edges between the corresponding tables in your data catalog.

Prerequisites for Lineage Extraction

For OpenMetadata to extract lineage from your Dagster instance, you need:

Software-Defined Assets - Your Dagster pipelines must use Software-Defined Assets (not legacy ops/solids without assets)
Asset Dependencies - Assets must declare their upstream dependencies using the deps parameter
Matching Tables in OpenMetadata - The tables referenced by your assets must already exist in OpenMetadata (ingested from your database services)

Extracting Lineage

Lineage Will Be Extracted When:

1. Assets Use Database-Style Naming (Recommended)

If your asset keys follow the database.schema.table naming pattern, lineage extraction works automatically:

Supported key formats:

Asset Key	Interpretation
`["database", "schema", "table"]`	Full path - best for lineage
`["schema", "table"]`	Schema and table only
`["table"]`	Table name only

2. Assets Include Table Metadata in Materializations

If your assets don't use database-style keys, you can still get lineage by including table metadata when materializing:

Recognized metadata labels:

Database: database, db, database_name
Schema: schema, schema_name
Table: table, table_name

3. Assets Are Associated with Jobs

Assets must be part of a Dagster job for lineage to be associated with that pipeline:

Lineage Will NOT Be Extracted When:

1. Using Legacy Ops/Solids Without Assets

2. Assets Without Dependencies Declared

3. Assets Not Part of Any Job

Assets that exist but aren't included in any job won't appear in pipeline lineage.

4. Tables Don't Exist in OpenMetadata

The source and target tables must be ingested into OpenMetadata from your database service. Run database metadata ingestion before pipeline ingestion.

5. Asset Keys Don't Match Table Names

Specifying Database Services for Lineage

To help OpenMetadata find the correct tables, specify which database services to search in the ingestion configuration:

If not specified, OpenMetadata searches all database services (which may be slower or produce incorrect matches if table names are duplicated across services).

Best Practices for Lineage

Use 3-Part Asset Keys
Always Declare Dependencies Explicitly
Include Assets in Jobs
Add Metadata for Custom Naming
Ingest Database Metadata First
- Run your database service ingestion before Dagster ingestion
- Ensure tables exist in OpenMetadata before extracting pipeline lineage

Troubleshooting Lineage

Issue	Solution
No lineage appears	Check that assets have explicit `deps` declared
Tables not found	Ensure database metadata is ingested first
Wrong tables matched	Specify `dbServiceNames` in configuration
Assets missing from pipeline	Ensure assets are included in a job definition
Partial lineage	Check that both source and target tables exist in OpenMetadata