Skip to content

Commit 3ad0725

Browse files
authored
Add monitor list (#107)
1 parent cfc32c4 commit 3ad0725

File tree

10 files changed

+50
-8
lines changed

10 files changed

+50
-8
lines changed

dashboard-elements/create.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To create new dashboard elements:
2323
1. Optional: [Configure chart options](/dashboard-elements/configure).
2424
1. Click **Save**.
2525

26-
The new element appears in your dashboard. In the bottom, click **Save** to save your changes to the dashboard.
26+
The new element appears in your dashboard. At the bottom, click **Save** to save your changes to the dashboard.
2727

2828
## Change element’s position
2929

dashboard-elements/monitor-list.mdx

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Monitor list
3+
description: 'This section explains how to create monitor list dashboard elements and add them to your dashboard.'
4+
sidebarTitle: Monitor List
5+
tags:
6+
['axiom documentation', 'documentation', 'axiom', 'dashboards', 'collaboration', 'queries', 'visualizations', 'filters', 'charts', 'simple query builder', 'advanced query builder']
7+
---
8+
9+
import Prerequisites from "/snippets/dashboard-minimal-prerequisites.mdx"
10+
11+
The monitor list dashboard element provides a visual overview of the monitors you specify. It offers a quick glance into important developments about the monitors such as their status and history.
12+
13+
<Prerequisites />
14+
{/* list separator */}
15+
- [Create a monitor](/monitor-data/monitors).
16+
17+
## Create monitor list
18+
19+
1. Go to the Dashboards tab and open the dashboard where you want to add the monitor list.
20+
1. Click <img src="/doc-assets/icons/plus.svg" className="inline-icon" alt="Add chart" /> **Add chart** in the top right corner.
21+
1. Click **Monitor list** from the list.
22+
1. In **Columns**, select the type of information you want to display for each monitor:
23+
- **Status** displays if the monitor state is normal, triggered, or disabled.
24+
- **History** provides a visual overview of the recent runs of the monitor. Green squares mean normal operation and red squares mean triggered state.
25+
- **Dataset** is the name of the dataset on which the monitor operates.
26+
- **Type** is the type of the monitor.
27+
- **Notifiers** displays the notifiers connected to the monitor.
28+
1. From the list, select the monitors you want to display on the dashboard.
29+
1. Click **Save**.
30+
31+
The new element appears in your dashboard. At the bottom, click **Save** to save your changes to the dashboard.
32+
33+
<Frame>
34+
<img src="/doc-assets/shots/monitor-list.png" alt="Example monitor list" />
35+
</Frame>

dashboard-elements/note.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ The note dashboard element adds a textbox to your dashboard that you can customi
2020
1. Enter your text on the left in [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) format. You see the preview of the note dashboard element on the right.
2121
1. Click **Save**.
2222

23-
The new element appears in your dashboard. In the bottom, click **Save** to save your changes to the dashboard.
23+
The new element appears in your dashboard. At the bottom, click **Save** to save your changes to the dashboard.

dashboard-elements/overview.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Choose one of the following to learn more about a dashboard element:
2222
href="/dashboard-elements/log-stream"
2323
>
2424
</Card>
25+
<Card
26+
title="Monitor list"
27+
icon="desktop"
28+
href="/dashboard-elements/monitor-list"
29+
>
30+
</Card>
2531
<Card
2632
title="Note"
2733
icon="note-sticky"

dashboard-elements/pie-chart.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Pie charts can illustrate the distribution of different types of event data. Eac
1818
## Example with Simple Query Builder
1919

2020
<Frame>
21-
<img src="/doc-assets/shots/pie-chart-builder.png" />
21+
<img src="/doc-assets/shots/pie-chart-builder.png" alt="Pie chart example with Simple Query Builder" />
2222
</Frame>
2323

2424
## Example with Advanced Query Language
2525

2626
<Frame>
27-
<img src="/doc-assets/shots/pie-chart-apl.png" />
27+
<img src="/doc-assets/shots/pie-chart-apl.png" alt="Pie chart example with Advanced Query Language" />
2828
</Frame>

dashboards/configure.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To specify who can access a dashboard:
2525
- Select **Just Me** to make the dashboard private. Only you can access the dashboard.
2626
- Select a group in your Axiom organization. Only members of the selected group can access the dashboard. For more information about groups, see [Access](/reference/settings#access-overview).
2727
- Select **Everyone** to make the dashboard accessible to all users in your Axiom organization.
28-
1. In the bottom, click **Save** to save your changes to the dashboard.
28+
1. At the bottom, click **Save** to save your changes to the dashboard.
2929

3030
<Note>
3131
The data that individual users see in the dashboard is determined by the datasets the users have access to. If a user has access to a dashboard but only to some of the datasets referenced in the dashboard’s charts, the user only sees data from the datasets they have access to.
@@ -40,7 +40,7 @@ To specify the types of annotations to display in all dashboard elements:
4040
- Show all annotations
4141
- Hide all annotations
4242
- Selective determine the annotations types to display
43-
1. In the bottom, click **Save** to save your changes to the dashboard.
43+
1. At the bottom, click **Save** to save your changes to the dashboard.
4444

4545
## Set dashboard as homepage
4646

doc-assets/shots/monitor-list.png

62 KB
Loading

mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,7 @@
189189
"dashboard-elements/configure",
190190
"query-data/filters",
191191
"dashboard-elements/log-stream",
192+
"dashboard-elements/monitor-list",
192193
"dashboard-elements/note",
193194
"dashboard-elements/pie-chart",
194195
"dashboard-elements/scatter-plot",

process-data/destinations/manage-destinations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ To set up a destination:
2626
- [HTTP (Basic)](/process-data/destinations/http#configure-http-basic-destination)
2727
- [OpenTelemetry Traces](/process-data/destinations/opentelemetry#configure-opentelemetry-traces-destination)
2828

29-
6. In the bottom right, click **Save**.
29+
6. At the bottom right, click **Save**.

snippets/create-dashboard-element.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
1. Optional: [Configure the dashboard element](/dashboard-elements/configure).
1010
1. Click **Save**.
1111

12-
The new element appears in your dashboard. In the bottom, click **Save** to save your changes to the dashboard.
12+
The new element appears in your dashboard. At the bottom, click **Save** to save your changes to the dashboard.

0 commit comments

Comments
 (0)