Gain insights and highlight inefficiencies in your organization's Google Cloud BigQuery usage with the Cloud Management Platform (CMP) BigQuery Lens. Have the essential BigQuery insights brought to you with zero configuration.
To access the BigQuery Lens, you must verify that your Google Cloud service account was successfully uploaded and granted the appropriate permissions. Read more about linking your Google Cloud Organization.
To check the status of your service account, select the Settings icon (a gear) from the top menu bar, then select Google Cloud:
You will need to enable the BigQuery Lens feature on this screen to use the BigQuery Lens. The same is true for BigQuery Lens Advanced.
After your service account has been uploaded and you have enabled the features you want, you will see:
- Either a HEALTHY or PARTIAL value underneath the Status column in your Configured Accounts widget
- HEALTHY status next to BigQuery Lens in the Features widget
- HEALTHY status next to BigQuery Lens Advanced in the Features widget (optional)
Once the Google Cloud Service Account setup is complete, select the Attach button from the dashboard navigation bar, then select BigQuery Lens from the list of options.
After attaching the BigQuery Lens dashboard, a BigQuery Lens icon will appear on your dashboard and the CMP will start gathering information about your account usage patterns.
While this information is being collected, your BigQuery Lens will have the three following states:
You will see the following message displayed at the top of your screen:
We have started to analyze your historical usage. So far, we have processed X%. In the meantime, you can explore our training Perks!
Then, the message will change to:
The scan is completed, and X% of your data was already processed. You are almost there!
Finally, once the BigQuery Lens is activated, the message at the top will change to:
BigQuery Lens highlights inefficiencies in your BigQuery usage. The analysis represents the last 30 days of use
Once activated, the CMP will populate the BigQuery Lens dashboard with the statistics and recommendations about your organization's BigQuery usage.
The BigQuery historical jobs are backfilled for the last 30 days.
Understanding the BigQuery Lens
The BigQuery Lens dashboard is made up of widgets that, each designed to highlight a different aspect of your BigQuery usage:
Elements of the Dashboard
Below is a list of the elements that make up the BigQuery Lens dashboard, corresponding to the numbers in the image above.
Time range and Usage type dropdowns:
- Time range — Adjusts the time frame of the data you're looking at, and has options of Last 30 days, Last 7 days, or Last day
- Usage type — Determines which BigQuery projects you're looking at, based on the pricing model you're using to pay for them, and has options of On demand or Flat-rate
Recommendations — Comprehensive recommendations with details about how to act on each suggestion.
BigQuery Explorer — Get more granular information as far as your team's BigQuery usage, completely adjustable by the user in the following format:
- For the On-demand usage type: (Project, Billing Project, Dataset, Table, User) by (Scan Price, Scan TB)
- For Flat-rate usage type: (Project, Billing Project, Dataset, Table, User) by (Average Slots)
Select any of the components of the BigQuery Explorer to drill down into the data.
Slots Consumption — The number of slots consumed by your organization in terms of Peak usage and Average usage by Day or Hour.
BigQuery Scans by Table Type — See how much data you are scanning from various types of tables, broken down between unpartitioned tables and multiple types of partitioned tables, along with external sources (e.g., Google Sheets).
Select a table type to see the most frequently scanned tables of that type.
BigQuery Spend by SKU — BigQuery costs broken down per SKU.
Select View more in the top right-hand corner of the widget to view a more detailed report with more configuration options.
BigQuery Recommendation Types
Below is a list of the recommendation categories you'll see in the BigQuery Recommendations widget, which will depend on the Usage type you've selected.
- Backup and remove unused tables — Back up and remove the tables listed under the Table column. If the table has multiple partitions, select the number under Partition(s) to Remove to see which partitions should be removed.
- Cluster your tables — Cluster the tables listed under the Table column by the fields suggested under the Cluster By column.
- Enforce Partition Fields — Use the suggested partitioned fields under the Partition Field column for the corresponding queries listed under the Query ID column.
- Partition your tables — Partition the tables listed under the Table column by the suggested fields listed under the Partition Fields column.
- Limit query jobs — Reduce execution frequency of the listed jobs under the Query ID column by the percentage you choose on the slider and view the associated savings of each reduced job under the Savings by Reducing Jobs column.
- Switch to monthly flat-rate plan — Purchase the slots amount listed in the Optimal slots amount column to reduce your BigQuery spend.
Move repeating queries to a different time slot — Lower your minimum average slots requirements by moving the recurring queries to a less-busy hour of the day.
Review the BigQuery Slots Consumption widget with the interval set to Hour to identify suitable hours. Any troughs in your daily slots consumption indicate optimal hours to run recurring queries.
Backup and remove unused tables — Back up and remove the unused tables to lower costs.
Frequently Asked Questions (FAQ)
We need write-permissions to be able to run the BigQuery Lens. The sections below explain why.
What write permissions are needed for the BigQuery Lens?
We need the following write permissions for the standard BigQuery Lens:
For BigQuery Lens Advanced, we need the following write permission:
Why do you need an extra permission for BigQuery Lens Advanced?
We require the
bigquery.tables.getData permission to provide clustering recommendations that are unique to BigQuery Lens Advanced.
This permission allows us to query your BigQuery tables, find your top 20 non-clustered tables and then determine which fields are the best candidates to cluster those tables by and in what order.
More specifically, this permission helps us identify the cardinality of the columns referenced in the
WHERE clause (i.e., the columns which can be clustered on). Knowing how many distinct elements exist in each column allows us to compute the average chunk size and determine the best savings candidates.
BigQuery Lens Advanced provides recommendations based on the presumption that:
- You will continue to execute similar queries as you did during the previous 30 day period, and
- You will reference fields in the order that we recommend
What datasets do you create?
A dataset called
doitintl-cmp-bq is created in the billing project attached to the service account you add to the CMP.
What sinks do you create?
A sink for query jobs is created in the billing project attached to the service account you add to the CMP. This sink pushes all your BigQuery jobs into a table under
What queries do you run?
We have two main processes, one of which runs queries and the other which runs the enrichment process:
We take the data from
doitintl-cmp-bq.cloudaudit_ googleapis_com_data_accessand create a new table named
doitintl-cmp-bq.enrichedJobs. This operation is done at no cost to you. We do this to perform an enrichment process so that we have a clean dataset to work with.
For the BigQuery Lens enrichment process, we create a few UDFs under the
doitintl-cmp-bqdataset, as well as two more derived tables named
queries. These tables allow the lens to run over aggregated data rather than raw data.
The following queries are executed as part of this process:
- Aggregations are written to the
- Daily run of cost simulation queries to provide the cost savings information and potential savings
- Daily run of lens calculation queries to provide detailed BigQuery usage
- Aggregations are written to the
What does it mean when I see "Not yet allocated" in the Cost Explorer?
You will see "Not yet allocated" when analyzing dimensions like Projects in the BigQuery Explorer when we cannot detect which table a query is scanning.
We may not be able to detect which table is being scanned because of:
- Queries like
- Queries we are unable to parse due to complexity (i.e., a parser time out), or
- Queries that use a function or statement that we do not support yet
How much does BigQuery Lens cost monthly?
BigQuery Lens creates and maintains datasets on your behalf to provide you with analytics data (as described above). Typically, this process costs less than $10 per month.
If you have an excess of historical jobs, you may see an increased cost for BigQuery Streaming Inserts when we backfill them for the last 30 days during your service account setup.
What is the difference between "Project" and "Billing project" in the Explorer widget?
The Billing project runs the query and incurs the costs. The Project contains the data that is queried.