Skip to content

Commit f8ceeb1

Browse files
committed
Add test for documentation examples
1 parent 9fff2b2 commit f8ceeb1

4 files changed

Lines changed: 26 additions & 91 deletions

File tree

.github/workflows/observability-docker.yml

Lines changed: 3 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -89,29 +89,14 @@ jobs:
8989
- name: Run Simple quickstart test
9090
run: |
9191
echo "🧪 Running Simple quickstart test..."
92-
bash observability/test/test-quickstart-simple.sh
92+
bash observability/test/test-quickstart.sh
9393
9494
- name: Report test result
9595
if: always()
9696
run: |
9797
if [ $? -eq 0 ]; then
98-
echo "✅ Full quickstart test PASSED"
98+
echo "✅ quickstart test PASSED"
9999
else
100-
echo "❌ Full quickstart test FAILED"
100+
echo "❌ quickstart test FAILED"
101101
exit 1
102102
fi
103-
104-
- name: Run full quickstart test
105-
run: |
106-
echo "🧪 Running full quickstart test..."
107-
./observability/test/test-quickstart-full.sh
108-
109-
- name: Report test result
110-
if: always()
111-
run: |
112-
if [ $? -eq 0 ]; then
113-
echo "✅ Full quickstart test PASSED"
114-
else
115-
echo "❌ Full quickstart test FAILED"
116-
exit 1
117-

docs/observability/setup/production-setup.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,13 @@ If you're new, we recommend completing the [Quickstart Tutorial](../get-started/
77
By the end of the tutorial, you will have a complete stack offering all the observability features, customized to your usage.
88

99
We 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

3618
Run:
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
6262
The files come with basic defaults, so we can now run the stack
6363

64-
6564
```
6665
docker compose up -d
6766
```
6867

6968
This 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

observability/test/test-quickstart-full.sh

Lines changed: 0 additions & 25 deletions
This file was deleted.

observability/test/test-quickstart-simple.sh

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)