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

# Stitch Hybrid Runner | Official Documentation

> Ingest Stitch pipeline metadata to track transformation flow and manage operational lineage.

![Stitch](https://docs.getcollate.io/public/images/connectors/stitch.png)

# Stitch

PROD

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

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

## Requirements

To extract metadata from Stitch, you first need to create API credentials:

* `Token`: Token to access Stitch metadata.

## Metadata Ingestion

To ingest metadata from Stitch, you need to create a service connection. The service connects Stitch 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 **Stitch** connector tile.

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

### 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 Stitch 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/stitch.png?fit=max\&auto=format\&n=bv5oe4uRjuorTJO1\&q=85\&s=6010f6bfbb97c20e0d00cf263b735631)

> [!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 Stitch. 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/stitch.png?fit=max\&auto=format\&n=tVR0kaoXvgs3p2Wx\&q=85\&s=8459d59ff576ad1a1857291693293f56)

* **hostPort**: This parameter specifies the network location where your Stitch instance is accessible, combining both the hostname and port. It is based on the account and region where you have hosted your data pipelines. Refer to your Stitch account's Import API settings for the correct base URL.
* **token**: Token to get access to Stitch metadata. You create this token after logging into the Stitch console. For more information, see the [Stitch API credentials guide](https://www.stitchdata.com/docs/developers/import-api/guides/quick-start#obtain-api-credentials).

> [!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.

## Troubleshooting

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


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