focalboard/server/services/prometheus/intrumentor.go
Spiros Economakis 8f746a44bd
Enable prometheus metrics for Focalboard to enable observability (#414)
As an SRE team we would like to expose standard metrics and grouped by version
of the application. Right now will expose only metrics related to Go but instrumentor
should be used in other parts of the codebase so we can track other metrics, eg.
number of tasks, boards, users etc. Similar as we do in MM.

It will run in port `localhost:9092` and it is a new config `prometheus_address`.

Also in the commit we introduced, `group.Add` which helps us to handle gracefully
errors for goroutines. It's a good practice and there are couple of articles by
Golang for this.
2021-05-18 17:12:51 +03:00

27 lines
705 B
Go

package prometheus
import (
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
)
// Instrumentor used to instrumentate metrics in prometheus
type Instrumentor struct {
Version string
}
// NewInstrumentor Factory method to create a new instrumentator
func NewInstrumentor(version string) *Instrumentor {
return &Instrumentor{
Version: version,
}
}
// ExposeBuildInfo exposes a gauge in prometheus for build info
func (i *Instrumentor) ExposeBuildInfo() {
promauto.NewGaugeVec(prometheus.GaugeOpts{
Name: "focalboard_build_info",
Help: "Build information of Focalboard",
}, []string{"Version"},
).WithLabelValues(i.Version).Set(1)
}