micrometer-metrics/micrometer

Provide binders for Git and Build information

Ouverte

#3 154 ouverte le 1 mai 2022

 (11 commentaires) (3 réactions) (0 personne assignée)Java (1 135 forks)batch import
help wanted

Métriques du dépôt

Stars
 (4 881 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Description There has been some discussion at the Spring Boot project about exposing information like the Git commit ID and Maven coordinates as metrics, similar in style to the existing JvmInfoMetrics binder. For consistency, we would provide the same information that Spring Boot's Actuator exposes on its /actuator/info endpoint.

The binders would receive the data via constructor arguments and add a constant gauge with tags for all attributes we want to expose. If some values are null, we would add a marker string ("unknown", "null", "N/A") to make sure all tags are always present.

Example:

git_info{app="some-service", branch="main", id="cafecafe", time="2022-04-26T18:39:18Z"} 1.0
build_info{app="some-service", name="Some Service", artifact="some-service", group="org.example", version="1.7", time="2022-04-28T12:01:07Z"} 1.0

This issue is intended to discuss whether this is a worthwhile addition and to discuss the design if the team decides to proceed.

Rationale Adding metrics binders to Micrometer would provide standardization of these metrics across all users of Micrometer, not just Spring Boot. The new metrics would be useful in Grafana dashboards, for example, to display which exact commit/version is currently deployed.

Additional context

Guide contributeur