connectors

No menu items for this category
Looker
Looker
PROD
Available In
Feature List
Dashboards
Charts
Owners
Datamodels
Lineage
Tags
Projects

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

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

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. If you want to install it manually in an already existing Airflow host, you can follow this guide.

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 run the Ingestion Framework in any orchestrator externally.

There are two types of metadata we ingest from Looker:

  • Dashboards & Charts
  • LookML Models

For the project metadata being ingested:

  • We get the actual LookML Project an Explore or View is developed in.
  • For Dashboards, we use the folder name from the UI, since there is no other hierarchy involved there.

In terms of permissions, we need a user with access to the Dashboards and LookML Explores that we want to ingest. You can create your API credentials following these docs.

However, LookML Views are not present in the Looker SDK. Instead, we need to extract that information directly from the GitHub repository holding the source .lkml files. In order to get this metadata, we will require a GitHub token with read only access to the repository. You can follow these steps from the GitHub documentation.

The GitHub credentials are completely optional. Just note that without them, we won't be able to ingest metadata out of LookML Views, including their lineage to the source databases.

Moreover, Looker lineage only supports LookML views configured with sql_table_name and derived_table in plain SQL. We do not yet support liquid variables.

The first step is to ingest the metadata from your sources. To do that, you first need to create a Service connection first.

This Service will be the bridge between OpenMetadata and your source system.

Once a Service is created, it can be used to configure your ingestion workflows.

Visit Services Page

Select your Service Type and Add a New Service

Click on Add New Service to start the Service creation.

Create a new Service

Add a new Service from the Services page

Select Looker as the Service type and click Next.

Select Service

Select your Service from the list

Provide a name and description for your Service.

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

Note that when the name is set, it cannot be changed.

Add New Service

Provide a Name and description for your Service

In this step, we will configure the connection settings required for Looker.

Please follow the instructions below to properly configure the Service to read from your sources. You will also find helper documentation on the right-hand side panel in the UI.

Configure Service connection

Configure the Service connection by filling the form

  • Host and Port: URL to the Looker instance, e.g., https://my-company.region.looker.com.
  • Client ID: User's Client ID to authenticate to the SDK. This user should have privileges to read all the metadata in Looker.
  • Client Secret: User's Client Secret for the same ID provided.

Then, if we choose to inform the GitHub credentials to ingest LookML Views:

  • Repository Owner: The owner (user or organization) of a GitHub repository. For example, in https://github.com/open-metadata/OpenMetadata, the owner is open-metadata.
  • Repository Name: The name of a GitHub repository. For example, in https://github.com/open-metadata/OpenMetadata, the name is OpenMetadata.
  • API Token: Token to use the API. This is required for private repositories and to ensure we don't hit API limits.

Follow these steps in order to create a fine-grained personal access token.

When configuring, give repository access to Only select repositories and choose the one containing your LookML files. Then, we only need Repository Permissions as Read-only for Contents.

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

Test Connection

Test the connection and save the Service

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

Configure Metadata Ingestion

Configure Metadata Ingestion Page

  • 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 it to control whether 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 it to control whether 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.
  • Data Model Pattern (Optional): Use it to control whether to include data modes as part of metadata ingestion.
    • Include: Explicitly include data models by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all data models with names matching one or more of the supplied regular expressions. All other data models will be excluded.
    • Exclude: Explicitly exclude data models by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all data models with names matching one or more of the supplied regular expressions. All other data models 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.
  • Include Owners (toggle): Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
  • Include Tags (toggle): Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
  • Include Data Models (toggle): Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
  • Mark Deleted Dashboards (toggle): Set the 'Mark Deleted Dashboards' toggle to flag dashboards as soft-deleted if they are not present anymore in the source system.
  • Include Draft Dashboard (toogle): Set the 'Include Draft Dashboard' toggle to include draft dashboards. By default it will include draft dashboards.

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.

Schedule the Workflow

Schedule the Ingestion Pipeline and Deploy

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

View Ingestion Pipeline

View the Ingestion Pipeline from the Service Page

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.