Add All Go metrics to admin endpoint default #629
Merged
Conversation
This file contains 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
SuperQ
requested review from
fishy,
kylelemons and
pacejackson
and removed request for
a team
fishy
requested changes
Sep 13, 2023
| @@ -9,7 +9,22 @@ import ( | |||
| ) | |||
|
|
|||
| var expectedMetrics = []string{ | |||
There was a problem hiding this comment.
looks like on go 1.21 we got more than these: https://github.com/reddit/baseplate.go/actions/runs/6173805147/job/16756970260?pr=629
maybe instead of using diff for this test (equal), we only check that all the expectedMetrics are reported instead (minimal)?
There was a problem hiding this comment.
Updated tests for Go >= 1.21
There was a problem hiding this comment.
The other thing we could do is create our own custom filter and only include the metrics we want.
RedditMetricsGC = collectors.GoRuntimeMetricsRule{regexp.MustCompile(`^/gc/.*`)}
There was a problem hiding this comment.
the new ones added in go 1.21 are also go_gc_.*, it just report more gc metrics in go 1.21 so that likely won't work,
There was a problem hiding this comment.
I meant that we could customize this regexp, not use the default.
fishy
approved these changes
Sep 13, 2023
fishy
reviewed
Sep 13, 2023
kylelemons
reviewed
Sep 28, 2023
SuperQ
force-pushed
the
MetricsGC
branch
2 times, most recently
from
21d61da
to
6e3f72c
Compare
|
Updated now that 1.21 is the minimum version. |
kylelemons
approved these changes
Mar 12, 2024
SuperQ
changed the title
|
Updated to include MetricsAll. |
Add All Go `runtime/metrics` to the default included metrics. This will add several new metrics per process: * `go_cgo_go_to_c_calls_calls_total` * `go_cpu_classes_gc_mark_assist_cpu_seconds_total` * `go_cpu_classes_gc_mark_dedicated_cpu_seconds_total` * `go_cpu_classes_gc_mark_idle_cpu_seconds_total` * `go_cpu_classes_gc_pause_cpu_seconds_total` * `go_cpu_classes_gc_total_cpu_seconds_total` * `go_cpu_classes_idle_cpu_seconds_total` * `go_cpu_classes_scavenge_assist_cpu_seconds_total` * `go_cpu_classes_scavenge_background_cpu_seconds_total` * `go_cpu_classes_scavenge_total_cpu_seconds_total` * `go_cpu_classes_total_cpu_seconds_total` * `go_cpu_classes_user_cpu_seconds_total` * `go_gc_cycles_automatic_gc_cycles_total` * `go_gc_cycles_forced_gc_cycles_total` * `go_gc_cycles_total_gc_cycles_total` * `go_gc_gogc_percent` * `go_gc_gomemlimit_bytes` * `go_gc_heap_allocs_by_size_bytes` * `go_gc_heap_allocs_bytes_total` * `go_gc_heap_allocs_objects_total` * `go_gc_heap_frees_by_size_bytes` * `go_gc_heap_frees_bytes_total` * `go_gc_heap_frees_objects_total` * `go_gc_heap_goal_bytes` * `go_gc_heap_live_bytes` * `go_gc_heap_objects_objects` * `go_gc_heap_tiny_allocs_objects_total` * `go_gc_limiter_last_enabled_gc_cycle` * `go_gc_pauses_seconds` * `go_gc_scan_globals_bytes` * `go_gc_scan_heap_bytes` * `go_gc_scan_stack_bytes` * `go_gc_scan_total_bytes` * `go_gc_stack_starting_size_bytes` * `go_godebug_non_default_behavior_execerrdot_events_total` * `go_godebug_non_default_behavior_gocachehash_events_total` * `go_godebug_non_default_behavior_gocachetest_events_total` * `go_godebug_non_default_behavior_gocacheverify_events_total` * `go_godebug_non_default_behavior_gotypesalias_events_total` * `go_godebug_non_default_behavior_http2client_events_total` * `go_godebug_non_default_behavior_http2server_events_total` * `go_godebug_non_default_behavior_httplaxcontentlength_events_total` * `go_godebug_non_default_behavior_httpmuxgo121_events_total` * `go_godebug_non_default_behavior_installgoroot_events_total` * `go_godebug_non_default_behavior_jstmpllitinterp_events_total` * `go_godebug_non_default_behavior_multipartmaxheaders_events_total` * `go_godebug_non_default_behavior_multipartmaxparts_events_total` * `go_godebug_non_default_behavior_multipathtcp_events_total` * `go_godebug_non_default_behavior_panicnil_events_total` * `go_godebug_non_default_behavior_randautoseed_events_total` * `go_godebug_non_default_behavior_tarinsecurepath_events_total` * `go_godebug_non_default_behavior_tls10server_events_total` * `go_godebug_non_default_behavior_tlsmaxrsasize_events_total` * `go_godebug_non_default_behavior_tlsrsakex_events_total` * `go_godebug_non_default_behavior_tlsunsafeekm_events_total` * `go_godebug_non_default_behavior_x509sha1_events_total` * `go_godebug_non_default_behavior_x509usefallbackroots_events_total` * `go_godebug_non_default_behavior_x509usepolicies_events_total` * `go_godebug_non_default_behavior_zipinsecurepath_events_total` * `go_memory_classes_heap_free_bytes` * `go_memory_classes_heap_objects_bytes` * `go_memory_classes_heap_released_bytes` * `go_memory_classes_heap_stacks_bytes` * `go_memory_classes_heap_unused_bytes` * `go_memory_classes_metadata_mcache_free_bytes` * `go_memory_classes_metadata_mcache_inuse_bytes` * `go_memory_classes_metadata_mspan_free_bytes` * `go_memory_classes_metadata_mspan_inuse_bytes` * `go_memory_classes_metadata_other_bytes` * `go_memory_classes_os_stacks_bytes` * `go_memory_classes_other_bytes` * `go_memory_classes_profiling_buckets_bytes` * `go_memory_classes_total_bytes` * `go_sched_pauses_stopping_gc_seconds` * `go_sched_pauses_stopping_other_seconds` * `go_sched_pauses_total_gc_seconds` * `go_sched_pauses_total_other_seconds` * `go_sync_mutex_wait_total_seconds_total` Signed-off-by: SuperQ <[email protected]>
Signed-off-by: SuperQ <[email protected]>
fishy
approved these changes
Mar 12, 2024
There was a problem hiding this comment.
I'm still not sure that having an unit test to ensure that everything defined in upstream packages (go itself and prometheus) that we don't control is a good idea and scales well. I think the unit test should be changed to check for subset (makes sure a few key metrics are there) instead of equal.
|
The unit test is already setup as a subset check. It only checks one-way, if the expected list is in the output set. Not the other way around. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #
💸 TL;DR
Add All Go
runtime/metricsto the default included metrics.This will add several new metrics per process:
go_cgo_go_to_c_calls_calls_totalgo_cpu_classes_gc_mark_assist_cpu_seconds_totalgo_cpu_classes_gc_mark_dedicated_cpu_seconds_totalgo_cpu_classes_gc_mark_idle_cpu_seconds_totalgo_cpu_classes_gc_pause_cpu_seconds_totalgo_cpu_classes_gc_total_cpu_seconds_totalgo_cpu_classes_idle_cpu_seconds_totalgo_cpu_classes_scavenge_assist_cpu_seconds_totalgo_cpu_classes_scavenge_background_cpu_seconds_totalgo_cpu_classes_scavenge_total_cpu_seconds_totalgo_cpu_classes_total_cpu_seconds_totalgo_cpu_classes_user_cpu_seconds_totalgo_gc_cycles_automatic_gc_cycles_totalgo_gc_cycles_forced_gc_cycles_totalgo_gc_cycles_total_gc_cycles_totalgo_gc_gogc_percentgo_gc_gomemlimit_bytesgo_gc_heap_allocs_by_size_bytesgo_gc_heap_allocs_bytes_totalgo_gc_heap_allocs_objects_totalgo_gc_heap_frees_by_size_bytesgo_gc_heap_frees_bytes_totalgo_gc_heap_frees_objects_totalgo_gc_heap_goal_bytesgo_gc_heap_live_bytesgo_gc_heap_objects_objectsgo_gc_heap_tiny_allocs_objects_totalgo_gc_limiter_last_enabled_gc_cyclego_gc_pauses_secondsgo_gc_scan_globals_bytesgo_gc_scan_heap_bytesgo_gc_scan_stack_bytesgo_gc_scan_total_bytesgo_gc_stack_starting_size_bytesgo_godebug_non_default_behavior_execerrdot_events_totalgo_godebug_non_default_behavior_gocachehash_events_totalgo_godebug_non_default_behavior_gocachetest_events_totalgo_godebug_non_default_behavior_gocacheverify_events_totalgo_godebug_non_default_behavior_gotypesalias_events_totalgo_godebug_non_default_behavior_http2client_events_totalgo_godebug_non_default_behavior_http2server_events_totalgo_godebug_non_default_behavior_httplaxcontentlength_events_totalgo_godebug_non_default_behavior_httpmuxgo121_events_totalgo_godebug_non_default_behavior_installgoroot_events_totalgo_godebug_non_default_behavior_jstmpllitinterp_events_totalgo_godebug_non_default_behavior_multipartmaxheaders_events_totalgo_godebug_non_default_behavior_multipartmaxparts_events_totalgo_godebug_non_default_behavior_multipathtcp_events_totalgo_godebug_non_default_behavior_panicnil_events_totalgo_godebug_non_default_behavior_randautoseed_events_totalgo_godebug_non_default_behavior_tarinsecurepath_events_totalgo_godebug_non_default_behavior_tls10server_events_totalgo_godebug_non_default_behavior_tlsmaxrsasize_events_totalgo_godebug_non_default_behavior_tlsrsakex_events_totalgo_godebug_non_default_behavior_tlsunsafeekm_events_totalgo_godebug_non_default_behavior_x509sha1_events_totalgo_godebug_non_default_behavior_x509usefallbackroots_events_totalgo_godebug_non_default_behavior_x509usepolicies_events_totalgo_godebug_non_default_behavior_zipinsecurepath_events_totalgo_memory_classes_heap_free_bytesgo_memory_classes_heap_objects_bytesgo_memory_classes_heap_released_bytesgo_memory_classes_heap_stacks_bytesgo_memory_classes_heap_unused_bytesgo_memory_classes_metadata_mcache_free_bytesgo_memory_classes_metadata_mcache_inuse_bytesgo_memory_classes_metadata_mspan_free_bytesgo_memory_classes_metadata_mspan_inuse_bytesgo_memory_classes_metadata_other_bytesgo_memory_classes_os_stacks_bytesgo_memory_classes_other_bytesgo_memory_classes_profiling_buckets_bytesgo_memory_classes_total_bytesgo_sched_pauses_stopping_gc_secondsgo_sched_pauses_stopping_other_secondsgo_sched_pauses_total_gc_secondsgo_sched_pauses_total_other_secondsgo_sync_mutex_wait_total_seconds_total📜 Details
Design Doc
Jira
🧪 Testing Steps / Validation
✅ Checks