Skip to content

feat: add kagent_build_info metrics for controller #643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
EItanya merged 2 commits into from
Jul 24, 2025
Merged

feat: add kagent_build_info metrics for controller #643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9c2ae6
add kagent build info metrics
dongjiang1989 Jul 24, 2025
839b10d
Merge branch 'main' into add-build-info-metrics
EItanya Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions go/controller/cmd/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import (
a2a_manager "github.com/kagent-dev/kagent/go/internal/a2a/manager"
autogen_client "github.com/kagent-dev/kagent/go/internal/autogen/client"
"github.com/kagent-dev/kagent/go/internal/database"
versionmetrics "github.com/kagent-dev/kagent/go/internal/metrics"

a2a_reconciler "github.com/kagent-dev/kagent/go/controller/internal/a2a"
"github.com/kagent-dev/kagent/go/internal/httpserver"
Expand All @@ -58,6 +59,7 @@ import (
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
"sigs.k8s.io/controller-runtime/pkg/manager"
ctrlmetrics "sigs.k8s.io/controller-runtime/pkg/metrics"
"sigs.k8s.io/controller-runtime/pkg/metrics/filters"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
"sigs.k8s.io/controller-runtime/pkg/webhook"
Expand Down Expand Up @@ -195,6 +197,8 @@ func main() {
TLSOpts: webhookTLSOpts,
})

ctrlmetrics.Registry.MustRegister(versionmetrics.NewBuildInfoCollector())

// Metrics endpoint is enabled in 'config/default/kustomization.yaml'. The Metrics options configure the server.
// More info:
// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.20.0/pkg/metrics/server
Expand Down
2 changes: 1 addition & 1 deletion go/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ require (
github.com/gorilla/mux v1.8.1
github.com/hashicorp/go-multierror v1.1.1
github.com/jedib0t/go-pretty/v6 v6.6.7
github.com/prometheus/client_golang v1.22.0
github.com/spf13/cobra v1.9.1
github.com/spf13/pflag v1.0.6
github.com/spf13/viper v1.20.1
Expand Down Expand Up @@ -91,7 +92,6 @@ require (
github.com/pelletier/go-toml/v2 v2.2.3 // indirect
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
github.com/prometheus/client_golang v1.22.0 // indirect
github.com/prometheus/client_model v0.6.2 // indirect
github.com/prometheus/common v0.65.0 // indirect
github.com/prometheus/procfs v0.16.1 // indirect
Expand Down
27 changes: 27 additions & 0 deletions go/internal/metrics/version.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package metrics

import (
"github.com/prometheus/client_golang/prometheus"

"github.com/kagent-dev/kagent/go/internal/version"
)

// NewBuildInfoCollector returns a collector that exports metrics about current version
// information.
func NewBuildInfoCollector() prometheus.Collector {
return prometheus.NewGaugeFunc(
prometheus.GaugeOpts{
Name: "kagent_build_info",
Help: "kagent build metadata exposed as labels with a constant value of 1.",
ConstLabels: prometheus.Labels{
"version": version.Get().Version,
"git_commit": version.Get().GitCommit,
"build_date": version.Get().BuildDate,
"go_version": version.Get().GoVersion,
"compiler": version.Get().Compiler,
"platform": version.Get().Platform,
},
},
func() float64 { return 1 },
)
}
Loading