Skip to content

Commit bfd26e0

Browse files
committed
Use quickstart script to run it in one line
1 parent 776085b commit bfd26e0

File tree

3 files changed

+23
-13
lines changed

3 files changed

+23
-13
lines changed

observability/docs/get-started/quickstart.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,16 @@ After completing these steps, you will have a full observability stack running l
1212

1313
### Step 1: Download the sample files
1414

15-
Create a folder on your machine, then download these two files from GitHub into it:
15+
Run this quickstart script to setup the project
16+
```bash
17+
curl https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/quickstart.sh | bash
18+
```
1619

17-
- `docker-compose.yml`
18-
- `prometheus-config.yml`
20+
Alternatively, create this manually by downloading these two files from github, and creating the folder structure.
1921

20-
You can do this manually or by running:
22+
- [docker-compose.yml](https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/docker-compose.yml)
23+
- [prometheus/scrape-configs/probers/probe-simple.yml](https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/prometheus/scrape-configs/probers/probe-simple.yml)
2124

22-
```bash
23-
mkdir observability-stack
24-
cd observability-stack
25-
curl -O https://github.com/CogStack/cogstack-platform-toolkit/blob/main/observability/examples/simple/docker-compose.yml
26-
curl -O https://github.com/CogStack/cogstack-platform-toolkit/blob/main/observability/examples/simple/probe-simple.yml
27-
```
2825

2926
### Step 2: Start the stack
3027

@@ -46,7 +43,7 @@ There it is, you can now see the availability of the cogstack homepage, as well
4643
### Step 4: Probe your own web page
4744
Now you can look at getting monitoring on your own page.
4845

49-
In your current folder, edit the file `probe-simple.yml` that you downloaded from git.
46+
In your current folder, edit the file `prometheus/scrape-configs/probers/probe-simple.yml` that you downloaded from git.
5047

5148
Add the following yml to the bottom of the file:
5249

@@ -77,8 +74,6 @@ For the next steps we can:
7774
- Enable *Alerting* based on our availability and a defined Service Level Objective (SLO)
7875
- Look further into the available dashboards
7976
- Fully customize the stack with our own dashboards, recording rules and metrics
80-
-
81-
8277

8378

8479

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/bin/bash
2+
set -e
3+
4+
mkdir -p observability-stack/prometheus/scrape-configs/probers
5+
cd observability-stack
6+
7+
echo "Downloading docker-compose.yml..."
8+
curl -fsSL -o docker-compose.yml \
9+
https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/docker-compose.yml
10+
11+
echo "Downloading probe-simple.yml into prometheus/scrape-configs/probers/..."
12+
curl -fsSL -o prometheus/scrape-configs/probers/probe-simple.yml \
13+
https://raw.githubusercontent.com/CogStack/cogstack-platform-toolkit/main/observability/examples/simple/prometheus/scrape-configs/probers/probe-simple.yml
14+
15+
echo "Setup complete in observability-stack/"

0 commit comments

Comments
 (0)