From fc68d883d647d34e683689e1173fa21d2aad532a Mon Sep 17 00:00:00 2001 From: traveler Date: Tue, 7 Apr 2026 17:13:48 -0500 Subject: [PATCH] docs(gremlin): create monitoring --- Netgrimoire/Services/monitoring/monitoring.md | 92 +++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 Netgrimoire/Services/monitoring/monitoring.md diff --git a/Netgrimoire/Services/monitoring/monitoring.md b/Netgrimoire/Services/monitoring/monitoring.md new file mode 100644 index 0000000..a8e9a10 --- /dev/null +++ b/Netgrimoire/Services/monitoring/monitoring.md @@ -0,0 +1,92 @@ +# monitoring + +Overview +--------------- + +The monitoring stack provides a comprehensive set of services for metrics collection, dashboard management, alert routing, container metrics, and host metrics in NetGrimoire. The stack includes Prometheus for metrics collection, Grafana for dashboards, Alertmanager for alert routing, Cadvisor for container metrics, and Node Exporter for host metrics. + +Architecture +------------- + +| Service | Image | Port | Role | +|---------|-------|-----|------| +- **Prometheus:** prom/prometheus:latest + - exposed via: `grafana.netgrimoire.com` + - Homepage group: Monitoring + +- **Grafana:** grafana/grafana:latest + - exposed via: `grafana.netgrimoire.com` + - Homepage group: Monitoring + +- **Alertmanager:** prom/alertmanager:latest + - exposed via: `alertmanager.netgrimoire.com` + - Homepage group: Monitoring + +- **Cadvisor:** gcr.io/cadvisor/cadvisor:latest + - exposed via: `cadvisor.netgrimoire.com` + - Homepage group: Monitoring + +- **Node Exporter:** prom/node-exporter:latest + - exposed via: `node-exporter.netgrimoire.com` + - Homepage group: Monitoring + +Build & Configuration +--------------------- + +### Prerequisites + +- Docker and Docker Swarm installed on docker4 + +### Volume Setup + +```bash +mkdir -p /DockerVol/prometheus/data +mkdir -p /DockerVol/grafana/data +``` + +### Environment Variables + +```bash +# generate: openssl rand -hex 32 +GF_SECURITY_ADMIN_PASSWORD=F@lcon13 +``` + +### Deploy + +```bash +cd services/swarm/stack/monitoring +set -a && source .env && set +a +docker stack config --compose-file monitoring-stack.yml > resolved.yml +docker stack deploy --compose-file resolved.yml monitoring +rm resolved.yml +docker stack services monitoring +``` + +### First Run + +- Post-deploy steps specific to these services include configuring network, caddy, and uptime kuma. + +--- + +## User Guide + +### Accessing Monitoring + +| Service | URL | Purpose | +|---------|-----|---------| +- **Prometheus:** https://prometheus.netgrimoire.com +- **Grafana:** https://grafana.netgrimoire.com +- **Alertmanager:** https://alertmanager.netgrimoire.com +- **Cadvisor:** `cadvisor.netgrimoire.com` (Container metrics) +- **Node Exporter:** `node-exporter.netgrimoire.com` (Host metrics) + +### Primary Use Cases + +- Monitoring system performance and health. +- Configuring alerts for critical issues. +- Visualizing metrics in real-time. + +### NetGrimoire Integrations + +- Connects to Crowdsec via Caddy reverse proxy. +- Uptime Kuma monitors services and detects errors. \ No newline at end of file