diff --git a/website/docs/docs/collaborate/explore-projects.md b/website/docs/docs/collaborate/explore-projects.md index e60d019bf2e..1c469409e4f 100644 --- a/website/docs/docs/collaborate/explore-projects.md +++ b/website/docs/docs/collaborate/explore-projects.md @@ -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-query-history) to track consumption 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. diff --git a/website/docs/docs/collaborate/model-query-history.md b/website/docs/docs/collaborate/model-query-history.md index ee7695e3ab9..d8e08bf63da 100644 --- a/website/docs/docs/collaborate/model-query-history.md +++ b/website/docs/docs/collaborate/model-query-history.md @@ -7,14 +7,18 @@ image: /img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg # About model query history -The model query history tile allows you to: +Model query history allows you to: -- View the query count for a model based on the data warehouse's query logs. +- View the count of consumption queries 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 query history is powered by a single consumption query of the query log table in your data warehouse aggregated on a daily basis. + +:::info What is a consumption query? +Consumption query is a metric of queries in your dbt project that has used the model in a given time. It filters down to `select` statements only to gauge model consumption and excludes dbt model build and test executions. + +So for example, if `model_super_santi` was queried 10 times in the past week, it would count as having 10 consumption queries for that particular time period. ::: ## Prerequisites @@ -72,31 +76,35 @@ During beta, the dbt Labs team will manually enable query history for your dbt C ## View query history 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 query history in various locations within dbt Explorer: +- [View from Performance charts](#view-from-performance-charts) +* [View from Project lineage](#view-from-project-lineage) +- [View from Model list](#view-from-model-list) ### View from Performance charts 1. Navigate to dbt Explorer by clicking on the **Explore** link in the navigation. -2. In the main **Overview** page, under **Project** click **Performance** and scroll down to view the most queried models +2. In the main **Overview** page, click on **Performance** under the **Project details** section. Scroll down to view the **Most consumed models**. 3. Use the dropdown menu on the right to select the desired time period, with options available for up to the past 3 months. - + -4. In the model performance tab, open the **Usage** chart to see queries over time for that model. - +4. Click on a model for more details and go to the **Performance** tab. +5. On the **Performance** tab, scroll down to the **Model performance** section. +6. Select the **Consumption queries** tab to view the consumption queries over a given time for that model. + ### View from Project lineage 1. To view your model in your project lineage, go to the main **Overview page** and click on **Project lineage.** -2. In the lower left of your lineage, click on **Lenses** and select **Usage queries**. - +2. In the lower left of your lineage, click on **Lenses** and select **Consumption queries**. + -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. +3. Your lineage should display a small red box above each model, indicating the consumption query number. The 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**. +1. To view a list of models, 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. - - +3. You can view the consumption query count for the models and sort by most or least consumed. The consumption query number for each model represents the consumption over the last 30 days. + diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-consumption-lenses.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-lenses.jpg new file mode 100644 index 00000000000..9bf6c7ca0e3 Binary files /dev/null and b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-lenses.jpg differ diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-consumption-list.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-list.jpg new file mode 100644 index 00000000000..653fe7a2f43 Binary files /dev/null and b/website/static/img/docs/collaborate/dbt-explorer/model-consumption-list.jpg differ diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-lenses.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-lenses.jpg deleted file mode 100644 index caa0cc72d67..00000000000 Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-lenses.jpg and /dev/null differ diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-list.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-list.jpg deleted file mode 100644 index 14c5c1ceb9c..00000000000 Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-list.jpg and /dev/null differ diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg deleted file mode 100644 index 6b20b501880..00000000000 Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-queried-models.jpg and /dev/null differ diff --git a/website/static/img/docs/collaborate/dbt-explorer/model-query-usage-queries.jpg b/website/static/img/docs/collaborate/dbt-explorer/model-query-usage-queries.jpg deleted file mode 100644 index 41857b3a482..00000000000 Binary files a/website/static/img/docs/collaborate/dbt-explorer/model-query-usage-queries.jpg and /dev/null differ diff --git a/website/static/img/docs/collaborate/dbt-explorer/most-consumed-models.jpg b/website/static/img/docs/collaborate/dbt-explorer/most-consumed-models.jpg new file mode 100644 index 00000000000..9e14db15f90 Binary files /dev/null and b/website/static/img/docs/collaborate/dbt-explorer/most-consumed-models.jpg differ diff --git a/website/static/img/docs/collaborate/model-consumption-queries.jpg b/website/static/img/docs/collaborate/model-consumption-queries.jpg new file mode 100644 index 00000000000..7fe9b23866c Binary files /dev/null and b/website/static/img/docs/collaborate/model-consumption-queries.jpg differ