Skip to content

✨ Expose all Go runtime metrics #3070

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
merged 3 commits into from
Feb 5, 2025
Merged

✨ Expose all Go runtime metrics #3070

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3bec486
add GoCollector and rocessCollector
dongjiang1989 Jan 14, 2025
85fc176
move to internal/controller/metrics
dongjiang1989 Jan 15, 2025
bf0ef29
default add all go runtime metrics
dongjiang1989 Feb 5, 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
11 changes: 10 additions & 1 deletion pkg/internal/controller/metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ limitations under the License.
package metrics

import (
"regexp"

"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/collectors"
"sigs.k8s.io/controller-runtime/pkg/metrics"
Expand Down Expand Up @@ -89,6 +91,13 @@ func init() {
// expose process metrics like CPU, Memory, file descriptor usage etc.
collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}),
// expose Go runtime metrics like GC stats, memory stats etc.
collectors.NewGoCollector(),
collectors.NewGoCollector(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want this change - Any config we put in here will be wrong for some cases so we'd rather keep it as-is to avoid the breaking change. You can unregister and re-register these in the config you need if the default doesn't work for you: https://github.com/gitpod-io/gitpod/blob/58e1f558c90aa819b6061ce170ad7b0320183dec/components/ws-daemon/pkg/daemon/daemon.go#L63
/hold

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dongjiang1989 Was chatting with Alvaro.

In general we don't want to finetune things like this too much as it's hard to find something that works for everyone.

But in this specific case we're good. It did some research and it turns out we can simply enable all Go metrics as there are not that many. SO it's not too much overhead. And having all Go metrics should of course work for everyone

Please change this to:

collectors.NewGoCollector(collectors.WithGoCollectorRuntimeMetrics(collectors.MetricsAll))

(btw component-base, i.e. kube-apiserver, ... are doing the same)

/hold cancel

Copy link
Contributor Author

@dongjiang1989 dongjiang1989 Feb 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alvaroaleman and @sbueringer
Changed it
Add all Go runtime metrics

collectors.WithGoCollectorRuntimeMetrics(
collectors.MetricsGC,
collectors.MetricsScheduler,
collectors.MetricsMemory,
collectors.GoRuntimeMetricsRule{Matcher: regexp.MustCompile(`^/sync/.*`)},
),
),
)
}
Loading