From ce7929af30c895a08bf53ff054870ae850e05853 Mon Sep 17 00:00:00 2001 From: Richard Robert Reitz Date: Wed, 18 Dec 2024 20:16:31 +0100 Subject: [PATCH] Updated grafana.md --- docs/userguide/grafana.md | 29 +++++++++-------------------- 1 file changed, 9 insertions(+), 20 deletions(-) diff --git a/docs/userguide/grafana.md b/docs/userguide/grafana.md index d872699..776b14c 100644 --- a/docs/userguide/grafana.md +++ b/docs/userguide/grafana.md @@ -7,40 +7,29 @@ Various telemetry tools are included in the technology stack of this repository. Kube-prometheus-stack contains Kubernetes manifests, Prometheus and Grafana, including preconfigured dashboards. ### Kube-prometheus-stack Overview - Grafana is an open-source monitoring solution that enables viusalization of metrics and logs. Prometheus is an open-source monitoring and alerting system which collects metrics from services and allows the metrics to be shown in Grafana. -### Start - -Once Grafana is running it is accessible under https://cnoe.localtest.me/grafana. -Many preconfigured dashboards can be used by klicking the menu option Dashboards. - ### Adding your own dashboards +Examples for additional preconfigured dashboards can be found in the folder [dashboards](https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW-CICD/stacks/src/branch/development/template/stacks/monitoring/kube-prometheus/dashboards). -The application edfbuilder/kind/stacks/core/kube-prometheus.yaml is used to import new Loki dashboards. -Examples for imported dashboards can be found in the folder edfbuilder/kind/stacks/core/kube-prometheus/dashboards. +It is possible to add your own dashboards by putting them into the same folder. -It is possible to add your own dashboards: -Dashboards must be in JSON format. To add your own dashboard create a new ConfigMap in YAML format using onw of the examples as a blueprint. -The new dashboard in JSON format has to be added as the value for data.k8s-dashboard-[...].json like in the examples. +- Dashboards must be in JSON format. To add your own dashboard create a new ConfigMap in YAML format using one of the examples as a blueprint. +- The new dashboard in JSON format has to be added as the value for data.k8s-dashboard-[...].json like in the examples. (It is important to use a unique name for data.k8s-dashboard-[...].json for each dashboard.) -Currently preconfigured dashboards include several dahboards for Loki and a dashboard to showcase Nginx-Ingress metrics. +Currently the preconfigured dashboards include several examples for Loki and Nginx-Ingress metrics. ## Loki - -Grafana Loki is a scalable open-source log aggregation system +Grafana Loki is a scalable open-source log aggregation system. ### Loki Overview - -The application Grafana Loki is started in edfbuilder/kind/stacks/core/loki.yaml. Loki is started in microservices mode and contains the components ingester, distributor, querier, and query-frontend. -The Helm values file edfbuilder/kind/stacks/core/loki/values.yaml contains configuration values. +It can be configured by it's helm values file. ## promtail - -Grafana Promtail is an agent that ships logs to a Grafan Loki instance (log-shipper) +Grafana Promtail is an agent that ships logs to a Grafan Loki instance (log-shipper). The application Grafana Promtail is started in edfbuilder/kind/stacks/core/promtail.yaml. -The Helm values file edfbuilder/kind/stacks/core/promtail/values.yaml contains configuration values. +It can also be configured by it's helm values file.