Evenfire is an intelligence layer platform for running LLM agents that take real actions, on your infrastructure
TypeScript
docs: update docs for monitoring starter Makefile and webhook-proxy health port
Jose Gabriel Ramirez Encinasc0f3988344fd
diff --git a/docs/operations/monitoring.md b/docs/operations/monitoring.mdindex d600f4081..55ef06101 100644--- a/docs/operations/monitoring.md+++ b/docs/operations/monitoring.md@@ -20,13 +20,13 @@ Short version:the kustomize tree installs it. It holds Helm values for the official Grafanacharts:-| Path | What it does |-| ---------------------------------------- | ---------------------------------------------------------------------------------------------- |-| `namespace.yaml` | Creates the `monitoring` namespace |-| `loki/values.yaml` | `grafana/loki-stack` chart `2.9.10`: Loki (100 Gi PVC) plus Promtail |-| `grafana/values.yaml` | `grafana/grafana` chart: Loki datasource at `http://loki.monitoring:3100`, 10 Gi PVC, non-root |-| `dashboards/loki-grafana-dashboard.json` | One Grafana dashboard for Kubernetes logs |-| `Makefile` | `setup`, `install_*`, `upgrade_*`, `uninstall_*`, `port_forward_grafana`, `status` |+| Path | What it does |+| ---------------------------------------- | ------------------------------------------------------------------------------------------------ |+| `namespace.yaml` | Creates the `monitoring` namespace |+| `loki/values.yaml` | `grafana/loki-stack` chart `2.9.10`: Loki (100 Gi PVC) plus Promtail |+| `grafana/values.yaml` | `grafana/grafana` chart: Loki datasource at `http://loki.monitoring:3100`, 10 Gi PVC, non-root |+| `dashboards/loki-grafana-dashboard.json` | One Grafana dashboard for Kubernetes logs |+| `Makefile` | `setup`, `install_*`, `upgrade_*`, `uninstall_*`, `dashboards`, `port_forward_grafana`, `status` |Loki is the only datasource. The starter does not install Prometheus or anymetrics dashboard.@@ -40,9 +40,9 @@ There is one dashboard, **Loki Kubernetes Logs** (Grafana community dashboard- a log panel with the matching lines.You filter by `namespace`, `stream` and `container`, plus a free-text search.-The panels reference a fixed datasource UID that the provisioned Loki-datasource does not set. If the panels show "datasource not found", open each-panel and select the **Loki** datasource.+The panels reference the Loki datasource by the fixed UID+`P8E80F9AEF21F6940`, which `grafana/values.yaml` sets on the provisioned Loki+datasource. If you change one, change the other.### Install on minikube@@ -94,10 +94,16 @@ generates. On a cluster whose StorageClass matches the values files, the same`helm --kube-context` commands work without the `--set` overrides.The targets in `monitoring/Makefile` (`setup`, `install_*`, `upgrade_*`,-`uninstall_*`, `status`, `port_forward_grafana`) take no context: they run-`kubectl` and `helm` against your kubeconfig's **current** context. Use them-only after `kubectl config current-context` shows the intended cluster; the-explicit commands above are the safer default.+`uninstall_*`, `dashboards`, `status`, `port_forward_grafana`) take no context:+they run `kubectl` and `helm` against your kubeconfig's **current** context.+Use them only after `kubectl config current-context` shows the intended+cluster; the explicit commands above are the safer default. `install_grafana`+and `upgrade_grafana` create or update the `grafana-dashboards` ConfigMap+first. The `STORAGE_CLASS`, `LOKI_SIZE`, `GRAFANA_SIZE` and `GRAFANA_PORT`+variables cover the minikube overrides, for example+`make install_loki install_grafana STORAGE_CLASS=standard LOKI_SIZE=10Gi` and+`make port_forward_grafana GRAFANA_PORT=3001`. See the+[`monitoring/` README](../../monitoring/README.md#make-variables).## Logs@@ -135,8 +141,8 @@ None of them is wired to a scraper by default.| mcp-proxy | `deploy/base` Deployment | `8083` | || gfs-controller | Stamped by HCC in the `gfs` namespace | `8087` (`GFS_PORT`) | SLI counters |-webhook-proxy has a port named `metrics` on `9090`, but it only answers-`/healthz` and `/readyz`. It serves no `/metrics`.+webhook-proxy's port `9090` is named `health`. It only answers `/healthz` and+`/readyz`. It serves no `/metrics`.control-api's `/metrics` is not forwarded by the nginx gateway in front of it.Scrape the control-api pod or Service directly.diff --git a/monitoring/README.md b/monitoring/README.mdindex ec10949c8..a17fe0a5a 100644--- a/monitoring/README.md+++ b/monitoring/README.md@@ -19,10 +19,10 @@ Helm values and Grafana dashboard configs for the Clerum observability stack. Th## Setup-> **On minikube**, follow [Monitoring and observability](../docs/operations/monitoring.md#install-on-minikube)-> instead: it overrides the storage class and the 100 Gi Loki volume. That page-> also explains what this starter covers (logs only; no metrics scraping is-> shipped).+> **On minikube**, the safer path is [Monitoring and observability](../docs/operations/monitoring.md#install-on-minikube):+> it uses explicit `--context` commands with the minikube storage class and a+> smaller Loki volume. That page also explains what this starter covers (logs+> only; no metrics scraping is shipped).```bash# Add Grafana Helm repo and create namespace@@ -62,7 +62,7 @@ explicit commands in| Target | Description || ---------------------- | ------------------------------------------------------------------------------------------------- || `setup` | Add Grafana Helm repo + create namespace |-| `install_loki` | Install loki-stack chart (v2.9.10) |+| `install_loki` | Install loki-stack chart (`LOKI_CHART_VERSION`, default 2.9.10) || `upgrade_loki` | Upgrade loki-stack release || `uninstall_loki` | Remove loki-stack release || `dashboards` | Create or update the `grafana-dashboards` ConfigMap from every file in `dashboards/` (idempotent) |