Skip to content

Commit d9470ce

Browse files
authored
Add pie charts (#98)
1 parent a1c3d32 commit d9470ce

File tree

9 files changed

+56
-6
lines changed

9 files changed

+56
-6
lines changed

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="Pie chart"
27+
icon="chart-pie"
28+
href="/dashboard-elements/pie-chart"
29+
>
30+
</Card>
2531
<Card
2632
title="Scatter plot"
2733
icon="chart-scatter"

dashboard-elements/pie-chart.mdx

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: 'Pie chart'
3+
description: 'This section explains how to create pie chart dashboard elements and add them to your dashboard.'
4+
sidebarTitle: Pie Chart
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-prerequisites.mdx"
10+
import CreateElement from "/snippets/create-dashboard-element.mdx"
11+
12+
Pie charts can illustrate the distribution of different types of event data. Each slice represents the proportion of a specific value relative to the total. For example, a pie chart can show the breakdown of status codes in HTTP logs. This helps quickly identify the dominant types of status responses and assess the system’s health at a glance.
13+
14+
<Prerequisites />
15+
16+
<CreateElement elementName="pie chart" elementButtonLabel="Pie"/>
17+
18+
## Example with Simple Query Builder
19+
20+
<Frame>
21+
<img src="/doc-assets/shots/pie-chart-builder.png" />
22+
</Frame>
23+
24+
## Example with Advanced Query Language
25+
26+
<Frame>
27+
<img src="/doc-assets/shots/pie-chart-apl.png" />
28+
</Frame>

doc-assets/shots/pie-chart-apl.png

209 KB
Loading
235 KB
Loading

mint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@
187187
"dashboard-elements/configure",
188188
"query-data/filters",
189189
"dashboard-elements/log-stream",
190+
"dashboard-elements/pie-chart",
190191
"dashboard-elements/scatter-plot",
191192
"dashboard-elements/statistic",
192193
"dashboard-elements/table",

query-data/annotate-charts.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ import Prerequisites from "/snippets/minimal-prerequisites.mdx"
1919

2020
<Prerequisites />
2121
{/* list separator */}
22+
- [Send data](/send-data/ingest) to your Axiom dataset.
2223
- [Create an API token in Axiom](/reference/tokens) with permissions to create, read, update, and delete annotations.
23-
- [Send data to your Axiom dataset](/send-data/ingest).
2424

2525
## Create annotations
2626

query-data/filters.mdx

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,9 @@ Filters let you choose the data you want to display in your dashboard. This page
1010

1111
Try out all the examples explained on this page in the [HTTP logs dashboard of the Axiom Playground](https://play.axiom.co/axiom-play-qf1k/dashboards/gZXp8KNJy68q7yGsuA).
1212

13-
## Prerequisites
13+
import Prerequisites from "/snippets/dashboard-prerequisites.mdx"
1414

15-
- [Create an Axiom account](https://app.axiom.co/).
16-
- [Create a dataset in Axiom](/reference/datasets) where you send your data.
17-
- [Send data to the dataset](/send-data/ingest).
18-
- [Create an empty dashboard](/dashboards/create).
15+
<Prerequisites />
1916

2017
## Filter types
2118

snippets/create-dashboard-element.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Create {elementName}
2+
3+
1. Go to the Dashboards tab and open the dashboard where you want to add the {elementName}.
4+
1. Click <img src="/doc-assets/icons/plus.svg" className="inline-icon" alt="Add chart" /> **Add chart** in the top right corner.
5+
1. Click **{elementButtonLabel}** from the list.
6+
1. Choose one of the following:
7+
- Click **Simple Query Builder** to create your chart using a visual query builder. Create a chart in the same way you create a chart in the [Datasets tab](/query-data/datasets).
8+
- Click **Advanced Query Language** to create your chart using the Axiom Processing Language (APL). Create a chart in the same way you create a chart in the APL query builder of the [Explore tab](/query-data/explore#create-a-query-using-apl).
9+
1. Optional: [Configure the dashboard element](/dashboard-elements/configure).
10+
1. Click **Save**.
11+
12+
The new element appears in your dashboard. In the bottom, click **Save** to save your changes to the dashboard.

snippets/dashboard-prerequisites.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
## Prerequisites
2+
3+
- [Create an Axiom account](https://app.axiom.co/register).
4+
- [Create a dataset in Axiom](/reference/datasets) where you send your data.
5+
- [Send data](/send-data/ingest) to your Axiom dataset.
6+
- [Create an empty dashboard](/dashboards/create).

0 commit comments

Comments
 (0)