@@ -7,31 +7,13 @@ If you're new, we recommend completing the [Quickstart Tutorial](../get-started/
77By the end of the tutorial, you will have a complete stack offering all the observability features, customized to your usage.
88
99We will run the stack and then:
10- - Configure * Telemetry* like VM memory usage, and Elasticsearch index size, by running Exporters
11- - Enable * Alerting* based on our availability and a defined Service Level Objective (SLO)
1210- Setup further * Probing* of our running services to get availability metrics
13-
11+ - Configure * Telemetry* like VM memory usage, and Elasticsearch index size, by running Grafana Alloy
12+ - Enable * Alerting* based on our availability and a defined Service Level Objective (SLO)
1413
1514---
1615
17- ## Step 1: Understand the Folder Structure
18-
19- Your project configuration should follow this structure:
20-
21- ```
22- observability.docker-compose.yml
23- exporters.docker-compose.yml
24- alloy/
25- probers/ # HTTP endpoints to check availability
26- blackbox-exporter/ # (Optional) Custom Probe configuration
27- prometheus/
28- scrape-configs/
29- exporters/ # Targets that expose metrics (e.g. Elasticsearch, Docker, VMs)
30- recording-rules/ # Prometheus recording rules (e.g. for SLOs, summaries)
31- grafana/ # (Optional) Custom Grafana dashboards and config
32- ```
33-
34- ## Step 2: Initialise the project
16+ ## Step 1: Initialise the project
3517
3618Run:
3719``` bash
@@ -56,18 +38,36 @@ Downloads the configurations:
5638
5739
5840
59- Inspect the results in your local directory, and see that it matches the folder layout defined in step 1.
41+ ## Step 2: Understand the Folder structure
42+
43+ Your project configuration will be created with follow this structure:
44+
45+ ```
46+ observability.docker-compose.yml
47+ exporters.docker-compose.yml
48+ alloy/
49+ probers/ # HTTP endpoints to check availability
50+ blackbox-exporter/ # (Optional) Custom Probe configurations like auth details
51+ prometheus/
52+ scrape-configs/
53+ exporters/ # Targets that expose metrics (e.g. Elasticsearch, Docker, VMs)
54+ recording-rules/ # Prometheus recording rules (e.g. for SLOs, summaries)
55+ grafana/ # (Optional) Custom Grafana dashboards and config
56+ ```
57+
58+ Inspect the results of the script and see that it matches this layout
59+
6060
6161## Step 3: Run the Stack
6262The files come with basic defaults, so we can now run the stack
6363
64-
6564 ```
6665 docker compose up -d
6766 ```
6867
6968This will launch Prometheus, Grafana, and Alloy
7069
70+ Navigate to the dashboard urls on ` http://localhost/grafana ` to view the dashboards.
7171
7272
7373## Step 4: Create Site-Specific Config Files
0 commit comments