clean flag name + update swagger

vechain · Mar 26, 2024 · 3825cdf · 3825cdf
1 parent 4d51cd1
commit 3825cdf
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/api/doc/thor.yaml b/api/doc/thor.yaml
@@ -747,6 +747,7 @@ paths:
       summary: Retrieve Prometheus metrics
       description: |
         This endpoint allows clients to retrieve Prometheus metrics.
+        Note: Will not respond to request if the `telemetry-enabled` flag is set to false.
       responses:
         '200':
           description: Prometheus metrics response

diff --git a/cmd/thor/flags.go b/cmd/thor/flags.go
@@ -142,8 +142,8 @@ var (
 		Value: 16,
 		Usage: "set tx limit per account in pool",
 	}
-	enableTelemetryFlag = cli.BoolTFlag{
-		Name:  "enable-telemetry",
+	telemetryEnabledFlag = cli.BoolTFlag{
+		Name:  "telemetry-enabled",
 		Usage: "enables telemetry server",
 	}
 	telemetryAddrFlag = cli.StringFlag{

diff --git a/cmd/thor/main.go b/cmd/thor/main.go
@@ -87,7 +87,7 @@ func main() {
 			pprofFlag,
 			verifyLogsFlag,
 			disablePrunerFlag,
-			enableTelemetryFlag,
+			telemetryEnabledFlag,
 			telemetryAddrFlag,
 		},
 		Action: defaultAction,
@@ -114,7 +114,7 @@ func main() {
 					txPoolLimitFlag,
 					txPoolLimitPerAccountFlag,
 					disablePrunerFlag,
-					enableTelemetryFlag,
+					telemetryEnabledFlag,
 					telemetryAddrFlag,
 				},
 				Action: soloAction,
@@ -147,7 +147,7 @@ func defaultAction(ctx *cli.Context) error {
 
 	// enable telemetry as soon as possible
 	telemetryServerURL := "Disabled"
-	enableTelemetry := ctx.BoolT(enableTelemetryFlag.Name)
+	enableTelemetry := ctx.BoolT(telemetryEnabledFlag.Name)
 	if enableTelemetry {
 		telemetry.InitializePrometheusTelemetry()
 		telemetryServer, telemetryCloseFunc, err := startTelemetryServer(ctx.String(telemetryAddrFlag.Name), ctx.String(apiCorsFlag.Name))
@@ -268,7 +268,7 @@ func soloAction(ctx *cli.Context) error {
 
 	// enable telemetry as soon as possible
 	telemetryServerURL := "Disabled"
-	enableTelemetry := ctx.BoolT(enableTelemetryFlag.Name)
+	enableTelemetry := ctx.BoolT(telemetryEnabledFlag.Name)
 	if enableTelemetry {
 		telemetry.InitializePrometheusTelemetry()
 		telemetryServer, telemetryCloseFunc, err := startTelemetryServer(ctx.String(telemetryAddrFlag.Name), ctx.String(apiCorsFlag.Name))