Merge branch 'main' into test/e2e

Signed-off-by: lvlcn-t <[email protected]>

.pre-commit-config.yaml

@@ -29,6 +29,6 @@ repos:
   - repo: https://github.com/norwoodj/helm-docs
     rev: v1.14.2
     hooks:
-      - id: helm-docs
+      - id: helm-docs-built
         args:
           - --chart-search-root=chart

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.20 as prep
+FROM alpine:3.21 as prep
 
 RUN apk add --no-cache ca-certificates
 RUN adduser \

README.md

@@ -626,7 +626,7 @@ Is roughly equal to this:
 The `sparrow` exposes an API for accessing the results of various checks. Each check registers its own endpoint
 at `/v1/metrics/{check-name}`. The API's definition is available at `/openapi`.
 
-## Metrics
+## Metrics, Telemetry & Dashboards
 
 The `sparrow` provides a `/metrics` endpoint to expose application metrics. In addition to runtime information, the sparrow provides specific metrics for each check. Refer to the [Checks](#checks) section for more detailed information.
 
@@ -684,6 +684,12 @@ telemetry:
 
 Since [OTLP](https://opentelemetry.io/docs/specs/otlp/) is a standard protocol, you can choose any collector that supports it. The `stdout` exporter can be used for debugging purposes to print telemetry data to the console, while the `noop` exporter disables telemetry. If an external collector is used, a bearer token for authentication and a TLS certificate path for secure communication can be provided.
 
+### Grafana Dashboards
+
+A sample Grafana dashboard to visualize the metrics collected by the checks is available in the `examples` directory of the repository. How to import dashboards into Grafana is documented [here](https://grafana.com/docs/grafana/latest/reference/export_import/).
+
+<img src="examples/dashboard.png">
+
 ## Code of Conduct
 
 This project has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) in version 2.1 as our code of

chart/Chart.yaml

@@ -5,7 +5,7 @@ type: application
 keywords:
   - monitoring
 version: 0.0.4
-appVersion: "v0.3.2"
+appVersion: "v0.5.0"
 icon: https://github.com/caas-team/sparrow/blob/main/docs/img/sparrow.png
 sources:
   - https://github.com/caas-team/sparrow

chart/README.md

@@ -1,6 +1,6 @@
 # sparrow
 
-![Version: 0.0.4](https://img.shields.io/badge/Version-0.0.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.3.2](https://img.shields.io/badge/AppVersion-v0.3.2-informational?style=flat-square)
+![Version: 0.0.4](https://img.shields.io/badge/Version-0.0.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.5.0](https://img.shields.io/badge/AppVersion-v0.5.0-informational?style=flat-square)
 
 A Helm chart to install Sparrow