Skip to content

Commit ed1765c

Browse files
committed
Update documentation
1 parent 6c4edc6 commit ed1765c

File tree

5 files changed

+16
-19
lines changed

5 files changed

+16
-19
lines changed

docs/observability/customization/custom-prometheus-configs.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Mount these files under `site/prometheus/scrape-configs/exporters/*.yml` in dock
1212

1313

1414
### Add Exporters to Prometheus
15-
- `prometheus/scrape-configs/exporters/` -
15+
- `prometheus/scrape-configs/exporters/`
1616
Add yaml files into this folder. These file should contain all exporter prometheus metrics, for example from node_exporter or CAdvisor. Add any hosts and ip addresses you want to collect /metrics from will be retrieved
1717

1818
```yaml
@@ -26,6 +26,9 @@ Mount these files under `site/prometheus/scrape-configs/exporters/*.yml` in dock
2626
# __metrics_path__: /path/metrics # Optionally override the metrics path, the default is just /metrics
2727
# ... add all targets
2828
```
29+
30+
Note that this project is setup to run Grafana Alloy to push metrics from individual VMs. The config in `prometheus/scrape-configs/exporters/` is an alternative way, allowing you to pull metrics from any other services.
31+
2932
## Custom Prometheus Scrape Configs
3033

3134
You can add compeltely custom prometheus scrape configs and recording rules by mounting in docker.

docs/observability/setup/production-setup.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Downloads the example docker compose files:
4444

4545
Downloads the configurations:
4646
- [alloy/probers/probe-external.yml](../../../observability/examples/full/alloy/probers/probe-external.yml)
47-
- [alloy/probers/probe-internal.yml ](../../../observability/examples/full/alloy/probers/probe-internal.yml)
47+
- [alloy/probers/probe-observability.yml ](../../../observability/examples/full/alloy/probers/probe-observability.yml)
4848
- [prometheus/scrape-configs/exporters/exporters.yml](../../../observability/examples/full/prometheus/scrape-configs/exporters/exporters.yml)
4949
- [prometheus/scrape-configs/recording-rules/slo.yml](../../../observability/examples/full/prometheus/scrape-configs/recording-rules/slo.yml)
5050

@@ -58,10 +58,9 @@ The files come with basic defaults, so we can now run the stack
5858

5959
```
6060
docker compose up -d
61-
docker compose -f exporters.docker-compose.yml up -d
6261
```
6362

64-
This will launch Prometheus, Grafana, and all required services with
63+
This will launch Prometheus, Grafana, and Alloy
6564

6665

6766
## Step 4: Create Site-Specific Config Files
@@ -70,21 +69,21 @@ You must provide your own scrape and recording rules to tell Prometheus what to
7069
This is probably the hardest step: You will actually need to know what is running, and where it is! Building out these config files will give you that inventory, and give a real definition of what is running where.
7170

7271
- Probers: HTTP endpoints you want to monitor for availability
73-
- Add files in `scrape-configs/probers/*.yml`
72+
- Add files in `alloy/probers/*.yml`
7473
- [Configure Probers](./probing.md)
7574

76-
- Exporters: Targets like Elasticsearch or Docker
77-
- Add files in `scrape-configs/exporters/*.yml`
78-
- [Add Exporters](./telemetry.md)
79-
8075
- Recording Rules: Define uptime goals or custom aggregations
8176
- Add files in `recording-rules/*.yml`
8277
- [Enable Alerting](./alerting.md)
8378

84-
## Step 5: Run Exporters Everywhere
85-
The exporters need to be run on each VM that you want information from. It's a pull model, not push.
79+
## Step 5: Run Grafana Alloy on every VM
80+
The Grafana Alloy image needs to be run on each VM that you want to get information from.
8681

82+
Use the example docker compose file in [exporters.docker-compose.yml](../../../observability/examples/full/exporters.docker-compose.yml) which will start up alloy and get metrics
8783

84+
```
85+
docker compose -f exporters.docker-compose.yml up -d
86+
```
8887
---
8988

9089
## What’s Next?

observability/examples/full/full-quickstart.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ download_to() {
1010
curl -fsSL -o "$path" "$url"
1111
}
1212

13+
mkdir -p cogstack-observability/alloy/probers
1314
mkdir -p cogstack-observability/prometheus/scrape-configs/probers
1415
mkdir -p cogstack-observability/prometheus/scrape-configs/exporters
1516
mkdir -p cogstack-observability/prometheus/scrape-configs/recording-rules

observability/examples/simple/alloy/probers/probe-simple.yml

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

observability/examples/simple/quickstart.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ curl -fsSL -o docker-compose.yml \
99
https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/docker-compose.yml
1010

1111
echo "Downloading probe-simple.yml into alloy/probers/..."
12-
curl -fsSL -o probers/probe-simple.yml \
13-
https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/probers/probe-simple.yml
12+
curl -fsSL -o probers/probe-observability.yml \
13+
https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/probers/probe-observability.yml
1414

1515
echo "Setup complete in observability-simple/"
1616

0 commit comments

Comments
 (0)