Skip to content

Commit 701bb38

Browse files
Make layout more consistent
1 parent 97d7e8d commit 701bb38

6 files changed

+80
-50
lines changed

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,19 @@ cd alloy-scenarios/docker-monitoring
4040
docker compose up -d
4141
```
4242

43-
You can check the status of the containers by running the following command:
43+
You can check the status of the Docker containers by running the following command.
4444

4545
```shell
4646
docker ps
4747
```
4848

49-
## View the {{% param "PRODUCT_NAME" %}} UI
49+
## Monitor the health of your {{% param "PRODUCT_NAME" %}} deployment
5050

5151
To monitor the health of your {{< param "PRODUCT_NAME" >}} deployment, open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
5252

5353
Refer to [Debug Grafana Alloy](https://grafana.com/docs/alloy/latest/troubleshoot/debug/) for more information about the {{< param "PRODUCT_NAME" >}} UI.
5454

55-
## Use the Grafana UI
55+
## Visualise your data
5656

5757
To create a [dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) to visualise your metrics and logs, open your browser and navigate to [`http://localhost:3000/dashboards`](http://localhost:3000/dashboards).
5858

docs/sources/tutorials/scenarios/monitor-kubernetes-logs.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,27 @@ Loki is used to store the logs, Grafana is used to visualize the logs, and {{< p
2222

2323
## Before you begin
2424

25-
* Git - You will need Git to clone the repository.
26-
* Docker - In this tutorial you use Docker containers to host the Grafana stack.
25+
This example requires:
26+
27+
* Docker
28+
* Git
2729

2830
## Clone the repository
2931

3032
```shell
3133
git clone https://github.com/grafana/alloy-scenarios.git
3234
```
3335

36+
## Deploy
37+
3438
Change to the directory:
3539

3640
```bash
3741
cd alloy-scenarios/k8s-logs
3842
```
3943

40-
Next you will need a Kubernetes cluster.
44+
## Create a local Kubernetes cluster
45+
4146
In this example, we will configure a local Kubernetes cluster using [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/).
4247

4348
An example kind cluster configuration is provided in the `kind.yml` file.
@@ -47,7 +52,8 @@ To create a kind cluster using this configuration, run the following command:
4752
kind create cluster --config kind.yml
4853
```
4954

50-
You will need to make sure you install Helm on your local machine.
55+
## Install Helm
56+
5157
You can install Helm by following the instructions [here](https://helm.sh/docs/intro/install/).
5258
You will also need to install the Grafana Helm repository:
5359

@@ -155,3 +161,7 @@ helm install tempo grafana/tempo-distributed -n prod
155161
```
156162

157163
This will install the Tempo distributed tracing system in the `prod` namespace.
164+
165+
## Understand the {{% param "PRODUCT_NAME" %}} configuration
166+
167+

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

+13-7
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,25 @@ cd alloy-scenarios/logs-tcp
3636
docker compose up -d
3737
```
3838

39-
## View the {{% param "PRODUCT_NAME" %}} UI
39+
You can check the status of the Docker containers by running the following command.
4040

41-
Open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
41+
```shell
42+
docker ps
43+
```
44+
45+
## Monitor the health of your {{% param "PRODUCT_NAME" %}} deployment
46+
47+
To monitor the health of your {{< param "PRODUCT_NAME" >}} deployment, open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
4248

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

46-
## Use the Grafana UI
51+
## Visualise your data
52+
53+
To create a [dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) to visualise your metrics and logs, open your browser and navigate to [`http://localhost:3000/dashboards`](http://localhost:3000/dashboards).
4754

48-
Open your browser and navigate to [`http://localhost:3000`](http://localhost:3000).
55+
To explore metrics, open your browser and navigate to [http://localhost:3000/explore/metrics](http://localhost:3000/explore/metrics).
4956

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.
57+
To use the Grafana Logs Drilldown, open your browser and navigate to [http://localhost:3000/a/grafana-lokiexplore-app](http://localhost:3000/a/grafana-lokiexplore-app).
5258

5359
## Shut down the Grafana stack
5460

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

+13-7
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,25 @@ cd alloy-scenarios/syslog
3636
docker compose up -d
3737
```
3838

39-
## View the {{% param "PRODUCT_NAME" %}} UI
39+
You can check the status of the Docker containers by running the following command.
4040

41-
Open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
41+
```shell
42+
docker ps
43+
```
44+
45+
## Monitor the health of your {{% param "PRODUCT_NAME" %}} deployment
46+
47+
To monitor the health of your {{< param "PRODUCT_NAME" >}} deployment, open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
4248

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

46-
## Use the Grafana UI
51+
## Visualise your data
52+
53+
To create a [dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) to visualise your metrics and logs, open your browser and navigate to [`http://localhost:3000/dashboards`](http://localhost:3000/dashboards).
4754

48-
Open your browser and navigate to [`http://localhost:3000`](http://localhost:3000).
55+
To explore metrics, open your browser and navigate to [http://localhost:3000/explore/metrics](http://localhost:3000/explore/metrics).
4956

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.
57+
To use the Grafana Logs Drilldown, open your browser and navigate to [http://localhost:3000/a/grafana-lokiexplore-app](http://localhost:3000/a/grafana-lokiexplore-app).
5258

5359
## Shut down the Grafana stack
5460

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

+30-22
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight: 400
99
# Monitor Microsoft Windows servers and desktops with {{% param "FULL_PRODUCT_NAME" %}}
1010

1111
You can use {{< param "FULL_PRODUCT_NAME" >}} to monitor Microsoft Windows servers and desktops.
12-
This scenario shows you how to install {{< param "PRODUCT_NAME" >}} in Windows and how to configure {{< param "PRODUCT_NAME" >}} to monitor the following system attributes:
12+
This example shows you how to install {{< param "PRODUCT_NAME" >}} in Windows and configure {{< param "PRODUCT_NAME" >}} to monitor the following system attributes:
1313

1414
* Windows performance metrics
1515
* Windows event logs
@@ -50,23 +50,27 @@ You can check the status of the containers by running the following command:
5050
docker ps
5151
```
5252

53-
## Install {{% param "PRODUCT_NAME" %}}
53+
## Install {{% param "PRODUCT_NAME" %}} in Windows
5454

55-
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.
55+
Follow the instructions in the [Grafana Alloy documentation](https://grafana.com/docs/alloy/latest/set-up/install/windows/) to install {{< param "PRODUCT_NAME" >}} on your Windows machine.
5656

5757
Recommended steps:
5858

59-
* Install Grafana Alloy as a Windows service.
60-
* Use Windows Installer to install Grafana Alloy.
59+
* Install {{< param "PRODUCT_NAME" >}} as a Windows service.
60+
* Use Windows Installer to install {{< param "PRODUCT_NAME" >}}.
6161

6262
Make sure to also checkout the [Grafana Alloy configuration](https://grafana.com/docs/alloy/latest/set-up/configuration/) documentation.
6363

64-
Personal recommendation: If you would like to see the Alloy UI from a remote machine you need to change the run arguments of the Grafana Alloy service. To do this:
64+
### Configure remote access to the {{% param "PRODUCT_NAME" %}} UI
65+
66+
If you would like access the {{< param "PRODUCT_NAME" >}} UI from a remote machine you must change the runtime arguments of the {{< param "PRODUCT_NAME" >}} service.
67+
68+
To configure the runtime arguments:
6569

6670
1. Open Registry Editor.
67-
2. Navigate to `HKEY_LOCAL_MACHINE\SOFTWARE\GrafanaLabs\Alloy`.
68-
3. Double click on `Arguments`
69-
4. Change the contents to the following:
71+
1. Navigate to `HKEY_LOCAL_MACHINE\SOFTWARE\GrafanaLabs\Alloy`.
72+
1. Double click on `Arguments`
73+
1. Change the contents to the following:
7074

7175
```shell
7276
run
@@ -75,33 +79,37 @@ Personal recommendation: If you would like to see the Alloy UI from a remote mac
7579
--server.http.listen-addr=0.0.0.0:12345
7680
```
7781

78-
5. Restart the Grafana Alloy service.
82+
1. Restart the {{< param "PRODUCT_NAME" >}} service.
7983
Search for `Services` in the start menu, find `Grafana Alloy`, right click and restart.
8084

81-
You should be able to access the Alloy UI from a remote machine by going to `http://<windows-machine-ip>:12345`.
85+
You should be able to access the {{< param "PRODUCT_NAME" >}} UI from a remote machine by going to `http://<windows-machine-ip>:12345`.
8286

83-
## Configure {{% param "PRODUCT_NAME" %}} to Monitor Windows
87+
## Configure {{% param "PRODUCT_NAME" %}} to monitor Windows
8488

8589
Now that you have Grafana Alloy installed, you need to configure it to monitor your Windows machine.
8690
Grafana Alloy will currently be running a default configuration file.
8791
This needs to be replaced with the `config.alloy` file that is included in the `alloy-scenarios/windows` directory.
8892
To do this:
8993

90-
1. Stop the Grafana Alloy service.
94+
1. Stop the {{< param "PRODUCT_NAME" >}} service.
9195
1. Replace the `config.alloy` file in `C:\Program Files\GrafanaLabs\Alloy` with the `config.alloy` file from the `alloy-scenarios/windows` directory.
92-
1. Start the Grafana Alloy service.
93-
1. Open your browser and go to `http://localhost:12345` to access the Alloy UI.
96+
1. Start the {{< param "PRODUCT_NAME" >}} service.
97+
98+
## Monitor the health of your {{% param "PRODUCT_NAME" %}} deployment
9499

95-
## View the Windows Performance Metrics and Event Logs
100+
To monitor the health of your {{< param "PRODUCT_NAME" >}} deployment, open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
96101

97-
You will now be able to view the Windows Performance Metrics and Event Logs in Grafana:
102+
Refer to [Debug Grafana Alloy](https://grafana.com/docs/alloy/latest/troubleshoot/debug/) for more information about the {{< param "PRODUCT_NAME" >}} UI.
98103

99-
* Open your browser and go to [http://localhost:3000/explore/metrics](http://localhost:3000/explore/metrics).
100-
This will take you to the metrics explorer in Grafana.
104+
## Visualise your data
101105

102-
* Open your browser and go to [http://localhost:3000/a/grafana-lokiexplore-app](http://localhost:3000/a/grafana-lokiexplore-app).
103-
This will take you to the Loki explorer in Grafana.
106+
To create a [dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) to visualise your metrics and logs, open your browser and navigate to [`http://localhost:3000/dashboards`](http://localhost:3000/dashboards).
104107

108+
To explore metrics, open your browser and navigate to [http://localhost:3000/explore/metrics](http://localhost:3000/explore/metrics).
109+
110+
To use the Grafana Logs Drilldown, open your browser and navigate to [http://localhost:3000/a/grafana-lokiexplore-app](http://localhost:3000/a/grafana-lokiexplore-app).
111+
112+
## Understand the {{% param "PRODUCT_NAME" %}} configuration
105113

106114
```alloy
107115
// ####################################
@@ -191,4 +199,4 @@ loki.write "endpoint" {
191199
}
192200
193201
livedebugging{}
194-
```
202+
```

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,19 @@ You can check the status of the containers by running the following command:
4242
docker ps
4343
```
4444

45-
## View the {{% param "PRODUCT_NAME" %}} UI
45+
## Monitor the health of your {{% param "PRODUCT_NAME" %}} deployment
4646

47-
Open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
47+
To monitor the health of your {{< param "PRODUCT_NAME" >}} deployment, open your browser and navigate to [`http://localhost:12345`](http://localhost:12345).
4848

49-
With the Alloy UI, you can monitor the health of your Alloy deployment.
5049
Refer to [Debug Grafana Alloy](https://grafana.com/docs/alloy/latest/troubleshoot/debug/) for more information about the {{< param "PRODUCT_NAME" >}} UI.
5150

52-
## Use the Grafana UI
51+
## Visualise your data
5352

54-
Open your browser and navigate to [`http://localhost:3000`](http://localhost:3000).
53+
To create a [dashboard](https://grafana.com/docs/grafana/latest/getting-started/build-first-dashboard/#create-a-dashboard) to visualise your metrics and logs, open your browser and navigate to [`http://localhost:3000/dashboards`](http://localhost:3000/dashboards).
5554

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.
55+
To explore metrics, open your browser and navigate to [http://localhost:3000/explore/metrics](http://localhost:3000/explore/metrics).
56+
57+
To use the Grafana Logs Drilldown, open your browser and navigate to [http://localhost:3000/a/grafana-lokiexplore-app](http://localhost:3000/a/grafana-lokiexplore-app).
5858

5959
## Shut down the Grafana stack
6060

0 commit comments

Comments
 (0)