> ## 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. # Superset Hybrid Runner > Learn how to connect Apache Superset dashboards to Collate using the Hybrid Runner. Deploy the ingestion agent in your environment for secure, private network metadata extraction. 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
{icon &&
{name}
}

{name}

{stage}
{showSubHeading &&
Feature List
{totalAvailableFeatures.map(feature =>
✓ {feature}
)} {unavailableFeatures.map(feature =>
✕ {feature}
)}
}
; }; This section provides guides and references to use the Superset connector. Configure and schedule Superset metadata and profiler workflows from the Collate UI: * [Requirements](#requirements) * [Metadata Ingestion](#metadata-ingestion) * [Enable Security](#securing-superset-connection-with-ssl-in-collate) * [Lineage](#lineage) * [Troubleshooting](/ai-2-0/connectors/dashboard/superset/troubleshooting) ## Requirements The ingestion also works with Superset 2.0.0. **API Connection**: To extract metadata from Superset via API, the user must have at least `can read on Chart` and `can read on Dashboard` permissions. **Database Connection**: To extract metadata from Superset via MySQL or Postgres database, the database user must have at least `SELECT` privilege on the `dashboards` and `slices` tables within the Superset schema. ## Metadata Ingestion To ingest metadata from Superset, you need to create a service connection. The service connects Superset with Collate. Once you create a service, Collate automatically starts ingesting metadata. ### Step 1: Add New Service 1. In the left navigation, click **Connections**. 2. On the **Connections** page, click **Add New Service**. Add New Service ### Step 2: Select a Service and Connector From the service type dropdown, select **Dashboard Services**, then click the **Superset** connector tile. Select Service ### 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 Superset services you are ingesting metadata from. * Optional: Enter a **Description** for the service. Add New Service Name **Note**: The service name cannot be changed after it is set. ### 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 #### Enter Connection Details Enter the connection details for Superset. The right-hand panel in the UI displays inline help for each field. Configure Service Connection * **Host and Port**: The `Host and Port` parameter is common to all three authentication modes and specifies the host and port of the Superset instance. This should be specified as a string in the format `http://hostname:port` or `https://hostname:port`. For example, you might set the hostPort parameter to `https://org.superset.com:8088`. * **Superset Connection**: Add the connection details to fetch metadata from Superset either through APIs or a database. ##### For Superset API Connection Superset API connection is the default authentication mode. It fetches metadata using the [Superset APIs](https://superset.apache.org/docs/api/). **Tip**: Superset only supports basic or LDAP authentication through APIs. If you have SSO enabled on your Superset instance, this authentication mode won't work. Use a MySQL or Postgres connection instead to fetch metadata directly from the Superset database. * **Username**: Username to connect to Superset, for ex. `user@organization.com`. This user should have access to relevant dashboards and charts in Superset to fetch the metadata. * **Password**: Password of the user account to connect with Superset. * **Provider**: Choose between `db`(default) or `ldap` mode of Authentication provider for the Superset service. This parameter is used internally to connect to Superset's REST API. * **Verify SSL**: Client SSL verification. Make sure to configure the SSLConfig if enabled. Possible values: * `validate`: Validate the certificate using the public certificate (recommended). * `ignore`: Ignore the certification validation (not recommended for production). * `no-ssl`: SSL validation is not needed. * **SSL Config**: Client SSL configuration in case you are connecting to a host with SSL enabled. * **Certificate Path**: CA certificate path in the instance where the ingestion run. E.g., `/path/to/public.cert`. Will be used if Verify SSL is set to `validate`. ##### For MySQL Connection Use a MySQL connection when you have SSO enabled and your Superset instance is backed by a MySQL database. * **Username**: Specify the user to connect to MySQL. It should have enough privileges to read all the metadata. Make sure the user has select privileges on the `dashboards`, `tables`, and `slices` tables of the Superset schema. * **Password**: Password to connect to MySQL. * **Host and Port**: Enter the fully qualified hostname and port number for your MySQL deployment in the Host and Port field. * **databaseSchema**: Enter the database schema which is associated with the Superset instance. * **caCertificate**: Provide the path to ssl ca file. * **sslCertificate**: Provide the path to ssl client certificate file (ssl\_cert). * **sslKey**: Provide the path to ssl client certificate file (ssl\_key). #### Advanced Configuration Database Services include an Advanced Configuration section for passing extra arguments to the connector and, if needed, changing the connection scheme. This is only needed for advanced connectivity scenarios or customizations. * **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to database during the connection. These details must be added as Key-Value pairs. * **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as Key-Value pairs. **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 more information about managing secrets in hybrid setups, see the [Hybrid Ingestion Runner Secret Management Guide](/ai-2-0/getting-started/lets-get-started/ingest-your-data/hybrid-ingestion-runner#manage-secrets) #### Test Connection Once the credentials have been added, click on **Test Connection** and **Save** the changes. Test Connection ### Step 5: Configure Ingestion Options In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your dashboard service. Filter patterns use regular expressions applied to asset 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. **Tip**: Leave all filter patterns empty to ingest all dashboards, charts, and data models available in the source. **Filter Options** The Dashboard, Chart, and Data Model sections each include the following filter options: * **Dashboard**: Controls which dashboards Collate ingests from the source. * **Chart**: Controls which charts within the ingested dashboards are included. * **Data Model**: Controls which data models are included in metadata ingestion. Each section provides the following controls: * **Scan Mode**: You can 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 automatically filter out system-reserved names defined by the connector—for example, **Exclude system databases** for the Databases section. * **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** *(available only 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**: If [AutoPilot](/ai-2-0/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start 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 **Connections** in the left navigation and select your service. ## Configure Metadata Agent and Schedule Ingestion The **Metadata Agent** extracts dashboards, charts, data models, 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. In the left navigation, click **Connections** and select your service. 2. Click the **Agents** tab. 3. Click **Add Agent** and select **Metadata** from the dropdown. Add Metadata Agent 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 * **Agent Setup**: Configure ingestion parameters. The following fields are available: | Field | Default | Description | | ------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Db Service Prefixes | — | List of database service name prefixes used to resolve lineage between dashboards and database assets. Accepted formats: `DBService`, `DBService.Database`, `DBService.Database.Schema`, `DBService.Database.Schema.Table`. | | Query Parser Type | Auto | Select the SQL parser used for lineage extraction from dashboard queries. **Auto** selects the best available parser automatically. **SqlGlot** is a high-performance parser with excellent dialect support; falls back to SqlParse on failure. **SqlFluff** is a comprehensive parser with strong dialect support; falls back to SqlParse on failure. | | Mark Deleted Dashboards | On | Soft-delete dashboards in Collate when they are removed from the source. Associated lineage is also deleted. | | Mark Deleted Data Models | On | Soft-delete data models in Collate when they are removed from the source. Associated lineage is also deleted. | | Mark Deleted Charts | On | Soft-delete charts in Collate when they are removed from the source. | | Include Data Models | On | Ingest data model metadata. | | Include Draft Dashboards | On | Ingest dashboards that are in draft state. | | Include Usage | On | Collect and ingest usage statistics for dashboards. | Agent Setup * **Filter Patterns**: Apply include or exclude rules to scope which dashboards, charts, data models, and projects this agent ingests. These follow the same filter options described in **Step 5**. Filter Patterns * **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. | | Include Current Owners | Off | When enabled, replaces the current owner with a new owner from the source if the current owner is null. Recommended to keep enabled during the first metadata ingestion to capture owner information. | | Include Tags | On | Ingest tags from the source. | | 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. | Scope & Behaviour 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 6. Click **Add** to deploy the agent. ## Lineage Lineage in Collate shows you which database tables power each dashboard. When lineage is set up, you can trace any dashboard back to the exact source tables in your database. There is no separate lineage agent or lineage pipeline — lineage is collected as part of the same metadata ingestion workflow. To enable lineage, open the **Configure Metadata Agent** section above, scroll to the **Lineage Information** section in the agent setup, and enter one or more database service names in the **Db Service Prefixes** field. Lineage Information Configuring **Db Service Prefixes** is optional but recommended — it restricts table matching to specific database services. If left blank, Collate attempts to match source tables across all ingested database services. | What you enter | What it matches | | ------------------------------- | --------------------------------------------------------- | | `SnowflakeProd` | All tables in the Snowflake service named `SnowflakeProd` | | `SnowflakeProd.sales_db` | Tables in the `sales_db` database within `SnowflakeProd` | | `SnowflakeProd.sales_db.public` | Tables in the `public` schema within `sales_db` | **Tip**: If your dashboards pull data from multiple database services, add each service as a separate entry in the **Db Service Prefixes** field. ## Securing Superset Connection with SSL in Collate 1. To establish secure connections between Collate and Superset, navigate to the `Advanced Config` section. Update the `Certificate Path` and ensure that the certificates are accessible from the Airflow Server. Superset API SSL Configuration 2. To establish secure connections between Collate and Superset's MySQL database, configure SSL certificates appropriately. If you only require SSL validation, specify the `caCertificate` to use the CA certificate for validating the server's certificate. For mutual authentication, where both client and server need to authenticate each other, provide all three parameters: `ssl_key` for the client's private key, `ssl_cert` for the client's SSL certificate, and `ssl_ca` for the CA certificate to validate the server's certificate. MySQL SSL Configuration 3. To establish secure connections between Collate and Superset's PostgreSQL database, configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security. Under `PostgresConnection Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). PostgreSQL requires only the CA certificate for SSL validation. Postgres SSL Configuration ## Troubleshooting Learn more about how to troubleshoot common Superset connector issues and resolve configuration or ingestion errors.