{icon &&
}
{name}
{stage}Feature List
{totalAvailableFeatures.map(feature =>
✓ {feature}
)}
{unavailableFeatures.map(feature =>
✕ {feature}
)}
2. Click **Add New Service**.
### Step 2: Select a Service and Connector
From the service type dropdown, select **Pipeline Services**, then click the **Prefect** connector tile.
### 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 Prefect services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.
* **Host and Port** (required): Prefect API base URL. Use `https://api.prefect.cloud` for Prefect Cloud, or your self-hosted server URL, for example `http://localhost:4200`.
* **Authentication** (required): Choose the authentication type that matches your Prefect deployment:
* **Prefect Cloud**:
* **Prefect API Key**: API key for Prefect Cloud authentication.
* **Account ID**: Found in the URL: `app.prefect.cloud/account/{accountId}`.
* **Workspace ID**: Found in the URL after `/workspaces/{workspaceId}`.
* **Prefect Server**:
* **Basic Auth String** (optional): The `PREFECT_SERVER_API_AUTH_STRING` value in `user:password` format. Leave empty if the server has no auth enabled.
* **Number of Status** (optional, default `10`, max `100`): Number of past flow run statuses to ingest per flow.
* **Verify SSL** (optional): Client SSL verification mode for the Prefect API connection. Choose from:
* **No SSL** (default): Plain HTTP connection.
* **Ignore**: Accept HTTPS without validating the certificate (not recommended outside of testing).
* **Validate**: Validate the certificate using the CA cert provided in **SSL Configuration**.
* **SSL Configuration** (optional): CA certificate (and, for mutual TLS, client certificate and key) used when **Verify SSL** is set to **Validate**.
* **Default Pipeline Filter Pattern** (optional): Regex pattern to include or exclude flows by name. Supports **includes** and **excludes** arrays.
#### Test Connection
Once the credentials have been added, click on **Test Connection** and **Save** the changes.
### Step 5: Configure Ingestion Options
In the **What to Ingest** step, use filter patterns to control which assets OpenMetadata ingests from your Prefect service. Filter patterns use regular expressions applied to flow names.
#### 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.
Rules match asset names using one of five expressions:
* **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`.
When both Include and Exclude are set, Exclude takes priority.
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.
## Related