-
Notifications
You must be signed in to change notification settings - Fork 12
SaaS Reporting Tutorial Entity Metrics Worksheet
amccook edited this page Nov 17, 2023
·
14 revisions
We'll show an example of how to create a query referencing data from the "Entity Metrics Worksheet". Specifically, we'll create an Answer that shows the top 50 most utilized VMs by vMem 95th percentile.
- Login to Thoughtspot.
- Click on the
Search data
button on the top.
- On the left, locate the
Sources
section. Click on the wrench to select a source.
- In the Worksheets section, check the box for the
Entity Metrics
worksheet. Click Done.
- Let's add some filters first to help speed up the query.
- On the left-hand side, hover your mouse over
Datetime (UTC)
and click the filter icon.
- From the drop-down, select
Last
. Then fill out30
andDays
. ClickApply
.
- In the query bar at the top, type
virtual_machine
. A drop-down will appear with suggested filters, click thevirtual_machine
forEntity Type in Entity Metrics
.
- In the query bar at the top, type
vmem
. A drop-down will appear with suggested filters, click thevmem
forMetric Type in Entity Metrics
.
- On the left-hand side, hover your mouse over
- Now let's add some columns to our query. On the left-hand side, double-click on the following columns to add them to the query box at the top:
-
Name
- the name of the VM -
Metric Type
- the metric name
-
- Now let's plot a few different utilization values.
- In the query bar at the top, type
average Utilization
. A drop-down will appear with suggested values, click theUtilization
fromEntity Metrics
.
- In the query bar at the top, type
max Utilization
. A drop-down will appear with suggested values, click theUtilization
fromEntity Metrics
.
- In the query bar at the top, type
- Now let's add a formula that converts the latest vMem value from KB to GB for better legibility.
- On the left-hand sidebar, locate
Formulas
and click the+
button.
- In the
Formula name
box, type:Latest Capacity (GB)
.
- In the formula box, type the following:
if (group_max(Datetime (UTC))=Datetime (UTC)) then if(Metric Type ='vmem') then Capacity/1024/1024 else Capacity else null
- Click
Save
- On the left-hand sidebar, locate
- Now let's add a formula that calculates the 95th Percentile.
- On the left-hand sidebar, locate
Formulas
and click the+
button.
- In the
Formula name
box, type:95th Percentile
.
- In the formula box, type the following:
percentile(Utilization,95,'asc')
- Click
Save
- On the left-hand sidebar, locate
- Now let's sort and filter to show the Top 50 vMem consumers by 95th percentile. In the query box at the top, type:
top 50 by 95th Percentile
.
- For legibility, let's set the Number format to be a "percentage" for the 95th Percentile column.
- Hover over the
95th Percentile
column and click the three dots > clickNumber Format
- In the right sidebar, in the
Category
drop down, selectPercentage
.
- Hover over the
- Now let's save this visualization (ThoughtSpot terminology: "Answer"). Click on the
More
icon (three dots) and selectSave
.
- Provide a
Name
andDescription
for your visualization and then clickSave Answer
.- Name:
Top 50 VMs by VMem 95th Percentile
- Description:
Plotting: Max, 95P, Average
- Name:
- You can export the table as a XLSX, CSV, or PDF by click on the
More
icon (three dots) and selectingDownload
>XLSX|CSV|PDF
.
- You now have a table showing the Top 50 VMs by vMem utilization. Continue to the optional steps to visualize this on a chart.
-
Optional: Visualization and Legibility Improvements
- To visualize the difference between a VM's Maximum, 95th Percentile, and Average vMem values, let's switch to the chart View. Click on the
View Chart
icon beneath the query bar.
- A default visualization will appear. Let's make some modifications. Click on the
Change visualization
icon on the right and selectColumn
.
- Click on the
Edit chart configuration
(gear) button on the right.
- Drag the entities according to the following organization:
- X-axis
Name
- Y-axis
Maximum Utilization
95th Percentile
Average Utilization
- Slice with color
- Leave empty
- Not visualized
Metric Type
-
Latest Capacity (GB)
- X-axis
- Click
Apply
- For legibility, if any Y-axis legends are plotted on the right, you can position them on the left by clicking on the Y-axis title drop-down >
Position
>Left
- For legibility, set the maximum Y-axis values to be 125% (1.25).
- Click on one of the y-axis title drop-down menus >
Edit
.
- In the
Max
text box, type1.25
- Repeat for all 3 y-axis (Max, 95th Percentile, Average)
- Click on one of the y-axis title drop-down menus >
- For legibility, add X-axis and Y-axis gridlines. Click on the
Edit chart configuration
(gear) button on the right > select theSettings
tab > check the boxes forX-axis gridlines
andY-axis gridlines
.
- Now let's save this visualization again. Click on the
More
icon (three dots) and selectSave
.
- To visualize the difference between a VM's Maximum, 95th Percentile, and Average vMem values, let's switch to the chart View. Click on the
- Your query and visualization are complete! You can now see the Top 50 VMs by vMem utilization.
Embedded Reporting
SaaS Reporting
- Overview
- Official Documentation
-
Tutorials
- Creating Custom Answers
- Action Worksheet
- Entity Metrics Worksheet
- Cloud Entities Worksheet
- Import Community Answers/Pinboards
- Creating Custom Answers
- Community Answers & Liveboards