Skip to content
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

Jump to bottom

pkg/metrics: add common go&gRPC prometheus metrics #1416

Merged
merged 1 commit into from
Sep 4, 2023
Merged

pkg/metrics: add common go&gRPC prometheus metrics #1416

merged 1 commit into from
Sep 4, 2023

Conversation

Jack-R-lantern
Copy link
Contributor

@Jack-R-lantern Jack-R-lantern commented Sep 1, 2023 •
edited
Loading

  • add NewGoCollector
  • add NewProcessCollector
  • add NewServerMetrics
  • add buildInfoCollector
  • update go.mod, go.sum
  • update vendor

Fixed: #1406

metric result

# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 3.7468e-05
go_gc_duration_seconds{quantile="0.25"} 4.4228e-05
go_gc_duration_seconds{quantile="0.5"} 6.1448e-05
go_gc_duration_seconds{quantile="0.75"} 6.3302e-05
go_gc_duration_seconds{quantile="1"} 0.000115121
go_gc_duration_seconds_sum 0.000596817
go_gc_duration_seconds_count 10
# HELP go_goroutines Number of goroutines that currently exist.
# TYPE go_goroutines gauge
go_goroutines 20
# HELP go_info Information about the Go environment.
# TYPE go_info gauge
go_info{version="go1.20.1"} 1
# HELP go_memstats_alloc_bytes Number of bytes allocated and still in use.
# TYPE go_memstats_alloc_bytes gauge
go_memstats_alloc_bytes 3.7614976e+07
# HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed.
# TYPE go_memstats_alloc_bytes_total counter
go_memstats_alloc_bytes_total 1.18752656e+08
# HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table.
# TYPE go_memstats_buck_hash_sys_bytes gauge
go_memstats_buck_hash_sys_bytes 1.573059e+06
# HELP go_memstats_frees_total Total number of frees.
# TYPE go_memstats_frees_total counter
go_memstats_frees_total 953574
# HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata.
# TYPE go_memstats_gc_sys_bytes gauge
go_memstats_gc_sys_bytes 9.23196e+06
# HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use.
# TYPE go_memstats_heap_alloc_bytes gauge
go_memstats_heap_alloc_bytes 3.7614976e+07
# HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used.
# TYPE go_memstats_heap_idle_bytes gauge
go_memstats_heap_idle_bytes 1.814528e+07
# HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use.
# TYPE go_memstats_heap_inuse_bytes gauge
go_memstats_heap_inuse_bytes 3.9788544e+07
# HELP go_memstats_heap_objects Number of allocated objects.
# TYPE go_memstats_heap_objects gauge
go_memstats_heap_objects 384596
# HELP go_memstats_heap_released_bytes Number of heap bytes released to OS.
# TYPE go_memstats_heap_released_bytes gauge
go_memstats_heap_released_bytes 7.356416e+06
# HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system.
# TYPE go_memstats_heap_sys_bytes gauge
go_memstats_heap_sys_bytes 5.7933824e+07
# HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection.
# TYPE go_memstats_last_gc_time_seconds gauge
go_memstats_last_gc_time_seconds 1.6937564769359372e+09
# HELP go_memstats_lookups_total Total number of pointer lookups.
# TYPE go_memstats_lookups_total counter
go_memstats_lookups_total 0
# HELP go_memstats_mallocs_total Total number of mallocs.
# TYPE go_memstats_mallocs_total counter
go_memstats_mallocs_total 1.33817e+06
# HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures.
# TYPE go_memstats_mcache_inuse_bytes gauge
go_memstats_mcache_inuse_bytes 9600
# HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system.
# TYPE go_memstats_mcache_sys_bytes gauge
go_memstats_mcache_sys_bytes 15600
# HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures.
# TYPE go_memstats_mspan_inuse_bytes gauge
go_memstats_mspan_inuse_bytes 490240
# HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system.
# TYPE go_memstats_mspan_sys_bytes gauge
go_memstats_mspan_sys_bytes 587520
# HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place.
# TYPE go_memstats_next_gc_bytes gauge
go_memstats_next_gc_bytes 8.0401944e+07
# HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations.
# TYPE go_memstats_other_sys_bytes gauge
go_memstats_other_sys_bytes 1.326569e+06
# HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator.
# TYPE go_memstats_stack_inuse_bytes gauge
go_memstats_stack_inuse_bytes 786432
# HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator.
# TYPE go_memstats_stack_sys_bytes gauge
go_memstats_stack_sys_bytes 786432
# HELP go_memstats_sys_bytes Number of bytes obtained from system.
# TYPE go_memstats_sys_bytes gauge
go_memstats_sys_bytes 7.1454964e+07
# HELP go_threads Number of OS threads created.
# TYPE go_threads gauge
go_threads 14
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 0.62
# HELP process_max_fds Maximum number of open file descriptors.
# TYPE process_max_fds gauge
process_max_fds 1.048576e+06
# HELP process_open_fds Number of open file descriptors.
# TYPE process_open_fds gauge
process_open_fds 37
# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 1.01322752e+08
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1.69375647581e+09
# HELP process_virtual_memory_bytes Virtual memory size in bytes.
# TYPE process_virtual_memory_bytes gauge
process_virtual_memory_bytes 8.03581952e+08
# HELP process_virtual_memory_max_bytes Maximum amount of virtual memory available in bytes.
# TYPE process_virtual_memory_max_bytes gauge
process_virtual_memory_max_bytes 1.8446744073709552e+19
# HELP tetragon_build_info Build information about tetragon
# TYPE tetragon_build_info gauge
tetragon_build_info{commit="331d228b57c82567763f49e7baaa1c94ec3a5f7a",go_version="go1.20.1",modified="true",time="2023-09-03T14:07:01Z"} 1

@Jack-R-lantern Jack-R-lantern force-pushed the ISSUE-1406/Add-common-Go-and-gRPC-Prometheus-metrics branch from 331d228 to e34cb59 Compare September 3, 2023 15:44
@Jack-R-lantern Jack-R-lantern marked this pull request as ready for review September 3, 2023 15:53
@Jack-R-lantern Jack-R-lantern requested a review from a team as a code owner September 3, 2023 15:53
@Jack-R-lantern Jack-R-lantern changed the title pkg/metrics: add prometheus collector pkg/metrics: add common go&gRPC prometheus collector Sep 3, 2023
@Jack-R-lantern Jack-R-lantern changed the title pkg/metrics: add common go&gRPC prometheus collector pkg/metrics: add common go&gRPC prometheus metrics Sep 3, 2023
lambdanis
lambdanis requested changes Sep 4, 2023
View reviewed changes
Copy link
Contributor

@lambdanis lambdanis left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thank you for tackling this @Jack-R-lantern!

Could we register common collectors directly inside InitAllMetrics instead of defining a separate wrapper package for each of them? These extra packages seem unnecessary.

@lambdanis lambdanis added the release-note/minor This PR introduces a minor user-visible change label Sep 4, 2023
@Jack-R-lantern
Copy link
Contributor Author

@lambdanis sure!

lambdanis
lambdanis requested changes Sep 4, 2023
View reviewed changes
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

One more request about pkg structure.

It seems that vendor check fails in CI, can you run make vendor once again?

pkg/metrics/buildinfo/buildinfo.go Outdated
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Tetragon

package buildinfo
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we move this file under pkg/version/metrics.go instead of defining a new package here? I think it fits there.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@lambdanis that's good idea, thanks feedback

@Jack-R-lantern
pkg/metrics: add common go&grpc prometheus metrics
a8aa8e5 
- add NewGoCollector
- add NewProcessCollector
- add NewServerMetrics
- add pkg/version/metrics.go
  - buildInfoCollector
- update go.mod, go.sum
- update vendor

Signed-off-by: Jack-R-lantern <tjdfkr2421@gmail.com>
@Jack-R-lantern Jack-R-lantern force-pushed the ISSUE-1406/Add-common-Go-and-gRPC-Prometheus-metrics branch from e34cb59 to a8aa8e5 Compare September 4, 2023 11:37
lambdanis
lambdanis approved these changes Sep 4, 2023
View reviewed changes
Copy link
Contributor

@lambdanis lambdanis left a comment

Choose a reason for hiding this comment

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

looks good, thanks

@lambdanis lambdanis merged commit 005f3d3 into cilium:main Sep 4, 2023
@p-linnane p-linnane mentioned this pull request Nov 1, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lambdanis lambdanis lambdanis approved these changes

@tixxdz tixxdz Awaiting requested review from tixxdz tixxdz is a code owner automatically assigned from cilium/tetragon

Assignees
No one assigned
Labels
release-note/minor This PR introduces a minor user-visible change
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add common Go & gRPC Prometheus metrics
2 participants
@Jack-R-lantern @lambdanis