var MetricsAll … var MetricsGC … var MetricsMemory … var MetricsScheduler … // WithGoCollectorMemStatsMetricsDisabled disables metrics that is gathered in runtime.MemStats structure such as: // // go_memstats_alloc_bytes // go_memstats_alloc_bytes_total // go_memstats_sys_bytes // go_memstats_lookups_total // go_memstats_mallocs_total // go_memstats_frees_total // go_memstats_heap_alloc_bytes // go_memstats_heap_sys_bytes // go_memstats_heap_idle_bytes // go_memstats_heap_inuse_bytes // go_memstats_heap_released_bytes // go_memstats_heap_objects // go_memstats_stack_inuse_bytes // go_memstats_stack_sys_bytes // go_memstats_mspan_inuse_bytes // go_memstats_mspan_sys_bytes // go_memstats_mcache_inuse_bytes // go_memstats_mcache_sys_bytes // go_memstats_buck_hash_sys_bytes // go_memstats_gc_sys_bytes // go_memstats_other_sys_bytes // go_memstats_next_gc_bytes // // so the metrics known from pre client_golang v1.12.0, // // NOTE(bwplotka): The above represents runtime.MemStats statistics, but they are // actually implemented using new runtime/metrics package. (except skipped go_memstats_gc_cpu_fraction // -- see https://github.com/prometheus/client_golang/issues/842#issuecomment-861812034 for explanation). // // Some users might want to disable this on collector level (although you can use scrape relabelling on Prometheus), // because similar metrics can be now obtained using WithGoCollectorRuntimeMetrics. Note that the semantics of new // metrics might be different, plus the names can be change over time with different Go version. // // NOTE(bwplotka): Changing metric names can be tedious at times as the alerts, recording rules and dashboards have to be adjusted. // The old metrics are also very useful, with many guides and books written about how to interpret them. // // As a result our recommendation would be to stick with MemStats like metrics and enable other runtime/metrics if you are interested // in advanced insights Go provides. See ExampleGoCollector_WithAdvancedGoMetrics. func WithGoCollectorMemStatsMetricsDisabled() func(options *internal.GoCollectorOptions) { … } type GoRuntimeMetricsRule … // WithGoCollectorRuntimeMetrics allows enabling and configuring particular group of runtime/metrics. // See the list of metrics https://golang.bg/src/runtime/metrics/description.go (pick the Go version you use there!). // You can use this option in repeated manner, which will add new rules. The order of rules is important, the last rule // that matches particular metrics is applied. func WithGoCollectorRuntimeMetrics(rules ...GoRuntimeMetricsRule) func(options *internal.GoCollectorOptions) { … } // WithoutGoCollectorRuntimeMetrics allows disabling group of runtime/metrics that you might have added in WithGoCollectorRuntimeMetrics. // It behaves similarly to WithGoCollectorRuntimeMetrics just with deny-list semantics. func WithoutGoCollectorRuntimeMetrics(matchers ...*regexp.Regexp) func(options *internal.GoCollectorOptions) { … } type GoCollectionOption … const GoRuntimeMemStatsCollection … const GoRuntimeMetricsCollection … // WithGoCollections allows enabling different collections for Go collector on top of base metrics. // // Deprecated: Use WithGoCollectorRuntimeMetrics() and WithGoCollectorMemStatsMetricsDisabled() instead to control metrics. func WithGoCollections(flags GoCollectionOption) func(options *internal.GoCollectorOptions) { … } // NewGoCollector returns a collector that exports metrics about the current Go // process using debug.GCStats (base metrics) and runtime/metrics (both in MemStats style and new ones). func NewGoCollector(opts ...func(o *internal.GoCollectorOptions)) prometheus.Collector { … }
Codebase Browser
kubernetes