2015-07-06 17:54:22 -07:00
|
|
|
// Copyright 2015 The go-ethereum Authors
|
2015-07-22 09:48:40 -07:00
|
|
|
// This file is part of the go-ethereum library.
|
2015-07-06 17:54:22 -07:00
|
|
|
//
|
2015-07-23 09:35:11 -07:00
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
2015-07-06 17:54:22 -07:00
|
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
|
|
// (at your option) any later version.
|
|
|
|
//
|
2015-07-22 09:48:40 -07:00
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
2015-07-06 17:54:22 -07:00
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-07-22 09:48:40 -07:00
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2015-07-06 17:54:22 -07:00
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
2015-07-22 09:48:40 -07:00
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
2015-07-06 17:54:22 -07:00
|
|
|
|
2015-06-27 08:12:58 -07:00
|
|
|
// Package metrics provides general system and process level metrics collection.
|
|
|
|
package metrics
|
|
|
|
|
|
|
|
import (
|
2015-06-29 06:11:01 -07:00
|
|
|
"os"
|
2015-06-27 08:12:58 -07:00
|
|
|
"runtime"
|
2015-06-29 06:11:01 -07:00
|
|
|
"strings"
|
2015-06-27 08:12:58 -07:00
|
|
|
"time"
|
|
|
|
|
2017-02-22 04:10:07 -08:00
|
|
|
"github.com/ethereum/go-ethereum/log"
|
2015-06-27 08:12:58 -07:00
|
|
|
"github.com/rcrowley/go-metrics"
|
2016-10-14 00:22:31 -07:00
|
|
|
"github.com/rcrowley/go-metrics/exp"
|
2015-06-27 08:12:58 -07:00
|
|
|
)
|
|
|
|
|
2015-06-29 06:11:01 -07:00
|
|
|
// MetricsEnabledFlag is the CLI flag name to use to enable metrics collections.
|
2017-08-21 23:35:09 -07:00
|
|
|
const MetricsEnabledFlag = "metrics"
|
2015-06-29 06:11:01 -07:00
|
|
|
|
2015-07-02 04:13:46 -07:00
|
|
|
// Enabled is the flag specifying if metrics are enable or not.
|
|
|
|
var Enabled = false
|
2015-06-29 06:11:01 -07:00
|
|
|
|
|
|
|
// Init enables or disables the metrics system. Since we need this to run before
|
|
|
|
// any other code gets to create meters and timers, we'll actually do an ugly hack
|
|
|
|
// and peek into the command line args for the metrics flag.
|
|
|
|
func init() {
|
|
|
|
for _, arg := range os.Args {
|
|
|
|
if strings.TrimLeft(arg, "-") == MetricsEnabledFlag {
|
2017-03-03 01:41:52 -08:00
|
|
|
log.Info("Enabling metrics collection")
|
2015-07-02 04:13:46 -07:00
|
|
|
Enabled = true
|
2015-06-29 06:11:01 -07:00
|
|
|
}
|
|
|
|
}
|
2016-10-14 00:22:31 -07:00
|
|
|
exp.Exp(metrics.DefaultRegistry)
|
2015-06-29 06:11:01 -07:00
|
|
|
}
|
|
|
|
|
2016-11-01 05:46:11 -07:00
|
|
|
// NewCounter create a new metrics Counter, either a real one of a NOP stub depending
|
|
|
|
// on the metrics flag.
|
|
|
|
func NewCounter(name string) metrics.Counter {
|
|
|
|
if !Enabled {
|
|
|
|
return new(metrics.NilCounter)
|
|
|
|
}
|
|
|
|
return metrics.GetOrRegisterCounter(name, metrics.DefaultRegistry)
|
|
|
|
}
|
|
|
|
|
2015-06-29 06:11:01 -07:00
|
|
|
// NewMeter create a new metrics Meter, either a real one of a NOP stub depending
|
|
|
|
// on the metrics flag.
|
|
|
|
func NewMeter(name string) metrics.Meter {
|
2015-07-02 04:13:46 -07:00
|
|
|
if !Enabled {
|
2015-06-29 06:11:01 -07:00
|
|
|
return new(metrics.NilMeter)
|
|
|
|
}
|
|
|
|
return metrics.GetOrRegisterMeter(name, metrics.DefaultRegistry)
|
|
|
|
}
|
|
|
|
|
|
|
|
// NewTimer create a new metrics Timer, either a real one of a NOP stub depending
|
|
|
|
// on the metrics flag.
|
|
|
|
func NewTimer(name string) metrics.Timer {
|
2015-07-02 04:13:46 -07:00
|
|
|
if !Enabled {
|
2015-06-29 06:11:01 -07:00
|
|
|
return new(metrics.NilTimer)
|
|
|
|
}
|
|
|
|
return metrics.GetOrRegisterTimer(name, metrics.DefaultRegistry)
|
|
|
|
}
|
|
|
|
|
2015-06-27 08:12:58 -07:00
|
|
|
// CollectProcessMetrics periodically collects various metrics about the running
|
|
|
|
// process.
|
|
|
|
func CollectProcessMetrics(refresh time.Duration) {
|
2015-06-29 06:11:01 -07:00
|
|
|
// Short circuit if the metrics system is disabled
|
2015-07-02 04:13:46 -07:00
|
|
|
if !Enabled {
|
2015-06-29 06:11:01 -07:00
|
|
|
return
|
|
|
|
}
|
2015-06-27 08:12:58 -07:00
|
|
|
// Create the various data collectors
|
|
|
|
memstats := make([]*runtime.MemStats, 2)
|
|
|
|
diskstats := make([]*DiskStats, 2)
|
|
|
|
for i := 0; i < len(memstats); i++ {
|
|
|
|
memstats[i] = new(runtime.MemStats)
|
|
|
|
diskstats[i] = new(DiskStats)
|
|
|
|
}
|
|
|
|
// Define the various metrics to collect
|
|
|
|
memAllocs := metrics.GetOrRegisterMeter("system/memory/allocs", metrics.DefaultRegistry)
|
|
|
|
memFrees := metrics.GetOrRegisterMeter("system/memory/frees", metrics.DefaultRegistry)
|
|
|
|
memInuse := metrics.GetOrRegisterMeter("system/memory/inuse", metrics.DefaultRegistry)
|
|
|
|
memPauses := metrics.GetOrRegisterMeter("system/memory/pauses", metrics.DefaultRegistry)
|
|
|
|
|
|
|
|
var diskReads, diskReadBytes, diskWrites, diskWriteBytes metrics.Meter
|
|
|
|
if err := ReadDiskStats(diskstats[0]); err == nil {
|
|
|
|
diskReads = metrics.GetOrRegisterMeter("system/disk/readcount", metrics.DefaultRegistry)
|
|
|
|
diskReadBytes = metrics.GetOrRegisterMeter("system/disk/readdata", metrics.DefaultRegistry)
|
|
|
|
diskWrites = metrics.GetOrRegisterMeter("system/disk/writecount", metrics.DefaultRegistry)
|
|
|
|
diskWriteBytes = metrics.GetOrRegisterMeter("system/disk/writedata", metrics.DefaultRegistry)
|
|
|
|
} else {
|
2017-03-03 01:41:52 -08:00
|
|
|
log.Debug("Failed to read disk metrics", "err", err)
|
2015-06-27 08:12:58 -07:00
|
|
|
}
|
|
|
|
// Iterate loading the different stats and updating the meters
|
|
|
|
for i := 1; ; i++ {
|
|
|
|
runtime.ReadMemStats(memstats[i%2])
|
|
|
|
memAllocs.Mark(int64(memstats[i%2].Mallocs - memstats[(i-1)%2].Mallocs))
|
|
|
|
memFrees.Mark(int64(memstats[i%2].Frees - memstats[(i-1)%2].Frees))
|
|
|
|
memInuse.Mark(int64(memstats[i%2].Alloc - memstats[(i-1)%2].Alloc))
|
|
|
|
memPauses.Mark(int64(memstats[i%2].PauseTotalNs - memstats[(i-1)%2].PauseTotalNs))
|
|
|
|
|
|
|
|
if ReadDiskStats(diskstats[i%2]) == nil {
|
2017-11-10 09:06:45 -08:00
|
|
|
diskReads.Mark(diskstats[i%2].ReadCount - diskstats[(i-1)%2].ReadCount)
|
|
|
|
diskReadBytes.Mark(diskstats[i%2].ReadBytes - diskstats[(i-1)%2].ReadBytes)
|
|
|
|
diskWrites.Mark(diskstats[i%2].WriteCount - diskstats[(i-1)%2].WriteCount)
|
|
|
|
diskWriteBytes.Mark(diskstats[i%2].WriteBytes - diskstats[(i-1)%2].WriteBytes)
|
2015-06-27 08:12:58 -07:00
|
|
|
}
|
|
|
|
time.Sleep(refresh)
|
|
|
|
}
|
|
|
|
}
|