Skip to content

docs(workspace): rename page to Query History #6566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 17, 2023
Merged

docs(workspace): rename page to Query History #6566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/content/Workspace/Inspecting-Pre-aggregations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ can see which pre-aggregations are accelerating queries, if they are [being
refreshed][ref-caching-using-preaggs-refresh], along with the last 24 hours of
build history.

<SuccessBox>

Pre-Aggregations are available in Cube Cloud on
[all tiers](https://cube.dev/pricing).

</SuccessBox>

<Screenshot src="https://ucarecdn.com/eb10de99-4ff6-4a9f-abd5-736971497583/" />

## Exploring pre-aggregations
Expand Down
43 changes: 25 additions & 18 deletions docs/content/Workspace/Inspecting-Queries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
---
title: Query inspection
title: Query History
permalink: /cloud/inspecting-queries
category: Workspace
menuOrder: 4
---

The Queries page in Cube Cloud is a one-stop shop for all performance and
diagnostic information about queries issued for a deployment. It is kept
The Query History screen in Cube Cloud is a one-stop shop for all performance
and diagnostic information about queries issued for a deployment. It is kept
up-to-date in real time and provides a quick way to check whether queries are
being accelerated with [pre-aggregations][ref-caching-gs-preaggs], how long they
took to execute, and if they failed.

<Screenshot src="https://ucarecdn.com/44bb6d8d-5943-4978-8b15-73e1e43fd988/" />
<SuccessBox>

Query History is available in Cube Cloud on
[all tiers](https://cube.dev/pricing).

</SuccessBox>

<Screenshot src="https://ucarecdn.com/951a2a64-bc9b-4277-b2fe-4cc88dbf4f49/" />

## Setting the time range

Expand All @@ -22,25 +29,25 @@ a time period:

<Screenshot
highlight="inset(15% 1% 60% 21% round 10px)"
src="https://ucarecdn.com/691e7cfa-e7fd-4df1-8cfa-f8f0d74634f6/"
src="https://ucarecdn.com/393dfa47-033d-421b-87ce-fcf5617ac1c8/"
/>

To go back to live mode, click <Btn>▶</Btn>:

<Screenshot
highlight="inset(15% 6% 79% 88% round 10px)"
src="https://ucarecdn.com/691e7cfa-e7fd-4df1-8cfa-f8f0d74634f6/"
src="https://ucarecdn.com/393dfa47-033d-421b-87ce-fcf5617ac1c8/"
/>

## Exploring queries

You can switch between [queries made to the API](#api-queries) and
[queries made to connected data sources](#database-queries) by switching between
the <Btn>API</Btn> and <Btn>Database</Btn> tabs.
You can switch between [queries made to the API](#inspecting-api-queries) and
[queries made to connected data sources](#inspecting-database-queries) by
switching between the <Btn>API</Btn> and <Btn>Database</Btn> tabs.

<Screenshot
highlight="inset(22% 64% 70% 20% round 10px)"
src="https://ucarecdn.com/44bb6d8d-5943-4978-8b15-73e1e43fd988/"
highlight="inset(22% 79% 70% 7% round 10px)"
src="https://ucarecdn.com/951a2a64-bc9b-4277-b2fe-4cc88dbf4f49/"
/>

### <--{"id" : "API and Database"}--> All Queries and Top Queries
Expand All @@ -50,8 +57,8 @@ while&nbsp;<Btn>Top Queries</Btn> will show the most-frequently executed
queries:

<Screenshot
highlight="inset(30% 50% 64% 20% round 10px)"
src="https://ucarecdn.com/44bb6d8d-5943-4978-8b15-73e1e43fd988/"
highlight="inset(30% 65% 64% 7% round 10px)"
src="https://ucarecdn.com/951a2a64-bc9b-4277-b2fe-4cc88dbf4f49/"
/>

### <--{"id" : "API and Database"}--> Filtering
Expand All @@ -61,8 +68,8 @@ duration, cache status, whether the query was accelerated, and by failing
queries:

<Screenshot
highlight="inset(36% 8% 58% 20% round 10px)"
src="https://ucarecdn.com/44bb6d8d-5943-4978-8b15-73e1e43fd988/"
highlight="inset(36% 22% 58% 7% round 10px)"
src="https://ucarecdn.com/951a2a64-bc9b-4277-b2fe-4cc88dbf4f49/"
/>

## Inspecting API Queries
Expand Down Expand Up @@ -162,9 +169,9 @@ and stacktrace:
<Screenshot src="https://ucarecdn.com/efd45e3a-8b44-4ee9-9f9e-284f0fd8eb96/" />

Errors here generally indicate a problem with querying the data source. The
generated SQL query can be copied from the
<Btn>[Query](#inspecting-database-queries-query)</Btn> tab and run directly
against your data source to debug the issue.
generated SQL query can be copied from
the&nbsp;<Btn>[Query](#inspecting-database-queries-query)</Btn> tab and run
directly against your data source to debug the issue.

### <--{"id" : "Inspecting Database Queries"}--> Events

Expand Down