Metrics: Disable by default. (#12153)

Co-authored-by: Marco Ebert <marco_ebert@icloud.com>
kubernetes · Oct 7, 2024 · 0aeacb1 · 0aeacb1
1 parent 70c20c4
commit 0aeacb1
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/charts/ingress-nginx/templates/_params.tpl b/charts/ingress-nginx/templates/_params.tpl
@@ -54,7 +54,7 @@
 {{- if .Values.controller.watchIngressWithoutClass }}
 - --watch-ingress-without-class=true
 {{- end }}
-{{- if not .Values.controller.metrics.enabled }}
+{{- if .Values.controller.metrics.enabled }}
 - --enable-metrics={{ .Values.controller.metrics.enabled }}
 {{- end }}
 {{- if .Values.controller.enableTopologyAwareRouting }}

diff --git a/charts/ingress-nginx/tests/controller-daemonset_test.yaml b/charts/ingress-nginx/tests/controller-daemonset_test.yaml
@@ -15,23 +15,23 @@ tests:
           path: metadata.name
           value: RELEASE-NAME-ingress-nginx-controller
 
-  - it: should create a DaemonSet with argument `--enable-metrics=false` if `controller.metrics.enabled` is false
+  - it: should create a DaemonSet with argument `--enable-metrics=true` if `controller.metrics.enabled` is true
     set:
       controller.kind: DaemonSet
-      controller.metrics.enabled: false
+      controller.metrics.enabled: true
     asserts:
       - contains:
           path: spec.template.spec.containers[0].args
-          content: --enable-metrics=false
+          content: --enable-metrics=true
 
-  - it: should create a DaemonSet without argument `--enable-metrics=false` if `controller.metrics.enabled` is true
+  - it: should create a DaemonSet without argument `--enable-metrics=true` if `controller.metrics.enabled` is false
     set:
       controller.kind: DaemonSet
-      controller.metrics.enabled: true
+      controller.metrics.enabled: false
     asserts:
       - notContains:
           path: spec.template.spec.containers[0].args
-          content: --enable-metrics=false
+          content: --enable-metrics=true
 
   - it: should create a DaemonSet with argument `--controller-class=k8s.io/ingress-nginx-internal` if `controller.ingressClassResource.controllerValue` is "k8s.io/ingress-nginx-internal"
     set:

diff --git a/charts/ingress-nginx/tests/controller-deployment_test.yaml b/charts/ingress-nginx/tests/controller-deployment_test.yaml
@@ -43,21 +43,21 @@ tests:
       - exists:
           path: spec.replicas
 
-  - it: should create a Deployment with argument `--enable-metrics=false` if `controller.metrics.enabled` is false
+  - it: should create a Deployment with argument `--enable-metrics=true` if `controller.metrics.enabled` is true
     set:
-      controller.metrics.enabled: false
+      controller.metrics.enabled: true
     asserts:
       - contains:
           path: spec.template.spec.containers[0].args
-          content: --enable-metrics=false
+          content: --enable-metrics=true
 
-  - it: should create a Deployment without argument `--enable-metrics=false` if `controller.metrics.enabled` is true
+  - it: should create a Deployment without argument `--enable-metrics=true` if `controller.metrics.enabled` is false
     set:
-      controller.metrics.enabled: true
+      controller.metrics.enabled: false
     asserts:
       - notContains:
           path: spec.template.spec.containers[0].args
-          content: --enable-metrics=false
+          content: --enable-metrics=true
 
   - it: should create a Deployment with argument `--controller-class=k8s.io/ingress-nginx-internal` if `controller.ingressClassResource.controllerValue` is "k8s.io/ingress-nginx-internal"
     set:

diff --git a/docs/user-guide/cli-arguments.md b/docs/user-guide/cli-arguments.md
@@ -24,7 +24,7 @@ They are set in the container spec of the `ingress-nginx-controller` Deployment
 | `--dynamic-configuration-retries` | Number of times to retry failed dynamic configuration before failing to sync an ingress. (default 15) |
 | `--election-id`                    | Election id to use for Ingress status updates. (default "ingress-controller-leader") |
 | `--election-ttl`                  | Duration a leader election is valid before it's getting re-elected, e.g. `15s`, `10m` or `1h`. (Default: 30s) |
-| `--enable-metrics`                 | Enables the collection of NGINX metrics. (default true) |
+| `--enable-metrics`                 | Enables the collection of NGINX metrics. (Default: false) |
 | `--enable-ssl-chain-completion`    | Autocomplete SSL certificate chains with missing intermediate CA certificates. Certificates uploaded to Kubernetes must have the "Authority Information Access" X.509 v3 extension for this to succeed. (default false)|
 | `--enable-ssl-passthrough`         | Enable SSL Passthrough. (default false) |
 | `--disable-leader-election`        | Disable Leader Election on Nginx Controller. (default false) |

diff --git a/pkg/flags/flags.go b/pkg/flags/flags.go
@@ -174,7 +174,7 @@ extension for this to succeed.`)
 			`Customized address (or addresses, separated by comma) to set as the load-balancer status of Ingress objects this controller satisfies.
 Requires the update-status parameter.`)
 
-		enableMetrics = flags.Bool("enable-metrics", true,
+		enableMetrics = flags.Bool("enable-metrics", false,
 			`Enables the collection of NGINX metrics.`)
 		metricsPerHost = flags.Bool("metrics-per-host", true,
 			`Export metrics per-host.`)