docs: describe monitoring

Author: openscript

.vscode/settings.json

@@ -17,5 +17,11 @@
     "editor.defaultFormatter": "vscode.css-language-features"
   },
   "javascript.preferences.importModuleSpecifier": "relative",
-  "typescript.preferences.importModuleSpecifier": "relative"
+  "typescript.preferences.importModuleSpecifier": "relative",
+  "github.copilot.enable": {
+    "*": true,
+    "plaintext": false,
+    "scminput": false,
+    "markdown": true
+  }
 }

docs/examples/docker-compose.yaml

@@ -7,7 +7,8 @@ volumes:
 
 services:
   proxy:
-    image: traefik:3.1
+    image: traefik:3.2
+    restart: unless-stopped
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock:ro
       - ./traefik.yaml:/traefik.yml
@@ -33,6 +34,7 @@ services:
 
   backend:
     image: ghcr.io/openscript-ch/quassel-backend:latest
+    restart: unless-stopped
     volumes:
       - storage:/app/storage
     depends_on:
@@ -59,13 +61,15 @@ services:
 
   database:
     image: postgres:17.0-alpine
+    restart: unless-stopped
     volumes:
       - database:/var/lib/postgresql/data
     environment:
       POSTGRES_PASSWORD: "secret"
 
   frontend:
     image: ghcr.io/openscript-ch/quassel-frontend:latest
+    restart: unless-stopped
     environment:
       API_URL: https://api.test.example.com
     labels:
@@ -83,6 +87,7 @@ services:
 
   mockup:
     image: ghcr.io/openscript-ch/quassel-mockup:latest
+    restart: unless-stopped
     labels:
       - "com.centurylinklabs.watchtower.enable=true"
       - "traefik.enable=true"
@@ -96,8 +101,9 @@ services:
       - "traefik.http.routers.mockup-https-service=mockup-http-service"
       - "traefik.http.services.mockup-http-service.loadbalancer.server.port=80"
 
-  watchtower:
+  updates:
     image: containrrr/watchtower
+    restart: unless-stopped
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
     command: --http-api-update
@@ -107,3 +113,11 @@ services:
       - "com.centurylinklabs.watchtower.enable=false"
     ports:
       - 8080:8080
+
+  metrics:
+    image: grafana/agent:v0.43.3
+    restart: unless-stopped
+    volumes:
+      - ./grafana-agent.yaml:/etc/grafana-agent.yaml
+    command:
+      - --config.file=/etc/grafana-agent.yaml

docs/examples/grafana-agent.yaml

@@ -0,0 +1,16 @@
+server:
+  log_level: info
+
+metrics:
+  global:
+    scrape_interval: 300s
+    remote_write:
+      - url: "<endpoint>"
+        bearer_token: "<token>"
+
+  configs:
+    - name: "docker"
+      scrape_configs:
+        - job_name: "docker"
+          static_configs:
+            - targets: ["host.docker.internal:9323"]

docs/setup.md

@@ -2,7 +2,7 @@
 
 ## Getting started
 
-The following steps describe how to set up the Quassel.
+The following steps describe how to set up the Quassel application system.
 
 ### Environment
 
@@ -89,7 +89,9 @@ The following sources were used:
 
 ### Application system
 
-1. Clone this repository
+The following steps describe how to set up the application system:
+
+1. Copy the example files
 
    ```bash
    cd /srv \
@@ -120,6 +122,39 @@ The following sources were used:
    docker compose -f docker-compose.yaml up -d
    ```
 
+### Automatic updates
+
+For automatic updates, there is a watchtower service configured. This service exposes an endpoint at `http://test.example.com:8080/v1/update`. If a HTTP GET request is sent including the configured secret Bearer token to this endpoint, watchtower will pull new images and restart the services accordingly.
+
+### Monitoring
+
+The following opinionated steps describe to push data to a Grafana instance via Prometheus:
+
+1. Get the remote url and token.
+1. Enable [Docker Metrics](https://docs.docker.com/engine/daemon/prometheus/).
+   1. Add the following to the Docker daemon configuration file `/etc/docker/daemon.json`:
+
+      ```json
+      {
+        "metrics-addr" : "localhost:9323"
+      }
+      ```
+
+   1. Restart the Docker daemon with `systemctl restart docker`.
+1. Copy the Grafana Agent configuration example:
+
+   ```bash
+   wget https://raw.githubusercontent.com/openscript-ch/quassel/refs/heads/main/docs/examples/grafana-agent.yaml
+   ```
+
+1. Replace the `remote_write` url and token in `grafana-agent.yaml`.
+   1. `<endpoint>` with the remote url.
+   1. `<token>` with the token.
+
+## Tasks
+
+The following sections describe the tasks to take care of the application system.
+
 ### Release a new version
 
 1. Merge the release pull request and wait for completion of the pipeline.