Skip to content
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.

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

DOC-10465 Docs for o11y/console: Enhance the DB console user experience for metrics and redaction #19004

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions src/current/_includes/v23.2/ui/ui-metrics-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Use the **Graph** menu to display metrics for your entire cluster or for a speci

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the [SQL Activity]({% link {{ page.version.version }}/ui-overview.md %}#sql-activity) pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, two perpendicular lines will appear at your mouse cursor providing further insight into the data. The metric values are displayed in the legend under the graph. Click anywhere within the graph to pin the values in place, decoupling the values from your mouse movements. Click anywhere within the graph to cause the values to change with your mouse movements once more.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.

Hovering your mouse cursor over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.

In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the left of the legend. This is to limit the size of the legend so that it does not get endlessly big, particularly on clusters with many nodes.
6 changes: 4 additions & 2 deletions src/current/_includes/v24.1/ui/ui-metrics-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Use the **Graph** menu to display metrics for your entire cluster or for a speci

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the [SQL Activity]({% link {{ page.version.version }}/ui-overview.md %}#sql-activity) pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, two perpendicular lines will appear at your mouse cursor providing further insight into the data. The metric values are displayed in the legend under the graph. Click anywhere within the graph to pin the values in place, decoupling the values from your mouse movements. Click anywhere within the graph to cause the values to change with your mouse movements once more.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.

Hovering your mouse cursor over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.

In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the left of the legend. This is to limit the size of the legend so that it does not get endlessly big, particularly on clusters with many nodes.
6 changes: 4 additions & 2 deletions src/current/_includes/v24.2/ui/ui-metrics-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Use the **Graph** menu to display metrics for your entire cluster or for a speci

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the [SQL Activity]({% link {{ page.version.version }}/ui-overview.md %}#sql-activity) pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, two perpendicular lines will appear at your mouse cursor providing further insight into the data. The metric values are displayed in the legend under the graph. Click anywhere within the graph to pin the values in place, decoupling the values from your mouse movements. Click anywhere within the graph to cause the values to change with your mouse movements once more.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.

Hovering your mouse cursor over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.

In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the left of the legend. This is to limit the size of the legend so that it does not get endlessly big, particularly on clusters with many nodes.
6 changes: 4 additions & 2 deletions src/current/_includes/v24.3/ui/ui-metrics-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ Use the **Graph** menu to display metrics for your entire cluster or for a speci

To the right of the Graph and Dashboard menus, a time interval selector allows you to filter the view for a predefined or custom time interval. Use the navigation buttons to move to the previous, next, or current time interval. When you select a time interval, the same interval is selected in the [SQL Activity]({% link {{ page.version.version }}/ui-overview.md %}#sql-activity) pages. However, if you select 10 or 30 minutes, the interval defaults to 1 hour in SQL Activity pages.

When viewing graphs, two perpendicular lines will appear at your mouse cursor providing further insight into the data. The metric values are displayed in the legend under the graph. Click anywhere within the graph to pin the values in place, decoupling the values from your mouse movements. Click anywhere within the graph to cause the values to change with your mouse movements once more.
Hovering your mouse pointer over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.

Hovering your mouse cursor over the graph title will display a tooltip with a description and the [metrics]({% link {{ page.version.version }}/essential-metrics-self-hosted.md %} ) used to create the graph.
When hovering on graphs, crosshair lines will appear at your mouse pointer. The series' values corresponding to the given time in the cross hairs are displayed in the legend under the graph. Hovering the mouse pointer on a given series displays the corresponding value near the mouse pointer and highlights the series line (graying out other series lines). Click anywhere within the graph to freeze the values in place. Click anywhere within the graph again to cause the values to change with your mouse movements once more.

In the legend, click on an individual series to isolate it on the graph. The other series will be hidden, while the hover will still work. Click the individual series again to make the other series visible. If there are many series, a scrollbar may appear on the left of the legend. This is to limit the size of the legend so that it does not get endlessly big, particularly on clusters with many nodes.
2 changes: 1 addition & 1 deletion src/current/v23.2/ui-overview-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The time-series data displayed in DB Console graphs is stored within the Cockroa

{% include {{ page.version.version }}/ui/ui-metrics-navigation.md %}

The **Overview** dashboard displays the following time series graphs. All timestamps in the DB Console are shown in 24-hour Coordinated Universal Time (UTC).
The **Overview** dashboard displays the following time series graphs.

## SQL Statements

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.1/ui-overview-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The time-series data displayed in DB Console graphs is stored within the Cockroa

{% include {{ page.version.version }}/ui/ui-metrics-navigation.md %}

The **Overview** dashboard displays the following time series graphs. All timestamps in the DB Console are shown in 24-hour Coordinated Universal Time (UTC).
The **Overview** dashboard displays the following time series graphs.

## SQL Statements

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.2/ui-overview-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The time-series data displayed in DB Console graphs is stored within the Cockroa

{% include {{ page.version.version }}/ui/ui-metrics-navigation.md %}

The **Overview** dashboard displays the following time series graphs. All timestamps in the DB Console are shown in 24-hour Coordinated Universal Time (UTC).
The **Overview** dashboard displays the following time series graphs.

## SQL Statements

Expand Down
2 changes: 1 addition & 1 deletion src/current/v24.3/ui-overview-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The time-series data displayed in DB Console graphs is stored within the Cockroa

{% include {{ page.version.version }}/ui/ui-metrics-navigation.md %}

The **Overview** dashboard displays the following time series graphs. All timestamps in the DB Console are shown in 24-hour Coordinated Universal Time (UTC).
The **Overview** dashboard displays the following time series graphs.

## SQL Statements

Expand Down
Loading