Skip to content

Commit e980b56

Browse files
clayton-cornellclayton-cornell
committed
More updates to start building up content
1 parent f0bc13a commit e980b56

5 files changed

+156
-37
lines changed

‎docs/sources/tutorials/scenarios/monitor-docker-containers.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,14 @@ If you use {{< param "PRODUCT_NAME" >}} to collect the metrics and logs and forw
1414

1515
## Before you begin
1616

17-
* Install Docker
18-
* Install Git
17+
This example requires:
18+
19+
* Docker
20+
* Git
21+
22+
{{< admonition type="note" >}}
23+
The `docker` commands require administrator privileges.
24+
{{< /admonition >}}
1925

2026
## Clone the scenarios repository
2127

@@ -27,7 +33,7 @@ git clone https://github.com/grafana/alloy-scenarios.git
2733

2834
## Deploy the Grafana stack
2935

30-
Start Docker to deploy the monitoring stack.
36+
Start Docker to deploy the Grafana stack.
3137

3238
```shell
3339
cd alloy-scenarios/docker-monitoring
@@ -41,11 +47,7 @@ Open your browser and navigate to [`http://localhost:12345`](http://localhost:12
4147
With the Alloy UI, you can monitor the health of your Alloy deployment.
4248
Refer to [Debug Grafana Alloy](https://grafana.com/docs/alloy/latest/troubleshoot/debug/) for more information about the {{< param "PRODUCT_NAME" >}} UI.
4349

44-
<!--
45-
Add info about what the user can see in this view and a link to the relevant docs
46-
-->
47-
48-
## Access the Grafana UI
50+
## Use the Grafana UI
4951

5052
Open your browser and navigate to [`http://localhost:3000`](http://localhost:3000).
5153

‎docs/sources/tutorials/scenarios/monitor-logs-over-tcp.md

+73-5
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,15 @@ weight: 300
1010

1111
## Before you begin
1212

13+
This example requires:
14+
1315
* Docker
14-
* Docker compose
1516
* Git
1617

18+
{{< admonition type="note" >}}
19+
The `docker` commands require administrator privileges.
20+
{{< /admonition >}}
21+
1722
## Clone the repository
1823

1924
Clone the {{< param "PRODUCT_NAME" >}} scenarios repository.
@@ -22,19 +27,82 @@ Clone the {{< param "PRODUCT_NAME" >}} scenarios repository.
2227
git clone https://github.com/grafana/alloy-scenarios.git
2328
```
2429

25-
## Deploy the monitoring stack
30+
## Deploy the Grafana stack
2631

27-
Start Docker to deploy the monitoring stack.
32+
Start Docker to deploy the Grafana stack.
2833

2934
```shell
3035
cd alloy-scenarios/logs-tcp
3136
docker compose up -d
3237
```
3338

34-
## Access the {{% param "PRODUCT_NAME" %}} UI
39+
## View the {{% param "PRODUCT_NAME" %}} UI
3540

3641
Open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
3742

38-
## Access the Grafana UI
43+
With the Alloy UI, you can monitor the health of your Alloy deployment.
44+
Refer to [Debug Grafana Alloy](https://grafana.com/docs/alloy/latest/troubleshoot/debug/) for more information about the {{< param "PRODUCT_NAME" >}} UI.
45+
46+
## Use the Grafana UI
3947

4048
Open your browser and navigate to [`http://localhost:3000`](http://localhost:3000).
49+
50+
With the Grafana UI, you can create your own dashboards to create queries and visualize any aspect of your Docker container metrics and logs.
51+
Refer to [Build your first dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) for detailed information about dashboards in Grafana.
52+
53+
## Shut down the Grafana stack
54+
55+
Stop Docker to shut down the Grafana stack.
56+
57+
```shell
58+
docker compose down
59+
```
60+
61+
## Understand the {{% param "PRODUCT_NAME" %}} configuration
62+
63+
```alloy
64+
livedebugging {
65+
enabled = true
66+
}
67+
68+
loki.source.api "loki_push_api" {
69+
http {
70+
listen_address = "0.0.0.0"
71+
listen_port = 9999
72+
}
73+
forward_to = [
74+
loki.process.lables.receiver,
75+
]
76+
}
77+
78+
loki.process "lables" {
79+
stage.json {
80+
expressions = { "extracted_service" = "service_name",
81+
"extracted_code_line" = "code_line",
82+
"extracted_server" = "server_id",
83+
}
84+
}
85+
86+
stage.labels {
87+
values = {
88+
"service_name" = "extracted_service",
89+
}
90+
}
91+
92+
stage.structured_metadata {
93+
values = {
94+
"code_line" = "extracted_code_line",
95+
"server" = "extracted_server",
96+
}
97+
}
98+
99+
forward_to = [loki.write.local.receiver]
100+
101+
}
102+
103+
loki.write "local" {
104+
endpoint {
105+
url = "http://loki:3100/loki/api/v1/push"
106+
}
107+
}
108+
```

‎docs/sources/tutorials/scenarios/monitor-syslog-messages.md

+26-5
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,15 @@ weight: 500
1010

1111
## Before you begin
1212

13+
This example requires
14+
1315
* Docker
14-
* Docker compose
1516
* Git
1617

18+
{{< admonition type="note" >}}
19+
The `docker` commands require administrator privileges.
20+
{{< /admonition >}}
21+
1722
## Clone the repository
1823

1924
Clone the {{< param "PRODUCT_NAME" >}} scenarios repository.
@@ -22,19 +27,35 @@ Clone the {{< param "PRODUCT_NAME" >}} scenarios repository.
2227
git clone https://github.com/grafana/alloy-scenarios.git
2328
```
2429

25-
## Deploy the monitoring stack
30+
## Deploy the Grafana stack
2631

27-
Start Docker to deploy the monitoring stack.
32+
Start Docker to deploy the Grafana stack.
2833

2934
```shell
3035
cd alloy-scenarios/syslog
3136
docker compose up -d
3237
```
3338

34-
## Access the {{% param "PRODUCT_NAME" %}} UI
39+
## View the {{% param "PRODUCT_NAME" %}} UI
3540

3641
Open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
3742

38-
## Access the Grafana UI
43+
With the Alloy UI, you can monitor the health of your Alloy deployment.
44+
Refer to [Debug Grafana Alloy](https://grafana.com/docs/alloy/latest/troubleshoot/debug/) for more information about the {{< param "PRODUCT_NAME" >}} UI.
45+
46+
## Use the Grafana UI
3947

4048
Open your browser and navigate to [`http://localhost:3000`](http://localhost:3000).
49+
50+
With the Grafana UI, you can create your own dashboards to create queries and visualize any aspect of your Docker container metrics and logs.
51+
Refer to [Build your first dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) for detailed information about dashboards in Grafana.
52+
53+
## Shut down the Grafana stack
54+
55+
Stop Docker to shut down the Grafana stack.
56+
57+
```shell
58+
docker compose down
59+
```
60+
61+
## Understand the {{% param "PRODUCT_NAME" %}} configuration

‎docs/sources/tutorials/scenarios/monitor-windows.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,16 @@ This scenario shows you how to install {{< param "PRODUCT_NAME" >}} in Windows a
1616

1717
## Before you begin
1818

19-
* Git - The scenario is in a Git repository.
20-
* Docker - You use Docker desktop for Windows for this scenario.
21-
This is where Grafana, Loki and Prometheus are hosted.
22-
You can also install native Windows versions of Grafana, Loki and Prometheus, or you can host them on a Linux server.
23-
* Windows Server or Desktop - This scenario monitors a computer running Windows.
24-
* Windows administrator access - You use administrator access to install {{< param "PRODUCT_NAME" >}} and configure it to collect metrics and logs.
19+
This example requires:
20+
21+
* Docker
22+
* Git
23+
* Windows Server or Desktop. This scenario monitors a computer running Windows.
24+
* Windows administrator access. You use administrator access to install {{< param "PRODUCT_NAME" >}} and configure it to collect metrics and logs.
25+
26+
{{< admonition type="note" >}}
27+
The `docker` commands require administrator privileges.
28+
{{< /admonition >}}
2529

2630
## Clone the repository
2731

@@ -31,10 +35,9 @@ Clone the {{< param "PRODUCT_NAME" >}} scenarios repository.
3135
git clone https://github.com/grafana/alloy-scenarios.git
3236
```
3337

34-
## Deploy Grafana, Loki and Prometheus
38+
## Deploy the Grafana stack
3539

36-
First, you need to deploy Grafana, Loki and Prometheus on your Windows machine.
37-
Within this tutorial, we have included a docker-compose file that will deploy Grafana, Loki and Prometheus on your Windows machine.
40+
Start Docker to deploy the Grafana stack.
3841

3942
```shell
4043
cd alloy-scenarios/windows
@@ -47,8 +50,6 @@ You can check the status of the containers by running the following command:
4750
docker ps
4851
```
4952

50-
Grafana should be running on [http://localhost:3000](http://localhost:3000).
51-
5253
## Install {{% param "PRODUCT_NAME" %}}
5354

5455
Follow the instructions in the [Grafana Alloy documentation](https://grafana.com/docs/alloy/latest/set-up/install/windows/) to install Grafana Alloy on your Windows machine.

‎docs/sources/tutorials/scenarios/parse-structured-logs.md

+35-8
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,23 @@
22
canonical: https://grafana.com/docs/alloy/latest/tutorials/scenarios/monitor-tcp-logs/
33
description: Learn how to use Grafana Alloy to parse structured logs
44
menuTitle: Parse structured logs
5-
title: Parse structured logs
5+
title: Parse structured logs with Grafan Alloy
66
weight: 600
77
---
88

99
# Parse structured logs with {{% param "FULL_PRODUCT_NAME" %}}
1010

1111
## Before you begin
1212

13+
This example requires:
14+
1315
* Docker
14-
* Docker compose
1516
* Git
1617

18+
{{< admonition type="note" >}}
19+
The `docker` commands require administrator privileges.
20+
{{< /admonition >}}
21+
1722
## Clone the repository
1823

1924
Clone the {{< param "PRODUCT_NAME" >}} scenarios repository.
@@ -22,19 +27,41 @@ Clone the {{< param "PRODUCT_NAME" >}} scenarios repository.
2227
git clone https://github.com/grafana/alloy-scenarios.git
2328
```
2429

25-
## Deploy the monitoring stack
30+
## Deploy the Grafana stack
2631

27-
Start Docker to deploy the monitoring stack.
32+
Start Docker to deploy the Grafana stack.
2833

2934
```shell
3035
cd alloy-scenarios/mail-house
3136
docker compose up -d
3237
```
3338

34-
## Access the {{% param "PRODUCT_NAME" %}} UI
39+
You can check the status of the containers by running the following command:
40+
41+
```shell
42+
docker ps
43+
```
44+
45+
## View the {{% param "PRODUCT_NAME" %}} UI
46+
47+
Open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
3548

36-
Open your browser and navigate to [`http://localhost:12345`][http://localhost:12345].
49+
With the Alloy UI, you can monitor the health of your Alloy deployment.
50+
Refer to [Debug Grafana Alloy](https://grafana.com/docs/alloy/latest/troubleshoot/debug/) for more information about the {{< param "PRODUCT_NAME" >}} UI.
3751

38-
## Access the Grafana UI
52+
## Use the Grafana UI
53+
54+
Open your browser and navigate to [`http://localhost:3000`](http://localhost:3000).
55+
56+
With the Grafana UI, you can create your own dashboards to create queries and visualize any aspect of your Docker container metrics and logs.
57+
Refer to [Build your first dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) for detailed information about dashboards in Grafana.
58+
59+
## Shut down the Grafana stack
60+
61+
Stop Docker to shut down the Grafana stack.
62+
63+
```shell
64+
docker compose down
65+
```
3966

40-
Open your browser and navigate to [`http://localhost:3000`][http://localhost:3000].
67+
## Understand the {{% param "PRODUCT_NAME" %}} configuration

0 commit comments

Comments
 (0)