Inline code instead of using gist within docs

promhippie · Jun 22, 2020 · 19a4b4a · 19a4b4a
1 parent 723dac1
commit 19a4b4a
Showing 1 changed file with 95 additions and 5 deletions.
diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md
@@ -11,23 +11,113 @@ We won't cover further details how to properly setup [Prometheus](https://promet
 
 First of all we need to prepare a configuration for [Prometheus](https://prometheus.io) that includes the service discovery which simply maps to a node exporter.
 
-{{< gist tboerger b9c39b6571f48ce2b132de1531061531 "prometheus.yml" >}}
+{{< highlight yaml >}}
+global:
+  scrape_interval: 1m
+  scrape_timeout: 10s
+  evaluation_interval: 1m
+
+scrape_configs:
+- job_name: node
+  file_sd_configs:
+  - files: [ "/etc/sd/hcloud.json" ]
+  relabel_configs:
+  - source_labels: [__meta_hcloud_public_ipv4]
+    replacement: "${1}:9100"
+    target_label: __address__
+  - source_labels: [__meta_hcloud_datacenter]
+    target_label: datacenter
+  - source_labels: [__meta_hcloud_name]
+    target_label: instance
+- job_name: hcloud-sd
+  static_configs:
+  - targets:
+    - hcloud-sd:9000
+{{< / highlight >}}
 
 After preparing the configuration we need to create the `docker-compose.yml` within the same folder, this `docker-compose.yml` starts a simple [Prometheus](https://prometheus.io) instance together with the service discovery. Don't forget to update the envrionment variables with the required credentials. If you are using a different volume for the service discovery you have to make sure that the container user is allowed to write to this volume.
 
-{{< gist tboerger b9c39b6571f48ce2b132de1531061531 "docker-compose.yml" >}}
+{{< highlight diff >}}
+version: '2'
+
+volumes:
+  prometheus:
+
+services:
+  prometheus:
+    image: prom/prometheus:v2.6.0
+    restart: always
+    ports:
+      - 9090:9090
+    volumes:
+      - prometheus:/prometheus
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml
+      - ./service-discovery:/etc/sd
+
+  hcloud-exporter:
+    image: promhippie/prometheus-hcloud-sd:latest
+    restart: always
+    environment:
+      - PROMETHEUS_HCLOUD_LOG_PRETTY=true
+      - PROMETHEUS_HCLOUD_OUTPUT_FILE=/etc/sd/hcloud.json
+      - PROMETHEUS_HCLOUD_TOKEN=uDgX6TkZVGx7c94jPAff5cfJdym9MLekiveDgN7Oq5dyOXxl4Uu9qkpcC1muILGW
+    volumes:
+      - ./service-discovery:/etc/sd
+{{< / highlight >}}
 
 Since our `latest` Docker tag always refers to the `master` branch of the Git repository you should always use some fixed version. You can see all available tags at our [DockerHub repository](https://hub.docker.com/r/promhippie/prometheus-hcloud-sd/tags/), there you will see that we also provide a manifest, you can easily start the exporter on various architectures without any change to the image name. You should apply a change like this to the `docker-compose.yml`:
 
-{{< gist tboerger b9c39b6571f48ce2b132de1531061531 "tag.diff" >}}
+{{< highlight diff >}}
+  hcloud-exporter:
+-   image: promhippie/prometheus-hcloud-sd:latest
++   image: promhippie/prometheus-hcloud-sd:0.2.0
+    restart: always
+    environment:
+      - PROMETHEUS_HCLOUD_LOG_PRETTY=true
+      - PROMETHEUS_HCLOUD_OUTPUT_FILE=/etc/sd/hcloud.json
+      - PROMETHEUS_HCLOUD_TOKEN=uDgX6TkZVGx7c94jPAff5cfJdym9MLekiveDgN7Oq5dyOXxl4Uu9qkpcC1muILGW
+    volumes:
+      - ./service-discovery:/etc/sd
+{{< / highlight >}}
 
 Depending on how you have launched and configured [Prometheus](https://prometheus.io) it's possible that it's running as user `nobody`, in that case you should run the service discovery as this user as well, otherwise [Prometheus](https://prometheus.io) won't be able to read the generated JSON file:
 
-{{< gist tboerger b9c39b6571f48ce2b132de1531061531 "userid.diff" >}}
+{{< highlight diff >}}
+  hcloud-exporter:
+    image: promhippie/prometheus-hcloud-sd:latest
+    restart: always
++   user: '65534'
+    environment:
+      - PROMETHEUS_HCLOUD_LOG_PRETTY=true
+      - PROMETHEUS_HCLOUD_OUTPUT_FILE=/etc/sd/hcloud.json
+      - PROMETHEUS_HCLOUD_TOKEN=uDgX6TkZVGx7c94jPAff5cfJdym9MLekiveDgN7Oq5dyOXxl4Uu9qkpcC1muILGW
+    volumes:
+      - ./service-discovery:/etc/sd
+{{< / highlight >}}
 
 Finally the service discovery should be configured fine, let's start this stack with [docker-compose](https://docs.docker.com/compose/), you just need to execute `docker-compose up` within the directory where you have stored `prometheus.yml` and `docker-compose.yml`.
 
-{{< gist tboerger b9c39b6571f48ce2b132de1531061531 "output.log" >}}
+{{< highlight txt >}}
+# docker-compose up
+Creating network "hcloud-sd_default" with the default driver
+Creating volume "hcloud-sd_prometheus" with default driver
+Creating hcloud-sd_hcloud-sd_1  ... done
+Creating hcloud-sd_prometheus_1 ... done
+Attaching to hcloud-sd_hcloud-sd_1, hcloud-sd_prometheus_1
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5574151Z caller=main.go:238 msg="Starting Prometheus" version="(version=2.4.3, branch=HEAD, revision=167a4b4e73a8eca8df648d2d2043e21bdb9a7449)"
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5574847Z caller=main.go:239 build_context="(go=go1.11.1, user=root@1e42b46043e9, date=20181004-08:42:02)"
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5575116Z caller=main.go:240 host_details="(Linux 4.9.93-linuxkit-aufs #1 SMP Wed Jun 6 16:55:56 UTC 2018 x86_64 14ae580d073a (none))"
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5575347Z caller=main.go:241 fd_limits="(soft=1048576, hard=1048576)"
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5575521Z caller=main.go:242 vm_limits="(soft=unlimited, hard=unlimited)"
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5588845Z caller=main.go:554 msg="Starting TSDB ..."
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5590007Z caller=web.go:397 component=web msg="Start listening for connections" address=0.0.0.0:9090
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5639949Z caller=main.go:564 msg="TSDB started"
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5640454Z caller=main.go:624 msg="Loading configuration file" filename=/etc/prometheus/prometheus.yml
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5674651Z caller=main.go:650 msg="Completed loading of configuration file" filename=/etc/prometheus/prometheus.yml
+prometheus_1  | level=info ts=2018-10-07T15:49:32.5675144Z caller=main.go:523 msg="Server is ready to receive web requests."
+hcloud-sd_1   | level=info ts=2018-10-07T15:49:32.5843003Z msg="Launching Prometheus HetznerCloud SD" version=0.0.0-master revision=00c6143 date=20180924 go=go1.11
+hcloud-sd_1   | level=info ts=2018-10-07T15:49:32.5845589Z msg="Starting metrics server" addr=0.0.0.0:9000
+{{< / highlight >}}
 
 That's all, the service discovery should be up and running. You can access [Prometheus](https://prometheus.io) at [http://localhost:9090](http://localhost:9090).