From 5e8d26381abfadde95f7025057fa06cde846e97e Mon Sep 17 00:00:00 2001 From: nscuro Date: Tue, 9 Jun 2026 17:59:05 +0200 Subject: [PATCH] Reference maintainer's Grafana dashboards as starting point for users Signed-off-by: nscuro --- .../config/vocabularies/DependencyTrack/accept.txt | 1 + .../administration/configuring-observability.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) diff --git a/.vale/styles/config/vocabularies/DependencyTrack/accept.txt b/.vale/styles/config/vocabularies/DependencyTrack/accept.txt index 63525075..9d537109 100644 --- a/.vale/styles/config/vocabularies/DependencyTrack/accept.txt +++ b/.vale/styles/config/vocabularies/DependencyTrack/accept.txt @@ -27,6 +27,7 @@ Fedora 389 Directory Server Flashpoint GUIDs GitLab +Grafana HDDs Hackage IdP diff --git a/docs/guides/administration/configuring-observability.md b/docs/guides/administration/configuring-observability.md index ab15e412..a5820060 100644 --- a/docs/guides/administration/configuring-observability.md +++ b/docs/guides/administration/configuring-observability.md @@ -77,6 +77,19 @@ scrape_configs: # password: "changeme" ``` +## Visualizing metrics with Grafana + +The project does not publish Grafana dashboards as supported artifacts. The dashboards +the maintainers use for their own purposes live in the [API server repository][dashboards]. + +!!! warning + These dashboards are not supported and not guaranteed to be up-to-date with the + metrics exposed by the current release. Panels may reference metrics that were + renamed or removed. + +Use them as a starting point. Build your own dashboards tailored to the metrics and +alerting needs of your deployment. + ## Adjusting log levels By default, Dependency-Track logs at `INFO` level for application loggers and `WARN` for all others. @@ -98,3 +111,4 @@ for how to express these properties as environment variables. [MicroProfile Health]: https://download.eclipse.org/microprofile/microprofile-health-4.0.1/microprofile-health-spec-4.0.1.html [probe types]: https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/ [Prometheus text exposition format]: https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format +[dashboards]: https://github.com/DependencyTrack/dependency-track/tree/main/dev/monitoring/grafana/dashboards