looker-health-analyze

“looker-health-analyze” provides a set of analytical commands for a Looker instance, allowing users to analyze projects, models, and explores.

About

The looker-health-analyze tool performs various analysis tasks on a Looker instance. The action parameter selects the type of analysis to perform:

  • projects: Analyzes all projects or a specified project, reporting on the number of models and view files, as well as Git connection and validation status.
  • models: Analyzes all models or a specified model, providing a count of explores, unused explores, and total query counts.
  • explores: Analyzes all explores or a specified explore, reporting on the number of joins, unused joins, fields, unused fields, and query counts. Being classified as Unused is determined by whether a field has been used as a field or filter within the past 90 days in production.

Parameters

fieldtyperequireddescription
kindstringtrueMust be “looker-health-analyze”
sourcestringtrueLooker source name
actionstringtrueThe analysis to perform: projects, models, or explores.
projectstringfalseThe name of the Looker project to analyze.
modelstringfalseThe name of the Looker model to analyze. Required for explores actions.
explorestringfalseThe name of the Looker explore to analyze. Required for the explores action.
timeframeintfalseThe timeframe in days to analyze. Defaults to 90.
min_queriesintfalseThe minimum number of queries for a model or explore to be considered used. Defaults to 1.

Example

Analyze all models in thelook project.

tools:
  analyze-tool:
    kind: looker-health-analyze
    source: looker-source
    description: |
      Analyzes Looker projects, models, and explores.
      Specify the `action` parameter to select the type of analysis.
    parameters:
      action: models
      project: "thelook"

Analyze all the explores in the `ecomm` model of `thelook` project. Specifically look at usage within the past 20 days. Usage minimum should be at least 10 queries.

```yaml
tools:
  analyze-tool:
    kind: looker-health-analyze
    source: looker-source
    description: |
      Analyzes Looker projects, models, and explores.
      Specify the `action` parameter to select the type of analysis.
    parameters:
      action: explores
      project: "thelook"
      model: "ecomm"
      timeframe: 20
      min_queries: 10