Adding a Looker Connection¶
Prerequisites¶
To connect to the Looker platform, the running user must have access to the required Dashboards.
Note
You can find a link to the configuration template in Zeenea Connector Downloads.
Supported Versions¶
The Looker connector is compatible with the SaaS Looker instances hosted on Google Cloud (*.cloud.looker.com).
Note
Legacy AWS-hosted Looker instances (URLs without cloud) are not supported.
Installing the Plugin¶
You can download the Looker plugin from Zeenea Connector Downloads.
For more information about how to install a plugin, see Installing and Configuring Connectors as a Plugin.
Declaring the Connection¶
Connectors are created and configured through a dedicated configuration file located in the /connections folder of the relevant scanner. The scanner frequently checks for any change and resynchronises automatically.
For more information about managing connections, see Managing Connections.
To establish a connection with Looker, fill in the following parameters in the dedicated configuration file using a JSON-Style format:
| Parameter | Expected value |
|---|---|
name | Specifies the display name for the connection. |
code | Defines the unique identifier of the connection on the Zeenea platform. Once registered on the platform, this code must not be modified or the connection will be considered as new and the old one removed from the scanner. |
connector_id | The type of connector to be used for the connection. The value must be looker and must not be modified. |
enabled | A boolean value to enable or disable the connection. The default value is true. |
catalog_code | Defines the catalog code associated with the connection ("default" when empty). |
secret_manager { | Configuration for a secret manager. This configuration works only with Scanner version 73 or later and requires a functional secret manager configured in the scanner configuration file. Where: • enabled: A boolean value to enable or disable the secret manager. The default value is true.• key: Specifies the name of the secret. |
connection { | Connection settings Where: • tenant: The tenant address. In URL address, it is the name of your server before .cloud.looker.com.• client_id: Token name obtained within the Looker account menu.• client_secret: Token secret.• timeout: (Optional) Customizable HTTP client timeout depending on Looker repository volume, in ms. The default value is 10000 (10 sec).• fetch_offset_size: (Optional) Customizable offset size for the dashboard inventory. The default value is 100. |
lineage | (Optional) A boolean value to activate the automatic lineage feature. The default value is true. |
proxy { | Proxy configuration Where: • scheme: Defines the proxy protocol (http or https).• hostname: Specifies the proxy address.• port: Sets the proxy port.• username: Provides the proxy username.• password: Provides the proxy account password. |
tls { | TLS Truststore settings Where: • path: Specifies the TLS trust store file path. This file must be provided in case TLS encryption is activated (protocol https) and when certificates of Looker servers (or/and configured proxy) are delivered by a specific authority. It must contain the certification chain.• password: Provides the password of the trust store file.• type: Defines the type of the trust store file (PKCS12 or JKS). The default value is discovered from the file extension. |
User Permissions¶
To collect metadata, the running user's permissions must allow them to access and read dashboards that need cataloging.
Data Extraction¶
To extract information from Looker, the connector will scan all Dashboards the running user has access to and transform them into Visualization objects in Zeenea. Data sources are referenced as Datasets. Fields are recreated as Field-type objects in Zeenea. For each Looker Dataset, a Data Process is created to represent the lineage with the origin Dataset.
The connector executes the following requests:
GET /api/4.0/dashboards/\{dashboard-id}/search
GET /api/4.0/connections/
GET /api/4.0/folders/\{folder-id}/ancestors
GET /api/4.0/lookml_models/\{model-name}/explores/\{dataset-name}
POST /login
Collected Metadata¶
Inventory¶
The inventory collects the list of Dashboards (along with their data sources) that the user can access.
Lineage¶
The Looker connector is able to retrieve the lineage between datasets that have been imported to the catalog. Datasets from other connections must have been previously imported to the catalog to be linked to the Looker dataset through a new Data Process object. This feature is available for the following systems and, for it to work, an additional parameter is needed in the source system connection as configured in the Looker connection configuration panel.
| Source System | Possible value of alias parameter to be set in source system configuration file |
|---|---|
| BigQuery | BigQuery project name |
Note
The connector creates a data process object for each dataset from Looker to represent the link with the source dataset (even if the source dataset is not present in the catalog).
Visualization¶
A Visualization is a Looker Dashboard.
- Name
- Source Description: Dashboard label
- Datasets: All datasets referenced in the Dashboard
-
Technical Data:
- Creation date: Creation date
- Parent space: space containing the Dashboard
- Last visualization date: Last visualization date
- Number of views by web UI: Number of views by web UI
Dataset¶
A dataset is a Data source used in a Looker Dashboard.
- Name
- Source Description: Dataset label
-
Technical Data:
- Explore name: Explore name Looker
- Schema name: Schema name as it’s described in the database called
- Model name: Model name
- Connection name: Connection name
Field¶
Dataset field. Can be used as a Dashboard report data.
- Name
- Source Description: Field label
- Type
- Can be null:
false(default) - Multivalued:
false(default) - Primary Key:
false(default) -
Technical Data:
- Field type: Is the field whether a dimension or a measure
Data Process¶
To represent the data flow from an external source, a Zeenea Data Process will be created for each Looker Dataset.
- Name:
import input/output_dataset name
Object Identifier Keys¶
An identification key is associated with each object in the catalog. In the case of a synchronized object (i.e., created via a connector), the identification key is generated by the connector.
More information about unique identification keys in this documentation: Identification Keys.
| Object | Identification Key | Description |
|---|---|---|
| Visualization | code/identifier | - code: Unique identifier of the connection noted in the configuration file - identifier: Looker technical object identifier |
| Dataset | code/dataset/identifier | - code: Unique identifier of the connection noted in the configuration file - identifier: Looker technical object identifier |
| Field | code/dataset/identifier/field name | - code: Unique identifier of the connection noted in the configuration file - identifier: Looker technical object identifier - field name |
| Data process | code/transformation/model name/dataset name | - code: Unique identifier of the connection noted in the configuration file - model name - dataset name |