refactor: update README for observability and add test running instructions; update PostgreSQL port in Docker Compose; bump daphne version in requirements

This commit is contained in:
Ross
2026-06-29 17:42:33 +01:00
parent a60982c30a
commit ce323c4973
3 changed files with 8 additions and 7 deletions
+5 -6
View File
@@ -103,12 +103,6 @@ Host setup for logs
sudo chmod 0755 /srv/rad/logs sudo chmod 0755 /srv/rad/logs
``` ```
Viewing logs in Grafana
- Grafana is available on the port exposed by compose (default `3000`).
- The Loki datasource is configured to use `http://loki:3100` (see compose). In Grafana Explore choose the Loki datasource and run queries such as:
- `{job="rad_app"}` (all collected logs)
- `{job="rad_app", filename="/var/log/rad/nginx.access.log"}`
Notes & recommendations Notes & recommendations
- In development the `logs/` folder is ignored by git (`/.gitignore` updated). Do not commit runtime logs. - In development the `logs/` folder is ignored by git (`/.gitignore` updated). Do not commit runtime logs.
@@ -116,3 +110,8 @@ Notes & recommendations
- If you need nginx to re-resolve the backend service IP without restarting, consider using `resolver` and variable-based upstreams in the nginx config. For many development workflows restarting nginx after web restarts is the simplest approach. - If you need nginx to re-resolve the backend service IP without restarting, consider using `resolver` and variable-based upstreams in the nginx config. For many development workflows restarting nginx after web restarts is the simplest approach.
If you want, I can also add a short `docs/OBSERVABILITY.md` with more details and recommended production settings (TLS/auth for Loki, retention, log rotation). If you want, I can also add a short `docs/OBSERVABILITY.md` with more details and recommended production settings (TLS/auth for Loki, retention, log rotation).
## Running tests
Ensure the development Docker environment is running (COMPOSE_ENV=dev docker compose -f docker/docker-compose.local.yml -f docker/docker-compose.dev.yml up -d).
+2
View File
@@ -56,6 +56,8 @@ services:
- POSTGRES_USER=django - POSTGRES_USER=django
- POSTGRES_PASSWORD=postgres - POSTGRES_PASSWORD=postgres
- POSTGRES_DB=rad - POSTGRES_DB=rad
ports:
- "5432:5432"
pgadmin: pgadmin:
image: dpage/pgadmin4:7.2 image: dpage/pgadmin4:7.2
environment: environment:
+1 -1
View File
@@ -61,7 +61,7 @@ pygments
celery[redis] celery[redis]
redis redis
channels==4.1.0 channels==4.1.0
daphne==4.1.2 daphne==4.2.2
channels-redis==4.2.1 channels-redis==4.2.1
pywatchman pywatchman
numpy==2.4.0 numpy==2.4.0