add note how to disable metrics when using the monitoring

logzio · Nov 10, 2024 · 627636b · 627636b
1 parent df302e6
commit 627636b
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 10 deletions.
diff --git a/docs/_include/general-shipping/k8s-all-data.md b/docs/_include/general-shipping/k8s-all-data.md
@@ -8,7 +8,7 @@ Send all of your telemetry data using one single Helm chart:
 helm install  -n monitoring --create-namespace \
 --set logs.enabled=true \
 --set logzio-logs-collector.secrets.logzioLogsToken="<<LOG-SHIPPING-TOKEN>>" \
---set logzio-logs-collector.secrets.logzioRegion="<<LOGZIO-REGION>>" \
+--set logzio-logs-collector.secrets.logzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
 --set logzio-logs-collector.secrets.env_id="<<CLUSTER-NAME>>" \
 --set metricsOrTraces.enabled=true \
 --set logzio-k8s-telemetry.metrics.enabled=true \
@@ -17,10 +17,10 @@ helm install  -n monitoring --create-namespace \
 --set logzio-k8s-telemetry.secrets.p8s_logzio_name="<<ENV-ID>>" \
 --set logzio-k8s-telemetry.traces.enabled=true \
 --set logzio-k8s-telemetry.secrets.TracesToken="<<TRACING-SHIPPING-TOKEN>>" \
---set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO-REGION>>" \
+--set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
 --set logzio-k8s-telemetry.spm.enabled=true \
 --set logzio-k8s-telemetry.secrets.env_id="<<ENV-ID>>" \
---set logzio-k8s-telemetry.secrets.SpmToken="<<SPM-ACCOUNT-SHIPPING-TOKEN>>" \
+--set logzio-k8s-telemetry.secrets.SpmToken="<<SPM-METRICS-SHIPPING-TOKEN>>" \
 --set logzio-k8s-telemetry.serviceGraph.enabled=true \
 --set logzio-k8s-telemetry.k8sObjectsConfig.enabled=true \
 --set logzio-k8s-telemetry.secrets.k8sObjectsLogsToken="<<LOG-SHIPPING-TOKEN>>" \
@@ -40,7 +40,18 @@ logzio-monitoring logzio-helm/logzio-monitoring
 | `<<LOG-SHIPPING-TOKEN>>` | Your [logs shipping token](https://app.logz.io/#/dashboard/settings/general). |
 | `<<LISTENER-HOST>>` | Your account's [listener host](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping?product=logs). |
 | `<<METRICS-SHIPPING-TOKEN>>` | Your [metrics shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping). |
-| `<<SPM-ACCOUNT-SHIPPING-TOKEN>>` | Your [SPM account shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping) |
+| `<<SPM-METRICS-SHIPPING-TOKEN>>` | Your [SPM account shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping) |
 | `<<ENV-ID>>` | The name for your environment's identifier, to easily identify the telemetry data for each environment. |
 | `<<TRACING-SHIPPING-TOKEN>>` | Your [traces shipping token](https://app.logz.io/#/dashboard/settings/manage-tokens/data-shipping). |
-| `<<LOGZIO-REGION>>` | Your Logz.io [region code](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions) |
+| `<<LOGZIO_ACCOUNT_REGION_CODE>>` | Your Logz.io [region code](https://docs.logz.io/docs/user-guide/admin/hosting-regions/account-region/#available-regions) |
+
+
+:::tip
+To diable metrics when `metricsOrTraces.enabled=true`, make sure to include the below flags in the command:
+
+```shell
+--set logzio-k8s-telemetry.nodeExporter.enabled=false \
+--set logzio-k8s-telemetry.kubeStateMetrics.enabled=false \
+--set logzio-k8s-telemetry.pushGateway.enabled=false \
+```
+:::
diff --git a/docs/_include/general-shipping/k8s.md b/docs/_include/general-shipping/k8s.md
@@ -38,7 +38,7 @@ To send your logs, our chart`logzio-monitoring` offers two methods:
 helm install -n monitoring --create-namespace \
 --set logs.enabled=true \
 --set logzio-logs-collector.secrets.logzioLogsToken="<<LOG-SHIPPING-TOKEN>>" \
---set logzio-logs-collector.secrets.logzioRegion="<<LOGZIO-REGION>>" \
+--set logzio-logs-collector.secrets.logzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
 --set logzio-logs-collector.secrets.env_id="<<CLUSTER-NAME>>" \
 logzio-monitoring logzio-helm/logzio-monitoring
 ```
@@ -200,8 +200,11 @@ helm install -n monitoring --create-namespace \
 --set metricsOrTraces.enabled=true \
 --set logzio-k8s-telemetry.traces.enabled=true \
 --set logzio-k8s-telemetry.secrets.TracesToken="<<TRACING-SHIPPING-TOKEN>>" \
---set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO_REGION>>" \
+--set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
 --set logzio-k8s-telemetry.secrets.env_id="<<CLUSTER-NAME>>" \
+--set logzio-k8s-telemetry.nodeExporter.enabled=false \
+--set logzio-k8s-telemetry.kubeStateMetrics.enabled=false \
+--set logzio-k8s-telemetry.pushGateway.enabled=false \
 logzio-monitoring logzio-helm/logzio-monitoring
 ```
 
@@ -212,10 +215,13 @@ helm install -n monitoring --create-namespace \
 --set metricsOrTraces.enabled=true \
 --set logzio-k8s-telemetry.traces.enabled=true \
 --set logzio-k8s-telemetry.secrets.TracesToken="<<TRACING-SHIPPING-TOKEN>>" \
---set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO_REGION>>" \
+--set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
 --set logzio-k8s-telemetry.secrets.env_id="<<CLUSTER-NAME>>" \
 --set logzio-k8s-telemetry.spm.enabled=true \
---set logzio-k8s-telemetry.secrets.SpmToken=<<SPM-METRICS-SHIPPING-TOKEN>> \
+--set logzio-k8s-telemetry.secrets.SpmToken="<<SPM-METRICS-SHIPPING-TOKEN>>" \
+--set logzio-k8s-telemetry.nodeExporter.enabled=false \
+--set logzio-k8s-telemetry.kubeStateMetrics.enabled=false \
+--set logzio-k8s-telemetry.pushGateway.enabled=false \
 logzio-monitoring logzio-helm/logzio-monitoring
 ```
 
@@ -233,8 +239,11 @@ helm install -n monitoring --create-namespace \
 --set logzio-k8s-telemetry.secrets.LogzioRegion="<<LOGZIO_ACCOUNT_REGION_CODE>>" \
 --set logzio-k8s-telemetry.secrets.env_id="<<CLUSTER-NAME>>" \
 --set logzio-k8s-telemetry.spm.enabled=true \
---set logzio-k8s-telemetry.secrets.SpmToken=<<SPM-METRICS-SHIPPING-TOKEN>> \
+--set logzio-k8s-telemetry.secrets.SpmToken="<<SPM-METRICS-SHIPPING-TOKEN>>" \
 --set logzio-k8s-telemetry.serviceGraph.enabled=true \
+--set logzio-k8s-telemetry.nodeExporter.enabled=false \
+--set logzio-k8s-telemetry.kubeStateMetrics.enabled=false \
+--set logzio-k8s-telemetry.pushGateway.enabled=false \
 logzio-monitoring logzio-helm/logzio-monitoring
 ```