Introduce metrics.Registry to pass down registries #61239
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| /* | ||
| * Teleport | ||
| * Copyright (C) 2025 Gravitational, Inc. | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package grpcmetrics | ||
|
|
||
| import ( | ||
| grpcprom "github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| ) | ||
|
|
||
| // CreateGRPCServerMetrics creates server gRPC metrics configuration that is to be registered and used by the caller | ||
| // in an openmetrics unary and/or stream interceptor | ||
| func CreateGRPCServerMetrics( | ||
| latencyEnabled bool, labels prometheus.Labels, | ||
| ) *grpcprom.ServerMetrics { | ||
| serverOpts := []grpcprom.ServerMetricsOption{ | ||
| grpcprom.WithServerCounterOptions(grpcprom.WithConstLabels(labels)), | ||
| } | ||
| if latencyEnabled { | ||
| histOpts := grpcHistogramOpts(labels) | ||
| serverOpts = append( | ||
| serverOpts, grpcprom.WithServerHandlingTimeHistogram(histOpts...), | ||
| ) | ||
| } | ||
| return grpcprom.NewServerMetrics(serverOpts...) | ||
| } | ||
|
|
||
| // CreateGRPCClientMetrics creates client gRPC metrics configuration that is to be registered and used by the caller | ||
| // in an openmetrics unary and/or stream interceptor | ||
| func CreateGRPCClientMetrics( | ||
| latencyEnabled bool, labels prometheus.Labels, | ||
| ) *grpcprom.ClientMetrics { | ||
| clientOpts := []grpcprom.ClientMetricsOption{ | ||
| grpcprom.WithClientCounterOptions(grpcprom.WithConstLabels(labels)), | ||
| } | ||
| if latencyEnabled { | ||
| histOpts := grpcHistogramOpts(labels) | ||
| clientOpts = append( | ||
| clientOpts, grpcprom.WithClientHandlingTimeHistogram(histOpts...), | ||
| ) | ||
| } | ||
| return grpcprom.NewClientMetrics(clientOpts...) | ||
| } | ||
|
|
||
| func grpcHistogramOpts(labels prometheus.Labels) []grpcprom.HistogramOption { | ||
| return []grpcprom.HistogramOption{ | ||
| grpcprom.WithHistogramBuckets(prometheus.ExponentialBuckets(0.001, 2, 16)), | ||
| grpcprom.WithHistogramConstLabels(labels), | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| /* | ||
| * Teleport | ||
| * Copyright (C) 2025 Gravitational, Inc. | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| package metrics | ||
|
|
||
| import ( | ||
| "errors" | ||
|
|
||
| "github.com/prometheus/client_golang/prometheus" | ||
| ) | ||
|
|
||
| // Registry is a [prometheus.Registerer] for a Teleport process that | ||
| // allows propagating additional information such as: | ||
| // - the metric namespace (`teleport`, `teleport_bot`, `teleport_plugins`) | ||
| // - an optional subsystem | ||
| // | ||
| // This should be passed anywhere that needs to register a metric. | ||
| type Registry struct { | ||
| prometheus.Registerer | ||
|
|
||
| namespace string | ||
| subsystem string | ||
|
Comment on lines
+33
to
+37
Contributor
Author
There was a problem hiding this comment. We can easily add a |
||
| } | ||
|
|
||
| // Namespace returns the namespace that should be used by metrics registered | ||
| // in this Registry. Common namespaces are "teleport", "tbot", and | ||
| // "teleport_plugins". | ||
| func (r *Registry) Namespace() string { | ||
| return r.namespace | ||
| } | ||
|
|
||
| // Subsystem is the subsystem base that should be used by metrics registered in | ||
| // this Registry. Subsystem parts can be added with WrapWithSubsystem. | ||
| func (r *Registry) Subsystem() string { | ||
| return r.subsystem | ||
| } | ||
|
|
||
| // Wrap wraps a Registry by adding a component to its subsystem. | ||
| // This should be used before passing a registry to a sub-component. | ||
| // Example usage: | ||
| // | ||
| // rootReg := prometheus.NewRegistry() | ||
| // process.AddGatherer(rootReg) | ||
| // reg, err := NewRegistry(rootReg, "teleport_plugins", "") | ||
| // go runFooService(ctx, log, reg.Wrap("foo")) | ||
| // go runBarService(ctx, log, reg.Wrap("bar")) | ||
| func (r *Registry) Wrap(subsystem string) *Registry { | ||
| newReg := &Registry{ | ||
| Registerer: r.Registerer, | ||
| namespace: r.namespace, | ||
| subsystem: r.subsystem + "_" + subsystem, | ||
|
Contributor
There was a problem hiding this comment. Should this handle an empty r.subsystem? |
||
| } | ||
| return newReg | ||
| } | ||
|
|
||
| // NewRegistry creates a new Registry wrapping a prometheus registry. | ||
| // This should only be called when starting the service management routines such | ||
| // as: service.NewTeleport(), tbot.New(), or the hosted plugin manager. | ||
| // Services and sub-services should take the registry as a parameter, like they | ||
| // already do for the logger. | ||
| // Example usage: | ||
| // | ||
| // rootReg := prometheus.NewRegistry() | ||
| // process.AddGatherer(rootReg) | ||
| // reg, err := NewRegistry(rootReg, "teleport_plugins", "") | ||
| // go runFooService(ctx, log, reg.Wrap("foo")) | ||
| // go runBarService(ctx, log, reg.Wrap("bar")) | ||
| func NewRegistry(reg prometheus.Registerer, namespace, subsystem string) (*Registry, error) { | ||
| if reg == nil { | ||
| return nil, errors.New("nil prometheus.Registerer (this is a bug)") | ||
| } | ||
| if namespace == "" { | ||
| return nil, errors.New("namespace is required (this is a bug)") | ||
| } | ||
| return &Registry{ | ||
| Registerer: reg, | ||
| namespace: namespace, | ||
| subsystem: subsystem, | ||
| }, nil | ||
| } | ||
|
|
||
| // NoopRegistry returns a Registry that doesn't register metrics. | ||
| // This can be used in tests, or to provide backward compatibility when a nil | ||
| // Registry is passed. | ||
| func NoopRegistry() *Registry { | ||
| return &Registry{ | ||
| Registerer: noopRegistry{}, | ||
| namespace: "noop", | ||
| subsystem: "", | ||
| } | ||
| } | ||
|
|
||
| type noopRegistry struct{} | ||
|
|
||
| // Register implements [prometheus.Registerer]. | ||
| func (b noopRegistry) Register(collector prometheus.Collector) error { | ||
| return nil | ||
| } | ||
|
|
||
| // MustRegister implements [prometheus.Registerer]. | ||
| func (b noopRegistry) MustRegister(collector ...prometheus.Collector) { | ||
| } | ||
|
|
||
| // Unregister implements [prometheus.Registerer]. | ||
| func (b noopRegistry) Unregister(collector prometheus.Collector) bool { | ||
| return true | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.