Prometheus flag

coder · mtojek · Apr 14, 2023 · Apr 3, 2023 · Apr 4, 2023 · Apr 4, 2023
commit c7af75a318f0b152d3f24a03900e560ac0fee1d6
diff --git a/cli/server.go b/cli/server.go
@@ -844,11 +844,13 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd.
 				}
 				defer closeWorkspacesFunc()
 
-				closeAgentStatsFunc, err := prometheusmetrics.AgentStats(ctx, logger, options.PrometheusRegistry, options.Database, time.Now(), 0)
-				if err != nil {
-					return xerrors.Errorf("register agent stats prometheus metric: %w", err)
+				if cfg.Prometheus.CollectAgentStats {
+					closeAgentStatsFunc, err := prometheusmetrics.AgentStats(ctx, logger, options.PrometheusRegistry, options.Database, time.Now(), 0)
+					if err != nil {
+						return xerrors.Errorf("register agent stats prometheus metric: %w", err)
+					}
+					defer closeAgentStatsFunc()
 				}
-				defer closeAgentStatsFunc()
 
 				//nolint:revive
 				defer serveHandler(ctx, logger, promhttp.InstrumentMetricHandler(

diff --git a/cli/testdata/coder_server_--help.golden b/cli/testdata/coder_server_--help.golden
@@ -90,6 +90,9 @@ Use a YAML configuration file when your server launch become unwieldy.
       --prometheus-address host:port, $CODER_PROMETHEUS_ADDRESS (default: 127.0.0.1:2112)
           The bind address to serve prometheus metrics.
 
+      --prometheus-collect-agent-stats bool, $CODER_PROMETHEUS_COLLECT_AGENT_STATS
+          Collect agent stats (may increase charges for metrics storage) .
+
       --prometheus-enable bool, $CODER_PROMETHEUS_ENABLE
           Serve prometheus metrics on the address defined by prometheus address.
 

diff --git a/cli/testdata/server-config.yaml.golden b/cli/testdata/server-config.yaml.golden
@@ -146,6 +146,9 @@ introspection:
     # The bind address to serve prometheus metrics.
     # (default: 127.0.0.1:2112, type: host:port)
     address: 127.0.0.1:2112
+    # Collect agent stats (may increase charges for metrics storage) .
+    # (default: <unset>, type: bool)
+    collect_agent_stats: false
   pprof:
     # Serve pprof metrics on the address defined by pprof address.
     # (default: <unset>, type: bool)

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -225,8 +225,9 @@ type DERPConfig struct {
 }
 
 type PrometheusConfig struct {
-	Enable  clibase.Bool     `json:"enable" typescript:",notnull"`
-	Address clibase.HostPort `json:"address" typescript:",notnull"`
+	Enable            clibase.Bool     `json:"enable" typescript:",notnull"`
+	Address           clibase.HostPort `json:"address" typescript:",notnull"`
+	CollectAgentStats clibase.Bool     `json:"collect_agent_stats" typescript:",notnull"`
 }
 
 type PprofConfig struct {
@@ -722,6 +723,15 @@ when required by your organization's security policy.`,
 			Group:       &deploymentGroupIntrospectionPrometheus,
 			YAML:        "address",
 		},
+		{
+			Name:        "Prometheus Collect Agent Stats",
+			Description: "Collect agent stats (may increase charges for metrics storage) .",
+			Flag:        "prometheus-collect-agent-stats",
+			Env:         "CODER_PROMETHEUS_COLLECT_AGENT_STATS",
+			Value:       &c.Prometheus.CollectAgentStats,
+			Group:       &deploymentGroupIntrospectionPrometheus,
+			YAML:        "collect_agent_stats",
+		},
 		// Pprof settings
 		{
 			Name:        "pprof Enable",

diff --git a/docs/api/general.md b/docs/api/general.md
@@ -271,6 +271,7 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
         "host": "string",
         "port": "string"
       },
+      "collect_agent_stats": true,
       "enable": true
     },
     "provisioner": {

diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -1901,6 +1901,7 @@ CreateParameterRequest is a structure used to create a new parameter value for a
         "host": "string",
         "port": "string"
       },
+      "collect_agent_stats": true,
       "enable": true
     },
     "provisioner": {
@@ -2244,6 +2245,7 @@ CreateParameterRequest is a structure used to create a new parameter value for a
       "host": "string",
       "port": "string"
     },
+    "collect_agent_stats": true,
     "enable": true
   },
   "provisioner": {
@@ -3155,16 +3157,18 @@ Parameter represents a set value for the scope.
     "host": "string",
     "port": "string"
   },
+  "collect_agent_stats": true,
   "enable": true
 }
 ```
 
 ### Properties
 
-| Name      | Type                                 | Required | Restrictions | Description |
-| --------- | ------------------------------------ | -------- | ------------ | ----------- |
-| `address` | [clibase.HostPort](#clibasehostport) | false    |              |             |
-| `enable`  | boolean                              | false    |              |             |
+| Name                  | Type                                 | Required | Restrictions | Description |
+| --------------------- | ------------------------------------ | -------- | ------------ | ----------- |
+| `address`             | [clibase.HostPort](#clibasehostport) | false    |              |             |
+| `collect_agent_stats` | boolean                              | false    |              |             |
+| `enable`              | boolean                              | false    |              |             |
 
 ## codersdk.ProvisionerConfig
 

diff --git a/docs/cli/server.md b/docs/cli/server.md
@@ -555,6 +555,16 @@ URL of a PostgreSQL database. If empty, PostgreSQL binaries will be downloaded f
 
 The bind address to serve prometheus metrics.
 
+### --prometheus-collect-agent-stats
+
+|             |                                                           |
+| ----------- | --------------------------------------------------------- |
+| Type        | <code>bool</code>                                         |
+| Environment | <code>$CODER_PROMETHEUS_COLLECT_AGENT_STATS</code>        |
+| YAML        | <code>introspection.prometheus.collect_agent_stats</code> |
+
+Collect agent stats (may increase charges for metrics storage) .
+
 ### --prometheus-enable
 
 |             |                                              |

diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -627,6 +627,7 @@ export interface PrometheusConfig {
   // Named type "github.com/coder/coder/cli/clibase.HostPort" unknown, using "any"
   // eslint-disable-next-line @typescript-eslint/no-explicit-any -- External type
   readonly address: any
+  readonly collect_agent_stats: boolean
 }
 
 // From codersdk/deployment.go