Skip to content

Commit 24dc70e

Browse files
tothmanobenenharrington
tothmano
and
benenharrington
authored
Improve Get started section (#238)
Co-authored-by: benenharrington <42470628+benenharrington@users.noreply.github.com>
1 parent 6111835 commit 24dc70e

15 files changed

+339
-16
lines changed

‎docs.json

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,21 @@
2020
"introduction",
2121
"getting-started-guide/getting-started",
2222
"getting-started-guide/axiom-tour",
23+
{
24+
"group": "Try out Axiom",
25+
"icon": "play",
26+
"pages": [
27+
"getting-started-guide/try-out-axiom",
28+
"getting-started-guide/explore-axiom-playground",
29+
"getting-started-guide/quickstart-using-sample-data",
30+
"getting-started-guide/get-started-example-app"
31+
]
32+
},
2333
{
2434
"group": "Learn about Axiom",
2535
"icon": "book-font",
2636
"pages": [
37+
"getting-started-guide/learn-about-axiom",
2738
"getting-started-guide/event-data",
2839
"getting-started-guide/observability",
2940
"getting-started-guide/feature-states",
@@ -74,31 +85,37 @@
7485
"icon": "language",
7586
"pages": [
7687
"guides/send-logs-from-dotnet",
77-
"guides/opentelemetry-dotnet",
7888
"guides/send-logs-from-apache-log4j",
7989
"guides/apex",
8090
"guides/opentelemetry-cloudflare-workers",
81-
"guides/opentelemetry-django",
8291
"guides/go",
8392
"guides/logrus",
84-
"guides/opentelemetry-go",
85-
"guides/opentelemetry-java",
8693
"guides/javascript",
8794
"guides/send-logs-from-laravel",
8895
"send-data/nextjs",
89-
"guides/opentelemetry-nextjs",
90-
"guides/opentelemetry-nodejs",
9196
"guides/pino",
9297
"guides/python",
93-
"guides/opentelemetry-python",
9498
"send-data/react",
9599
"guides/send-logs-from-ruby-on-rails",
96-
"guides/opentelemetry-ruby",
97100
"guides/rust",
98101
"guides/winston",
99102
"guides/zap"
100103
]
101104
},
105+
{
106+
"group": "Example apps",
107+
"icon": "vial",
108+
"pages": [
109+
"guides/opentelemetry-dotnet",
110+
"guides/opentelemetry-django",
111+
"guides/opentelemetry-go",
112+
"guides/opentelemetry-java",
113+
"guides/opentelemetry-nextjs",
114+
"guides/opentelemetry-nodejs",
115+
"guides/opentelemetry-python",
116+
"guides/opentelemetry-ruby"
117+
]
118+
},
102119
{
103120
"group": "AWS",
104121
"icon": "aws",

‎getting-started-guide/explore-axiom-playground.mdx

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
title: 'Explore Axiom Playground'
3+
excerpt: 'This page explains how to try out Axiom without registration with the Axiom Playground.'
4+
sidebarTitle: Playground
5+
---
6+
7+
This page explains how to try out Axiom without registration with the [Axiom Playground](https://play.axiom.co/). It walks you through an example where you run a website and you want to keep an overview of the HTTP requests to this site with Axiom.
8+
9+
## 1. Explore sample data
10+
11+
1. Go to the [Axiom Playground](https://play.axiom.co/).
12+
1. Click the **Datasets** tab at the top of the page.
13+
1. In the list of datasets, click `sample-http-logs`.
14+
15+
This displays the fields in the sample dataset `sample-http-logs`. In Axiom, an individual piece of data is an event, and a dataset is a collection of similar events. In this example, an event is an HTTP request to your website, and the dataset holds incoming data about all these HTTP requests.
16+
17+
[Run in Playground](https://play.axiom.co/axiom-play-qf1k/datasets/sample-http-logs)
18+
19+
## 2. Display stream of incoming data
20+
21+
1. Click the **Stream** tab at the top of the page.
22+
1. Click **sample-http-logs** in the list.
23+
24+
You see the data that Axiom receives realtime. In this example, this page displays the HTTP requests to your imaginary website.
25+
26+
[Run in Playground](https://play.axiom.co/axiom-play-qf1k/stream/sample-http-logs)
27+
28+
## 3. Analyze data
29+
30+
### Query data
31+
32+
1. Click the **Query** tab at the top of the page, and then click **Builder** in the top left. This enables you to query your data with a visual query builder.
33+
1. In the **Dataset** section, select **sample-http-logs** from the list of datasets.
34+
1. In the **Where** section, click **+**.
35+
1. Write **status == "500"**, and then press **Enter**.
36+
1. Click **Run**.
37+
38+
You see all the HTTP requests with the status 500. This is important to know because this status indicates an internal server error, meaning that the server has encountered a situation that it can’t handle.
39+
40+
[Run in Playground](https://play.axiom.co/axiom-play-qf1k/query?initForm=%7B%22apl%22%3A%22%5B'sample-http-logs'%5D%20%7C%20where%20status%20%3D%3D%20'500'%22%7D)
41+
42+
### Run an APL query
43+
44+
1. Click the **Query** tab at the top of the page, and then click **APL** in the top left. This enables you to query your data with the Axiom Processing Language (APL). For more information, see [Introduction to APL](/apl/introduction).
45+
1. In the text field, enter the following:
46+
```kusto
47+
['sample-http-logs']
48+
| summarize count() by bin_auto(_time), status
49+
```
50+
1. Click **Run**.
51+
52+
You see the number of HTTP requests of each status over time.
53+
54+
[Run in Playground](https://play.axiom.co/axiom-play-qf1k/query?initForm=%7B%22apl%22%3A%22%5B'sample-http-logs'%5D%20%7C%20summarize%20count()%20by%20bin_auto(_time)%2C%20status%22%7D)
55+
56+
## 4. Visualize data
57+
58+
1. Click the **Dashboards** tab at the top of the page.
59+
1. Click **HTTP logs** in the list.
60+
61+
You see a dashboard that displays important information about the HTTP requests to the website.
62+
63+
## What’s next
64+
65+
To try out Axiom with sample data, see [Quickstart using sample data](/getting-started-guide/quickstart-using-sample-data).
66+
67+
To check out Axiom with a sample app, see [Get started with example app](/getting-started-guide/get-started-example-app).

‎getting-started-guide/get-started-example-app.mdx

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: 'Get started with example apps'
3+
excerpt: 'This page explains how to try out Axiom with an example app.'
4+
sidebarTitle: Example apps
5+
---
6+
7+
This page explains how to try out Axiom with an example app that emits OpenTelemetry (OTel) trace data. There are many other ways you can send data to Axiom. For a full list, see [Send data](/send-data/ingest).
8+
9+
Choose one of the following example apps:
10+
11+
<CardGroup cols={2}>
12+
<Card
13+
title=".NET"
14+
href="/guides/opentelemetry-dotnet"
15+
>
16+
</Card>
17+
18+
<Card
19+
title="Django"
20+
href="/guides/opentelemetry-django"
21+
>
22+
</Card>
23+
24+
<Card
25+
title="Golang"
26+
href="/guides/opentelemetry-go"
27+
>
28+
</Card>
29+
30+
<Card
31+
title="Java"
32+
href="/guides/opentelemetry-java"
33+
>
34+
</Card>
35+
36+
<Card
37+
title="Next.js"
38+
href="/guides/opentelemetry-nextjs"
39+
>
40+
</Card>
41+
42+
<Card
43+
title="Node.js"
44+
href="/guides/opentelemetry-nodejs"
45+
>
46+
</Card>
47+
48+
<Card
49+
title="Python"
50+
href="/guides/opentelemetry-python"
51+
>
52+
</Card>
53+
54+
<Card
55+
title="Ruby on Rails"
56+
href="/guides/opentelemetry-ruby"
57+
>
58+
</Card>
59+
</CardGroup>
60+
61+
To try out Axiom without registration, see [Explore Axiom Playground](/getting-started-guide/explore-axiom-playground).
62+
63+
To try out Axiom with sample data, see [Quickstart using sample data](/getting-started-guide/quickstart-using-sample-data).

‎getting-started-guide/getting-started.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ tags:
1010
<img src="/doc-assets/intro.png" alt="Axiom user interface" />
1111
</Frame>
1212

13+
Axiom enables you to make the most of your event data without compromises: all your data, all the time, for all possible needs. Say goodbye to data sampling, waiting times, and hefty fees.
14+
15+
This page explains how to start using Axiom and leverage the power of event data in your organization.
16+
1317
## 1. Send your data to Axiom
1418

1519
You can send data to Axiom in a variety of ways. Each individual piece of data is an event.
@@ -97,3 +101,10 @@ As your use of Axiom widens, customize it for your organization’s needs. For e
97101
- Create and manage API tokens.
98102

99103
<Card title="Customize your organization" icon="gear" href="/reference/settings" horizontal></Card>
104+
105+
## What’s next
106+
107+
Choose one of the following learning pathways:
108+
109+
- [Try out Axiom](/getting-started-guide/try-out-axiom) for a more hands-on experience that allows you to explore Axiom and quickly leverage the power of your event data.
110+
- [Learn about Axiom](/getting-started-guide/learn-about-axiom) for a more educational experience that explains the most important concepts and ideas behind Axiom and how your organization can benefit from Axiom’s offering.

‎getting-started-guide/learn-about-axiom.mdx

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: 'Learn about Axiom'
3+
excerpt: 'This section offers a conceptual understanding of Axiom and its offering.'
4+
sidebarTitle: Overview
5+
---
6+
7+
The following pages offer an educational experience that explains the most important concepts and ideas behind Axiom and how your organization can benefit from Axiom’s offering:
8+
9+
<Card
10+
title="Event data"
11+
href="/getting-started-guide/event-data"
12+
>
13+
Learn about the fundamentals of timestamped event data in Axiom
14+
</Card>
15+
16+
<Card
17+
title="Axiom for observability"
18+
href="/getting-started-guide/observability"
19+
>
20+
Learn about how Axiom helps you leverage timestamped event data for observability purposes
21+
</Card>
22+
23+
<Card
24+
title="Glossary"
25+
href="/getting-started-guide/glossary"
26+
>
27+
Learn about the key concepts in Axiom
28+
</Card>
29+
30+
For a more hands-on experience that allows you to explore Axiom and quickly leverage the power of your event data, see [Try out Axiom](/getting-started-guide/try-out-axiom).

‎getting-started-guide/quickstart-using-sample-data.mdx

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
---
2+
title: 'Quickstart using sample data'
3+
excerpt: 'This page explains how to try out Axiom with sample data.'
4+
sidebarTitle: Sample data
5+
---
6+
7+
This page explains how to try out Axiom with sample data. It walks you through an example where you want to keep track of OpenTelemetry (OTel) traces with Axiom.
8+
9+
By following this page, you will:
10+
11+
1. Explore the structure of sample data.
12+
1. Display a stream of incoming data.
13+
1. Analyze the data.
14+
1. Visualize the data by creating a simple dashboard.
15+
1. Set up a monitor that alerts you about internal server errors.
16+
17+
To try out Axiom without registration, see [Explore Axiom Playground](/getting-started-guide/explore-axiom-playground).
18+
19+
## 1. Explore sample data
20+
21+
1. [Sign up for an Axiom account](https://app.axiom.co/register). All you need is an email address.
22+
1. Click the **Datasets** tab at the top of the page.
23+
1. In the list of datasets, click `otel-demo-traces`.
24+
25+
This displays the fields in the sample dataset `otel-demo-traces`.
26+
27+
## 2. Display stream of incoming data
28+
29+
1. Click the **Stream** tab at the top of the page.
30+
1. Click **otel-demo-traces** in the list.
31+
32+
You see the data that Axiom receives realtime.
33+
34+
## 3. Analyze data
35+
36+
### Query data
37+
38+
1. Click the **Query** tab at the top of the page, and then click **Builder** in the top left. This enables you to query your data with a visual query builder.
39+
1. In the **Dataset** section, select **otel-demo-traces** from the list of datasets.
40+
1. In the **Where** section, click **+**.
41+
1. Write **service.name == frontend**, and then press **Enter**.
42+
1. Click **Run**.
43+
44+
You see all the traces for the Frontend service.
45+
46+
### Run an APL query
47+
48+
1. Click the **Query** tab at the top of the page, and then click **APL** in the top left. This enables you to query your data with the Axiom Processing Language (APL). For more information, see [Introduction to APL](/apl/introduction).
49+
1. In the text field, enter the following:
50+
```kusto
51+
['otel-demo-traces']
52+
| where duration > 5ms
53+
| summarize count() by bin_auto(_time), ['service.name']
54+
```
55+
1. Click **Run**.
56+
57+
You see the number of requests taking longer than 5 ms for each service over time.
58+
59+
## 4. Visualize data
60+
61+
1. Click the **Dashboards** tab at the top of the page.
62+
1. Click **OpenTelemetry Traces (otel-demo-traces)** in the list.
63+
64+
You see a dashboard that displays important information about the OTel traces.
65+
66+
## 5. Create new dashboard
67+
68+
1. Click the **Dashboards** tab at the top of the page, and then click **New dashboard** on the right.
69+
1. Name the dashboard and click **Create**.
70+
1. Click **Add a chart**, and then click **Timeseries**.
71+
1. In the **Dataset** section, select **otel-demo-traces**.
72+
1. In the **Summarize** section, click **no group** to the right of **by**, and then select **service.name**.
73+
1. Click **Save**.
74+
75+
You created a simple dashboard that displays the number of requests for each service over time.
76+
77+
## 6. Monitor data for issues
78+
79+
### Create notifier
80+
81+
1. Click the **Monitors** tab at the top of the page.
82+
1. In the top left, click **Notifiers**, and then click **New notifier** on the top right.
83+
1. In **Name**, enter **Slow requests notifier**.
84+
1. In **Users**, enter your email address, and then click **+** on the right.
85+
1. Click **Create**.
86+
87+
### Create monitor
88+
89+
1. In the top left, click **Monitors**, and then click **New monitor** on the top right.
90+
1. Click **Threshold monitor**.
91+
1. In **Check options**, enter `10000` as the value.
92+
1. Click **+ Add notifier**, and then select **Email: Slow requests notifier**.
93+
1. In the **APL** section, enter the following:
94+
```kusto
95+
['otel-demo-traces']
96+
| where duration > 5ms
97+
| summarize count() by bin(_time, 1m)
98+
```
99+
1. Click **Create**.
100+
101+
You created a monitor that automatically sends a notification to your email address if the number of requests taking longer than 5 ms is higher than 10,000 during a one minute period.
102+
103+
## What's next
104+
105+
To check out Axiom with a sample app, see [Get started with example app](/getting-started-guide/get-started-example-app).

‎getting-started-guide/try-out-axiom.mdx

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: 'Try out Axiom'
3+
excerpt: 'This section offers a hands-on experience of Axiom and its features.'
4+
sidebarTitle: Overview
5+
---
6+
7+
The following pages offer a hands-on experience that allows you to explore Axiom and quickly leverage the power of your event data:
8+
9+
<Card
10+
title="Explore Axiom Playground"
11+
href="/getting-started-guide/explore-axiom-playground"
12+
>
13+
Explore Axiom without registration
14+
</Card>
15+
16+
<Card
17+
title="Quickstart using sample data"
18+
href="/getting-started-guide/quickstart-using-sample-data"
19+
>
20+
Try out Axiom with sample data
21+
</Card>
22+
23+
<Card
24+
title="Get started with example app"
25+
href="/getting-started-guide/get-started-example-app"
26+
>
27+
Check out Axiom with a sample app
28+
</Card>
29+
30+
For a more educational experience that explains the most important concepts and ideas behind Axiom and how your organization can benefit from Axiom’s offering, see [Learn about Axiom](/getting-started-guide/learn-about-axiom).

0 commit comments

Comments
 (0)