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

# Snowplow Hybrid Runner | Collate Pipeline Metadata

> Configure and schedule Snowplow metadata ingestion to track pipelines, lineage, and statuses. Supports BDP and Community deployments with flexible setup.

export const MetadataIngestionUi = ({connector, selectServicePath, addNewServicePath, serviceConnectionPath}) => {
  return <>
   <p>
      To ingest metadata from your sources, you need to create a service connection.
      The service connects your source system with Collate. Once you create
      a service, you can use it to configure your ingestion workflows.<br />
      <br />
      To create a service connection and ingest your metadata, follow the steps below:
  </p>
  <Steps>
    <Step title="Select the Service">
    <ol>
          <li>
            On the left navigation bar, click <strong>Settings</strong>.
          </li>
          <li>
            On the next page, click <strong>Services</strong>, and then select the service.
            <img src="/public/images/connectors/visit-services-page.png" alt="Visit Services Page" />
          </li>
    </ol>
   </Step>


   <Step title="Create a New Service">

       To add a new service connection, click <strong>Add New Service</strong>.
      <img src="/public/images/connectors/create-new-service.png" alt="Create a new Service" />


   </Step>


     <Step title="Select the Connector">
       Select <strong>{connector}</strong> as the service type and click <strong>Next</strong>.


       {selectServicePath && <img src={selectServicePath} alt="Select Service" />}
   </Step>


   <Step title="Name and Describe your Service">
       Enter a unique, descriptive <strong>Service Name</strong> and <strong>Description</strong>.
       <ul>
         <li><strong>Service Name</strong>: Collate identifies services by their service name. Enter a name that distinguishes this deployment from other services, including other {connector} services you are ingesting metadata from.</li>
       </ul>


       <Note>
           The service name cannot be changed after it is set.
       </Note>


       {addNewServicePath && <img src={addNewServicePath} alt="Add New Service" />}
   </Step>


   <Step title="Configure the Service Connection">
       Set up the connection settings required for {connector}. <br /><br />

       Configure the following connection options to set up the service and start ingesting metadata from your sources. The right-hand panel displays help documentation for the selected connection type in the product UI

       {serviceConnectionPath && <img src={serviceConnectionPath} alt="Configure Service connection" />}
   </Step>
   </Steps>
   </>;
};

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/snowplow.png" name="Snowplow" stage="BETA" availableFeatures={["Pipelines", "Pipeline Status", "Lineage"]} unavailableFeatures={["Tags", "Owners"]} />

In this section, we provide guides and references to use the Snowplow connector.
Configure and schedule Snowplow metadata workflow from the Collate UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
  * [Connection Details](#connection-details)
* [Troubleshooting](/connectors/pipeline/snowplow/troubleshooting)

## Requirements

The Snowplow connector supports two deployment types:

### BDP (Business Data Platform) Deployment

For Snowplow BDP managed deployments, you need:

* Access to the Snowplow Console
* An API Key with read permissions for accessing pipeline configurations
* Your Organization ID from the Snowplow Console

### Community Deployment

For self-hosted Snowplow Community deployments, you need:

* Access to your Snowplow pipeline configuration files
* Read permissions on the configuration directory
* The file system path to your configuration files

## Metadata Ingestion

<MetadataIngestionUi connector={"Snowplow"} selectServicePath={"/public/images/connectors/snowplow/select-service.png"} addNewServicePath={"/public/images/connectors/snowplow/add-new-service.png"} serviceConnectionPath={"/public/images/connectors/snowplow/service-connection.png"} />

## Connection Details

<Steps>
  <Step title="Connection Details">
    * **Deployment Type**: Select your Snowplow deployment type:
      * **BDP**: For Snowplow's managed Business Data Platform
      * **Community**: For self-hosted Snowplow deployments
        The required configuration fields will change based on your deployment type selection.

    ### BDP Deployment Configuration

    For BDP deployments, provide the following:

    * **Console URL**: The base URL of your Snowplow Console where you access the UI (e.g., `https://console.snowplow.io`)
    * **API Key**: Your Snowplow Console API Key with appropriate read permissions. To generate an API key:
      1. Log into your Snowplow Console
      2. Navigate to Account Settings
      3. Select the API Keys section
      4. Create a new API key with read permissions for pipeline configurations
    * **Organization ID**: Your unique Snowplow BDP Organization ID. You can find this in:
      * Snowplow Console Account Settings
      * The URL when accessing your console (e.g., `https://console.snowplow.io/organizations/{org-id}`)

    ### Community Deployment Configuration

    For Community deployments, provide:

    * **Configuration Path**: The file system path to your Snowplow pipeline configuration files. This should point to the directory containing your Snowplow configuration files such as:

      * Collector configurations
      * Enrichment configurations
      * Storage loader configurations
      * Pipeline orchestration files

      Example: `/opt/snowplow/configs`

    > **Important:**
    > If you are using the **Configuration Path** option for Community deployments, you must run the ingestion workflow through the **CLI** instead of the UI. This is because the ingestion process needs direct access to your local filesystem, which is not available when running ingestion jobs from the UI or server.

    ### Additional Configuration

    * **Cloud Provider**: Select the cloud provider where your Snowplow infrastructure is deployed:

      * **AWS**: Amazon Web Services (default)
      * **GCP**: Google Cloud Platform
      * **Azure**: Microsoft Azure

      This information helps optimize metadata extraction based on cloud-specific configurations.
    * **Pipeline Filter Pattern**: Optionally provide a regular expression pattern to exclude certain pipelines from ingestion. Examples:

      * Exclude test pipelines: `.*test.*`
      * Exclude development pipelines: `^dev-.*`
      * Exclude multiple patterns: `(.*test.*|.*dev.*|.*staging.*)`

      Leave empty to ingest all available pipelines.
  </Step>

  <Step title="Test the Connection">
    Once the credentials have been added, click on *Test Connection* and *Save* the changes.

    <img src="https://mintcdn.com/collatedocs/L7psA65ao88vmcRI/public/images/connectors/test-connection.png?fit=max&auto=format&n=L7psA65ao88vmcRI&q=85&s=2133f0d65f18df1e57f69d2cc3bdeff4" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />
  </Step>

  <Step title="Configure Metadata Ingestion">
    In this step we will configure the metadata ingestion pipeline,
    Please follow the instructions below

    <img src="https://mintcdn.com/collatedocs/12mtkhFtvTP7FUxZ/public/images/connectors/configure-metadata-ingestion-pipeline.png?fit=max&auto=format&n=12mtkhFtvTP7FUxZ&q=85&s=b310e691eaec850bc9eda3ed0b8a340f" alt="Configure Metadata Ingestion" width="1508" height="1614" data-path="public/images/connectors/configure-metadata-ingestion-pipeline.png" />

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

  <Step title="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.

    <img src="https://mintcdn.com/collatedocs/piJyXg9wW6Ik1lg-/public/images/connectors/schedule.png?fit=max&auto=format&n=piJyXg9wW6Ik1lg-&q=85&s=f1add591824b44456f0e2ff259a21c6f" alt="Schedule the Workflow" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />
  </Step>

  <Step title="View the Ingestion Pipeline">
    Once the workflow has been successfully deployed, you can view the
    Ingestion Pipeline running from the Service Page.

    <img src="https://mintcdn.com/collatedocs/cOe_QuHYxAbkMtTI/public/images/connectors/view-ingestion-pipeline.png?fit=max&auto=format&n=cOe_QuHYxAbkMtTI&q=85&s=8c754af74f99ee70e714f6f707b827e4" alt="View Ingestion Pipeline" width="2733" height="1271" data-path="public/images/connectors/view-ingestion-pipeline.png" />

    <Tip>
      If [AutoPilot](/how-to-guides/admin-guide/applications/autopilot) is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.
    </Tip>
  </Step>
</Steps>

<Tip>
  When using a **Hybrid Ingestion Runner**, any sensitive credential fields—such as passwords, API keys, or 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 a complete guide on managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](https://docs.getcollate.io/getting-started/day-1/hybrid-saas/hybrid-ingestion-runner#3.-manage-secrets-securely).
</Tip>

## Troubleshooting

<Columns cols={2}>
  <Card title="Snowplow Troubleshooting" href="/connectors/pipeline/snowplow/troubleshooting">
    Learn more about how to troubleshoot common Snowplow connector issues and resolve configuration or ingestion errors.
  </Card>
</Columns>