### Step 2: Select a Service and Connector
From the service type dropdown, select **Pipeline Services**, then click the **OpenLineage** connector tile.
### Step 3: Add Service Name and Description
* Enter a unique, descriptive **Service Name**. Collate 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.
#### Enter Connection Details
Enter the connection details for OpenLineage. The right-hand panel in the UI displays inline help for each field.
* **Broker Configuration**: Choose the event broker OpenLineage events are read from: **Kafka** or **Kinesis**.
* **Kafka**: Kafka broker configuration for OpenLineage events.
* **Kafka Brokers List**: Kafka bootstrap servers URL.
* **Topic Name**: Topic from where OpenLineage events will be pulled.
* **Consumer Group** (Optional): Kafka consumer group name.
* **Initial Consumer Offsets** (Optional): Initial Kafka consumer offset. Options are `earliest` and `latest`. Defaults to `earliest`.
* **Single Pool Call Timeout** (Optional): Max allowed wait time. Defaults to `1`.
* **Broker Inactive Session Timeout** (Optional): Max allowed inactivity time. Defaults to `30`.
* **Kafka Security Protocol** (Optional): Kafka security protocol config. Options are `PLAINTEXT`, `SASL_PLAINTEXT`, `SSL`, and `SASL_SSL`. Defaults to `PLAINTEXT`.
* **SSL** (Optional): SSL configuration details, used when the security protocol requires a certificate.
* **SASL** (Optional): SASL configuration details, used when the security protocol requires SASL authentication.
* **SASL Mechanism**: SASL security mechanism. Defaults to `PLAIN`.
* **SASL Username**: The SASL authentication username.
* **SASL Password**: The SASL authentication password.
* **Kinesis**: AWS Kinesis Data Streams configuration for OpenLineage events.
* **Stream Name**: Kinesis Data Stream name.
* **Initial Consumer Offsets** (Optional): Initial Kinesis shard iterator type. Options are `TRIM_HORIZON` and `LATEST`. Defaults to `TRIM_HORIZON`.
* **Poll Interval** (Optional): Poll interval in seconds. Defaults to `1`.
* **Session Timeout** (Optional): Max inactivity timeout in seconds. Defaults to `30`.
* **AWS Credentials Configuration**: AWS credentials configuration.
* **Enable IAM Auth** (Optional): Enable AWS IAM authentication. When enabled, uses the default credential provider chain (environment variables, instance profile, and so on). Defaults to `false` for backward compatibility.
* **AWS Access Key ID** (Optional): AWS Access Key ID.
* **AWS Secret Access Key** (Optional): AWS Secret Access Key.
* **AWS Region**: AWS Region.
* **AWS Session Token** (Optional): AWS Session Token.
* **Endpoint URL** (Optional): Endpoint URL for AWS.
* **Profile Name** (Optional): The name of a profile to use with the boto session.
* **Role Arn for Assume Role** (Optional): The Amazon Resource Name (ARN) of the role to assume. Required if you're using Assume Role.
* **Role Session Name for Assume Role** (Optional): An identifier for the assumed role session. Use this to uniquely identify a session when the same role is assumed by different principals or for different reasons. Required if you're using Assume Role. Defaults to `OpenMetadataSession`.
* **Source Identity for Assume Role** (Optional): The Amazon Resource Name (ARN) of the role to assume. Optional field for Assume Role.
* **Namespace to Service Mapping** (Optional): Map OpenLineage dataset namespaces (or prefixes) to Collate database service names. Use this when multiple services of the same type exist. For example, map `mysql://cluster-a:3306` to `mysql-cluster-a`.
### Step 5: Configure Ingestion Options
In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your pipeline service. Filter patterns use regular expressions applied to pipeline names.
#### How Filter Patterns Work
* **Include**: Add one or more comma-separated regular expressions. Collate 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. Collate 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.
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 Collate 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**.
* **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 Collate. When off, Collate 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
```python theme={null}
from metadata.sdk import configure
configure(host="http://localhost:8585/api", jwt_token="