OpenMetadata/openmetadata-docs/content/connectors/dashboard/superset/index.md

title	slug
Superset	/connectors/dashboard/superset

Superset

In this section, we provide guides and references to use the Superset connector.

Configure and schedule Superset metadata and profiler workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.

Requirements

To deploy OpenMetadata, check the Deployment guides.

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

The ingestion also works with Superset 2.0.0 🎉

API Connection: To extract metadata from Superset via API, user must have at least can read on Chart & can read on Dashboard permissions.

Database Connection: To extract metadata from Superset via MySQL or Postgres database, database user must have at least SELECT priviledge on dashboards & slices tables within superset schema.

Metadata Ingestion

1. Visit the Services Page

The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.

To visit the Services page, select Services from the Settings menu.

2. Create a New Service

Click on the Add New Service button to start the Service creation.

3. Select the Service Type

Select Superset as the service type and click Next.

4. Name and Describe your Service

Provide a name and description for your service as illustrated below.

Service Name

OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other {connector} services that you might be ingesting metadata from.

5. Configure the Service Connection

In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your superset service as desired.

Once the credentials have been added, click on Test Connection and Save the changes.

Connection Options

• Host and Port: URL to the Superset instance.
• Superset Connection: Add the connection details to fetch metadata from Superset either through APIs or Database.

• Username: Specify the User to connect to Superset. It should have enough privileges to read all the metadata.
• Password: Password for Superset.
• Provider: Authentication provider for the Superset service. For basic user/password authentication, the default value db can be used. This parameter is used internally to connect to Superset's REST API.

• Username: Specify the User to connect to MySQL. It should have enough privileges to read all the metadata.
• 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.
• Connection Options (Optional): Enter the details for any additional connection options that can be sent to MySQL 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 to MySQL during the connection. These details must be added as Key-Value pairs.
  • In case you are using Single-Sign-On (SSO) for authentication, add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "sso_login_url"
  • In case you authenticate with SSO using an external browser popup, then add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "externalbrowser"

• Username: Specify the User to connect to Postgres. It should have enough privileges to read all the metadata.
• Password: Password to connect to Postgres.
• Host and Port: Enter the fully qualified hostname and port number for your Postgres deployment in the Host and Port field.
• Connection Options (Optional): Enter the details for any additional connection options that can be sent to Postgres 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 to Postgres during the connection. These details must be added as Key-Value pairs.
  • In case you are using Single-Sign-On (SSO) for authentication, add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "sso_login_url"
  • In case you authenticate with SSO using an external browser popup, then add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "externalbrowser"

6. Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions below

Metadata Ingestion Options

• Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
• Dashboard Filter Pattern (Optional): Use to dashboard filter patterns to control whether or not to include dashboard as part of metadata ingestion.
  • Include: Explicitly include dashboards by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be excluded.
  • Exclude: Explicitly exclude dashboards by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be included.
• Chart Pattern (Optional): Use to chart filter patterns to control whether or not to include charts as part of metadata ingestion.
  • Include: Explicitly include charts by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all charts with names matching one or more of the supplied regular expressions. All other charts will be excluded.
  • Exclude: Explicitly exclude charts by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all charts with names matching one or more of the supplied regular expressions. All other charts will be included.
• Database Service Name (Optional): Enter the name of Database Service which is already ingested in OpenMetadata to create lineage between dashboards and database tables.
• Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug, these logs can be viewed later in Airflow.
• Override Current Owner(toggle): Set the Override Current Owner toggle to override current owner with new owner, if that is fetched during metadata ingestion For first time of metadata ingestion, kindly make sure to keep it enabled to get the owner.

7. Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, or weekly 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.

8. View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

9. Workflow Deployment Error

If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.

You can then edit the Ingestion Pipeline and Deploy it again.

From the Connection tab, you can also Edit the Service if needed.