From a2a87456d7fac99d4c52bc473fe14545b00cdd72 Mon Sep 17 00:00:00 2001 From: Anton Evangelatov Date: Thu, 14 Jun 2018 14:42:04 +0300 Subject: [PATCH] cmd/geth: update usage fields for metrics flags --- cmd/geth/main.go | 2 +- cmd/geth/usage.go | 13 ++++++++++++- cmd/utils/flags.go | 26 +++++++++++++------------- 3 files changed, 26 insertions(+), 15 deletions(-) diff --git a/cmd/geth/main.go b/cmd/geth/main.go index c46468169b..f4a0ac5df6 100644 --- a/cmd/geth/main.go +++ b/cmd/geth/main.go @@ -146,7 +146,7 @@ var ( } metricsFlags = []cli.Flag{ - utils.MetricsEnableInfluxDBExportFlag, + utils.MetricsEnableInfluxDBFlag, utils.MetricsInfluxDBEndpointFlag, utils.MetricsInfluxDBDatabaseFlag, utils.MetricsInfluxDBUsernameFlag, diff --git a/cmd/geth/usage.go b/cmd/geth/usage.go index d934c6b021..06db64664e 100644 --- a/cmd/geth/usage.go +++ b/cmd/geth/usage.go @@ -206,11 +206,22 @@ var AppHelpFlagGroups = []flagGroup{ { Name: "LOGGING AND DEBUGGING", Flags: append([]cli.Flag{ - utils.MetricsEnabledFlag, utils.FakePoWFlag, utils.NoCompactionFlag, }, debug.Flags...), }, + { + Name: "METRICS AND STATS", + Flags: []cli.Flag{ + utils.MetricsEnabledFlag, + utils.MetricsEnableInfluxDBFlag, + utils.MetricsInfluxDBEndpointFlag, + utils.MetricsInfluxDBDatabaseFlag, + utils.MetricsInfluxDBUsernameFlag, + utils.MetricsInfluxDBPasswordFlag, + utils.MetricsInfluxDBHostTagFlag, + }, + }, { Name: "WHISPER (EXPERIMENTAL)", Flags: whisperFlags, diff --git a/cmd/utils/flags.go b/cmd/utils/flags.go index ef1594086d..ff549c0c2d 100644 --- a/cmd/utils/flags.go +++ b/cmd/utils/flags.go @@ -362,10 +362,6 @@ var ( Name: "ethstats", Usage: "Reporting URL of a ethstats service (nodename:secret@host:port)", } - MetricsEnabledFlag = cli.BoolFlag{ - Name: metrics.MetricsEnabledFlag, - Usage: "Enable metrics collection and reporting", - } FakePoWFlag = cli.BoolFlag{ Name: "fakepow", Usage: "Disables proof-of-work verification", @@ -536,28 +532,32 @@ var ( } // Metrics flags - MetricsEnableInfluxDBExportFlag = cli.BoolFlag{ - Name: "metrics.influxdb.export", + MetricsEnabledFlag = cli.BoolFlag{ + Name: metrics.MetricsEnabledFlag, + Usage: "Enable metrics collection and reporting", + } + MetricsEnableInfluxDBFlag = cli.BoolFlag{ + Name: "metrics.influxdb", Usage: "Enable metrics export/push to an external InfluxDB database", } MetricsInfluxDBEndpointFlag = cli.StringFlag{ Name: "metrics.influxdb.endpoint", - Usage: "Metrics InfluxDB endpoint", + Usage: "InfluxDB API endpoint to report metrics to", Value: "http://localhost:8086", } MetricsInfluxDBDatabaseFlag = cli.StringFlag{ Name: "metrics.influxdb.database", - Usage: "Metrics InfluxDB database", - Value: "metrics", + Usage: "InfluxDB database name to push reported metrics to", + Value: "geth", } MetricsInfluxDBUsernameFlag = cli.StringFlag{ Name: "metrics.influxdb.username", - Usage: "Metrics InfluxDB username", + Usage: "Username to authorize access to the database", Value: "test", } MetricsInfluxDBPasswordFlag = cli.StringFlag{ Name: "metrics.influxdb.password", - Usage: "Metrics InfluxDB password", + Usage: "Password to authorize access to the database", Value: "test", } // The `host` tag is part of every measurement sent to InfluxDB. Queries on tags are faster in InfluxDB. @@ -566,7 +566,7 @@ var ( // https://docs.influxdata.com/influxdb/v1.4/concepts/key_concepts/#tag-key MetricsInfluxDBHostTagFlag = cli.StringFlag{ Name: "metrics.influxdb.host.tag", - Usage: "Metrics InfluxDB `host` tag attached to all measurements", + Usage: "InfluxDB `host` tag attached to all measurements", Value: "localhost", } ) @@ -1222,7 +1222,7 @@ func SetupMetrics(ctx *cli.Context) { if metrics.Enabled { log.Info("Enabling metrics collection") var ( - enableExport = ctx.GlobalBool(MetricsEnableInfluxDBExportFlag.Name) + enableExport = ctx.GlobalBool(MetricsEnableInfluxDBFlag.Name) endpoint = ctx.GlobalString(MetricsInfluxDBEndpointFlag.Name) database = ctx.GlobalString(MetricsInfluxDBDatabaseFlag.Name) username = ctx.GlobalString(MetricsInfluxDBUsernameFlag.Name)