Export the versions of Go modules linked into the binary #578
Conversation
kylelemons
requested review from
fishy,
konradreiche and
ghirsch-reddit
and removed request for
a team
| Path: "example.com/path/to/main/module", | ||
| Version: "(devel)", | ||
| }, | ||
| Deps: []*debug.Module{{ |
There was a problem hiding this comment.
nit: consider adding a case of replaced=true?
internal/prometheusbpint/modules.go
Outdated
| goModules.With(prometheus.Labels{ | ||
| "go_module": mod.Path, | ||
| "module_role": role, | ||
| "replaced": strconv.FormatBool(mod.Replace != nil), |
There was a problem hiding this comment.
🔕 I think overall we want to avoid using single word labels, as the whole label indices are global so two unrelated metrics emitting with the same label (e.g. conflicted labels) will make searching by label slower. I'd suggest use module_replaced instead.
There was a problem hiding this comment.
hmm, makes it a not-strict backport but I can make the change to v2 as well.
internal/prometheusbpint/modules.go
Outdated
| }, []string{"go_module", "module_role", "module_replaced", "module_version"}) | ||
|
|
||
| func RecordModuleVersions(info *debug.BuildInfo) { | ||
| record := func(role string, mod *debug.Module) { |
There was a problem hiding this comment.
Out of curiosity, what's the reason for defining this inside rather than at the top-level?
internal/prometheusbpint/modules.go
Outdated
| Help: "Export the version information for included Go modules, and whether the module is the 'main' module or a 'dependency'. Always 1", | ||
| }, []string{"go_module", "module_role", "module_replaced", "module_version"}) | ||
|
|
||
| func RecordModuleVersions(info *debug.BuildInfo) { |
There was a problem hiding this comment.
🔕 also, do we want to consider moving this to prometheusbp so some more customized services (that don't use baseplate.New) can also use it?
There was a problem hiding this comment.
+1 I think it would be useful to not lock this behind internal
internal/prometheusbpint/modules.go
Outdated
| Help: "Export the version information for included Go modules, and whether the module is the 'main' module or a 'dependency'. Always 1", | ||
| }, []string{"go_module", "module_role", "module_replaced", "module_version"}) | ||
|
|
||
| func RecordModuleVersions(info *debug.BuildInfo) { |
There was a problem hiding this comment.
+1 I think it would be useful to not lock this behind internal
baseplate.go
Outdated
| @@ -310,7 +309,7 @@ func New(ctx context.Context, args NewArgs) (context.Context, Baseplate, error) | |||
| bp := impl{cfg: cfg, closers: batchcloser.New()} | |||
|
|
|||
| if info, ok := debug.ReadBuildInfo(); ok { | |||
| prometheusbpint.RecordModuleVersions(info) | |||
| metricsbp.RecordModuleVersions(info) | |||
There was a problem hiding this comment.
you want prometheusbp instead of metricsbp 😅
💸 TL;DR
Backport of module metrics from v2.0.0
✅ Checks
Contributor License Agreement (CLA) completed if not a Reddit employee