> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# KafkaConnect Hybrid Runner | Collate Messaging Pipeline Connector

> Configure Kafka Connect for metadata ingestion from real-time event streams, schema updates, and topic usage using the Hybrid Runner. Deploy the ingestion agent in your environment for secure, private network metadata extraction.

![KafkaConnect](https://docs.getcollate.io/public/images/connectors/kafka.webp)

# KafkaConnect

PROD

This section provides guides and references to use the KafkaConnect connector.
Configure and schedule KafkaConnect metadata workflows from the Collate UI:

* [Requirements](#requirements)
  * [KafkaConnect Versions](#kafkaconnect-versions)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](https://docs.getcollate.io/connectors/pipeline/kafkaconnect/troubleshooting.md)

## Requirements

KafkaConnect must meet the following version requirement before you configure the connector.

### KafkaConnect Versions

Collate is integrated with KafkaConnect up to version [3.6.1](https://kafka.apache.org/36/documentation/#connect) and will continue to work for future KafkaConnect versions.
The ingestion framework uses the [kafka-connect-py](https://libraries.io/pypi/kafka-connect-py) client to connect to the KafkaConnect instance and perform the API calls

## Metadata Ingestion

To ingest metadata from KafkaConnect, you need to create a service connection. The service connects KafkaConnect with Collate. Once you create a service, Collate automatically starts ingesting metadata.

### Step 1: Add New Service

Open the Services page and start a new service.

1. Navigate to **Settings** > **Services** and select the **Pipelines** service.

   ![Navigate to Services](https://mintcdn.com/collatedocs/uYKcw5sAfx_Tl0Ed/public/images/connectors/metadata-ingestion/classic/pipeline/visit-services.png?fit=max\&auto=format\&n=uYKcw5sAfx_Tl0Ed\&q=85\&s=20ba856a12b1bd813fa7b20d5c7c49d3)

2. Click **Add New Service**.

   ![Add New Service](https://mintcdn.com/collatedocs/uYKcw5sAfx_Tl0Ed/public/images/connectors/metadata-ingestion/classic/pipeline/add-new-service.png?fit=max\&auto=format\&n=uYKcw5sAfx_Tl0Ed\&q=85\&s=1fbd1ac2da1542712912d94657141715)

### Step 2: Select a Service and Connector

From the service type dropdown, select **Pipeline Services**, then click the **KafkaConnect** connector tile.

![Select Service](https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/select-service/kafkaconnect.png?fit=max\&auto=format\&n=tVR0kaoXvgs3p2Wx\&q=85\&s=f745c5112fd415158092eb72888f0eab)

### 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 KafkaConnect services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

![Add New Service Name](https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/service-name/kafkaconnect.png?fit=max\&auto=format\&n=bv5oe4uRjuorTJO1\&q=85\&s=8a5a62222b0d4905a9949e955ba7cb8b)

> [!NOTE]
>
> **Note**: The service name can't be changed after you set it.

### Step 4: Configure Connection Options

Specify where ingestion runs, provide your source credentials, and verify the connection.

#### Select Ingestion Runner

Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute.

![Add Name and Select Ingestion Runner](https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png?fit=max\&auto=format\&n=bv5oe4uRjuorTJO1\&q=85\&s=1249f828648614445e8a976ea1933487)

#### Enter Connection Details

Enter the connection details for KafkaConnect. The right-hand panel in the UI displays inline help for each field.

![Configure Service Connection](https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/connection-details/kafkaconnect.png?fit=max\&auto=format\&n=tVR0kaoXvgs3p2Wx\&q=85\&s=7d875144baa0e545ef9cffea35c22bc3)

* **Host and Port**: The hostname or IP address of the Kafka Connect worker with the REST API enabled, for example, `https://localhost:8083` or `https://127.0.0.1:8083` or `https://<yourkafkaconnectresthostnamehere>`.
* **Kafka Connect Config**: Collate supports username/password.
  * Basic Authentication
    * Username: Username to connect to Kafka Connect. This user should be able to send request to the Kafka Connect API and access the [Rest API](https://docs.confluent.io/platform/current/connect/references/restapi.html) GET endpoints.
    * Password: Password to connect to Kafka Connect.
* **verifySSL**: Whether SSL verification should be performed when authenticating.
* **Kafka Service Name**: The Service Name of the Ingested [Kafka](https://docs.getcollate.io/connectors/messaging/kafka.md#step-3-add-service-name-and-description) instance associated with this KafkaConnect instance.

> [!TIP]
>
> **Tip**: When using a **Hybrid Ingestion Runner**, any sensitive credential fields, such as passwords, API keys, and private keys, must reference secrets using the following format:
>
> ```
> password: secret:/my/database/password
> ```
>
> This applies **only to fields marked as secrets** in the connection form (these typically mask input and show a visibility toggle icon).
> For more information about managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/hybrid-ingestion-runner.md#manage-secrets).

#### Test Connection

1. Click **Test Connection** to verify the credentials.
2. After the test succeeds, click **Save**.

![Test Connection](https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png?fit=max\&auto=format\&n=bv5oe4uRjuorTJO1\&q=85\&s=3365cff7bb9d82c85a2ff9ab559d6f11)

### 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 rules match pipeline names using the following match types.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated values. Each value uses one of the following match types. Collate ingests only assets whose names match at least one rule. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated values. Each value uses one of the following match types. Collate skips any asset whose name matches a rule. Leave blank to exclude nothing.

Rules match asset names using one of five match types:

* **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.

> [!TIP]
>
> **Tip**: Leave the filter pattern empty to ingest all pipelines available in the source.

#### Filter Options

The Pipeline section includes the following filter options:

* **Pipeline**: Controls which pipelines (DAGs, jobs, or workflows) Collate ingests from the source.

This section provides the following controls:

* **Scan Mode**: Choose between 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.
* **Exclude system toggle**: Use this toggle to filter out system-reserved names defined by the connector for that asset type.
* **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**: In **Only specific** mode, click **+ Add** to define a rule. Added rules appear as chips. An asset is included if it matches any rule.

> [!TIP]
>
> **Tip**: If [AutoPilot](https://docs.getcollate.io/how-to-guides/admin-guide/applications/autopilot.md) is enabled, lineage between pipeline tasks and data assets is tracked automatically after the first metadata ingestion completes.

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts pipelines, tasks, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. Navigate to **Settings** > **Services** and select the **Pipelines** service.

2. Select your service and click the **Agents** tab.

3. Click **Add Agent** and select **Metadata** from the dropdown.

   ![Add Metadata Agent](https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png?fit=max\&auto=format\&n=bv5oe4uRjuorTJO1\&q=85\&s=accad7d1c4ddf209781bff851d51d464)

   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.

     ![Name this Ingestion](https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png?fit=max\&auto=format\&n=bv5oe4uRjuorTJO1\&q=85\&s=d5ec1f0f3742cadab8cd54c602c97239)

   * **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. |

     ![Agent Setup](https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-agent-setup.png?fit=max\&auto=format\&n=tVR0kaoXvgs3p2Wx\&q=85\&s=471bc2416115b020f9ff6909bb9e3d89)

   * **Filter Patterns**: Apply include or exclude rules to scope which pipelines this agent ingests. These follow the same filter options described in **Step 5**.

     ![Filter Patterns](https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-filter-pattern.png?fit=max\&auto=format\&n=tVR0kaoXvgs3p2Wx\&q=85\&s=46f6f78c05d40a88a3fe9471f0f31505)

   * **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. A description or display name that the source doesn't send never replaces an existing value. If the connector supplies custom properties, the values it sends are merged over the existing ones: properties the source sends overwrite, and properties it doesn't send are kept. 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. |

     ![Scope & Behaviour](https://mintcdn.com/collatedocs/tVR0kaoXvgs3p2Wx/public/images/ai-2.0/connectors/metadata-ingestion/Pipeline/pipeline-scope-behaviour.png?fit=max\&auto=format\&n=tVR0kaoXvgs3p2Wx\&q=85\&s=38c7ce4ce152231ee67e2d0519d2fa47)

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.

   ![Schedule Interval](https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/schedule.png?fit=max\&auto=format\&n=bv5oe4uRjuorTJO1\&q=85\&s=25cc1d78f6f2a8bd115830d034d1d8d1)

6. Click **Add** to deploy the agent.

## Displaying Lineage Information

Steps to retrieve and display the lineage information for a Kafka Connect service.

1. Ingest Kafka Messaging Service Metadata: Identify the Kafka messaging service associated with the Kafka Connect service .Ensure all connected topics are comprehensively ingested.
2. Ingest Source and Sink Database/Storage System Metadata: Identify both the source and sink database or storage systems used by the Kafka Connect service. Ingest metadata for these database or storage systems
3. Ingest Kafka Connect Service Metadata: Finally, Ingest your Kafka Connect service.
   By successfully completing these steps, the lineage information for the service will be displayed.

![Kafkaconnect Lineage](https://mintcdn.com/collatedocs/DxJcfsqCTDEukJ7U/public/images/connectors/kafkaconnect/lineage.png?fit=max\&auto=format\&n=DxJcfsqCTDEukJ7U\&q=85\&s=09e9c9bfa86d916e21bb0f0823a2cbc8)

## Supported Connectors

Currently, the following source and sink connectors for Kafka Connect are supported for lineage tracking:

* [MySQL](https://docs.getcollate.io/connectors/database/mysql.md)
* [PostgreSQL](https://docs.getcollate.io/connectors/database/postgres.md)
* [MSSQL](https://docs.getcollate.io/connectors/database/mssql.md)
* [MongoDB](https://docs.getcollate.io/connectors/database/mongodb.md)
* [Amazon S3](https://docs.getcollate.io/connectors/storage/s3.md)
  For these connectors, lineage information can be obtained provided they are configured with a source or sink and the corresponding metadata ingestion is enabled.

### Missing Lineage

If lineage information is not displayed for a Kafka Connect service, follow these steps to diagnose the issue.

1. *Kafka Service Association*: Make sure the Kafka service that the data is being ingested from is associated with this Kafka Connect service. Additionally, verify that the correct name is passed on in the Kafka Service Name field during configuration. This field helps establish the lineage between the Kafka service and the Kafka Connect flow.
2. *Source and Sink Configuration*: Verify that the Kafka Connect connector associated with the service is configured with a source and/or sink database or storage system. Connectors without a defined source or sink cannot provide lineage data.
3. *Metadata Ingestion*: Ensure that metadata for both the source and sink database/storage systems is ingested and passed to the lineage system. This typically involves configuring the relevant connectors to capture and transmit this information.

## Troubleshooting

> [card] [Kafka Connect Troubleshooting](https://docs.getcollate.io/connectors/pipeline/kafkaconnect/troubleshooting.md)
>
> Learn more about how to troubleshoot common Kafka Connect connector issues and resolve configuration or ingestion errors.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.