Skip to content

Commit

Permalink
change name to model consumption
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 committed Sep 3, 2024
1 parent 6eb12f4 commit 9eabc0f
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion website/docs/docs/collaborate/explore-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Navigate the dbt Explorer overview page to access your project's resources and m
- **Lineage graph** — Explore your project's or account's [lineage graph](#project-lineage) to visualize the relationships between resources.
- **Latest updates** — View the latest changes or issues related to your project's resources, including the most recent job runs, changed properties, lineage, and issues.
- **Marts and public models** — View the [marts](/best-practices/how-we-structure/1-guide-overview#guide-structure-overview) and [public models](/docs/collaborate/govern/model-access#access-modifiers) in your project.
- **Model query history** — Use [model query history](/docs/collaborate/model-query-history) to track the history of queries on your models for deeper insights.
- **Model query history** — Use [model query history](/docs/collaborate/model-consumption) to track the history of queries on your models for deeper insights.
- **Auto-exposures** — [Set up and view auto-exposures](/docs/collaborate/auto-exposures) to automatically expose relevant data models from Tableau to enhance visibility.

<Lightbox src="/img/docs/collaborate/dbt-explorer/explorer-main-page.gif" width="100%" title="Access dbt Explorer from dbt Cloud by clicking Explore in the navigation."/>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: "Model query history"
sidebar_label: "Model query history"
title: "Model consumption"
sidebar_label: "Model consumption"
description: "Import and auto-generate exposures from dashboards and understand how models are used in downstream tools for a richer lineage."
image: /img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg
---

# About model query history <Lifecycle status='beta' />
# About model consumption <Lifecycle status='beta' />

The model query history tile allows you to:
The model consumption tile allows you to:

- View the query count for a model based on the data warehouse's query logs.
- Provides data teams insight, so they can focus their time and infrastructure spend on the worthwhile used data products.
- Enable analysts to find the most popular models used by other people.

:::info Available in beta
Model query history is powered by a single query of the query log table in your data warehouse aggregated on a daily basis. It filters down to `select` statements only to gauge model consumption and excludes dbt model build and test executions.
Model consumption is powered by a single query of the query log table in your data warehouse aggregated on a daily basis. It filters down to `select` statements only to gauge model consumption and excludes dbt model build and test executions.
:::

## Prerequisites
Expand All @@ -24,18 +24,18 @@ To access the features, you should meet the following:
1. You have a dbt Cloud account on the [Enterprise plan](https://www.getdbt.com/pricing/).
2. You have set up a [production](https://docs.getdbt.com/docs/deploy/deploy-environments#set-as-production-environment) deployment environment for each project you want to explore, with at least one successful job run.
3. You have [admin permissions](/docs/cloud/manage-access/enterprise-permissions) in dbt Cloud to edit project settings or production environment settings.
4. Use Snowflake or BigQuery as your data warehouse and can enable query history permissions or work with an admin to do so (Support for additional data platforms coming soon).
4. Use Snowflake or BigQuery as your data warehouse and can enable model consumption permissions or work with an admin to do so (Support for additional data platforms coming soon).

## Credential permissions

This section explains the permissions and steps you need to enable and view model query history in dbt Explorer.
This section explains the permissions and steps you need to enable and view model consumption in dbt Explorer.

The model query history feature uses the credentials in your production environment to gather metadata from your data warehouse’s query logs. This means you may need elevated permissions with the warehouse. Before making any changes to your data platform permissions, confirm the configured permissions in dbt Cloud:
The model consumption feature uses the credentials in your production environment to gather metadata from your data warehouse’s query logs. This means you may need elevated permissions with the warehouse. Before making any changes to your data platform permissions, confirm the configured permissions in dbt Cloud:

1. Navigate to **Deploy** and then **Environments**.
2. Select the Environment marked **PROD** and click **Settings**.
3. Look at the information under **Deployment credentials**.
- Note: Querying query history entails warehouse costs / uses credits.
- Note: Querying consumption entails warehouse costs / uses credits.
<Lightbox src="/img/docs/collaborate/dbt-explorer/model-query-credentials.jpg" width="50%" title="Confirm your deployment credentials in your environment settings page." />

4. Copy or cross reference those credential permissions with the warehouse permissions and grant your user the right permissions.
Expand All @@ -57,22 +57,22 @@ The model query history feature uses the credentials in your production environm

</Expandable>

## Enable query history in dbt Cloud
## Enable consumption in dbt Cloud

:::info
During beta, the dbt Labs team will manually enable query history for your dbt Cloud projects. Later on, you’ll be able to do it yourself.
During beta, the dbt Labs team will manually enable model consumption for your dbt Cloud projects. Later on, you’ll be able to do it yourself.

:::
<!--
1. Navigate to **Deploy** and then **Environments**.
2. Select the environment marked **PROD** and click **Settings**.
3. Enable the checkbox for query history in **General Settings**.
4. Click the **Test** button to validate the deployment credentials permissions are sufficient to support query history.
3. Enable the checkbox for model consumption in **General Settings**.
4. Click the **Test** button to validate the deployment credentials permissions are sufficient to support consumption.
-->

## View query history in Explorer
## View model consumption in Explorer

To enhance your discovery, you can view your model query history in various locations within dbt Explorer. For details on how to access model query history in each location, expand the following toggles:
To enhance your discovery, you can view your model consumption in various locations within dbt Explorer. For details on how to access model consumption in each location, expand the following toggles:

### View from Performance charts

Expand All @@ -91,12 +91,12 @@ To enhance your discovery, you can view your model query history in various loca
2. In the lower left of your lineage, click on **Lenses** and select **Usage queries**.
<Lightbox src="/img/docs/collaborate/dbt-explorer/model-query-lenses.jpg" width="85%" title="View model usage query in your lineage using the 'Lenses' feature." />

3. Your lineage should display a small red box above each model, indicating the usage query number for each model. The query number for each model represents the query history over the last 30 days.
1. Your lineage should display a small red box above each model, indicating the usage query number for each model. The query number for each model represents the model consumption over the last 30 days.

### View from Model list

1. To view your model in your project lineage, go to the main **Overview page**.
2. In the left navigation, go to the **Resources** tab and click on **Models** to view the models list.
3. You can view the usage query count for the models and sort by most or least queried. The query number for each model represents the query history over the last 30 days.
<Lightbox src="/img/docs/collaborate/dbt-explorer/model-query-list.jpg" width="85%" title="View models query history in the 'Models' list page under the 'Usage' column." />
3. You can view the usage query count for the models and sort by most or least queried. The query number for each model represents the consumption over the last 30 days.
<Lightbox src="/img/docs/collaborate/dbt-explorer/model-query-list.jpg" width="85%" title="View models consumption in the 'Models' list page under the 'Usage' column." />

2 changes: 1 addition & 1 deletion website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ const sidebarSettings = {
items: [
"docs/collaborate/auto-exposures",
"docs/collaborate/data-tile",
"docs/collaborate/model-query-history",
"docs/collaborate/model-consumption",
],
},
],
Expand Down

0 comments on commit 9eabc0f

Please sign in to comment.