From b422c71bd9992b39bdc6a477d9a3bd23e2963244 Mon Sep 17 00:00:00 2001 From: Andrea Longo Date: Wed, 5 Jun 2024 16:49:58 -0600 Subject: [PATCH] Change scrape_interval in metrics scraping example (#1231) The examples show `15s`, which is too short for a typical deployment. `60s` is recommended. Also note that this value may need to be increased if there are too many metrics to collect in the specified amount of time. Each scraping operation should complete before the next begins. Staged http://192.241.195.202:9000/staging/scrape_interval/linux/operations/monitoring/collect-minio-metrics-using-prometheus.html#generate-the-scrape-configuration --- ...collect-minio-metrics-using-prometheus.rst | 27 ++++++++++--------- 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst index ce712264..068c1c89 100644 --- a/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst +++ b/source/operations/monitoring/collect-minio-metrics-using-prometheus.rst @@ -59,7 +59,7 @@ Use the :mc-cmd:`mc admin prometheus generate` command to generate the scrape co :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job @@ -84,7 +84,7 @@ Use the :mc-cmd:`mc admin prometheus generate` command to generate the scrape co :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job-node @@ -109,7 +109,7 @@ Use the :mc-cmd:`mc admin prometheus generate` command to generate the scrape co :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job-bucket @@ -136,7 +136,7 @@ Use the :mc-cmd:`mc admin prometheus generate` command to generate the scrape co :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job-resource @@ -146,6 +146,12 @@ Use the :mc-cmd:`mc admin prometheus generate` command to generate the scrape co static_configs: - targets: [minio.example.net] +- Set an appropriate ``scrape_interval`` value to ensure each scraping operation completes before the next one begins. + The recommended value is 60 seconds. + + Some deployments require a longer scrape interval due to the number of metrics being scraped. + To reduce the load on your MinIO and Prometheus servers, choose the longest interval that meets your monitoring requirements. + - Set the ``job_name`` to a value associated to the MinIO deployment. Use a unique value to ensure isolation of the deployment metrics from any others collected by that Prometheus service. @@ -179,7 +185,7 @@ Append the desired ``scrape_configs`` job generated in the previous step to the :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job @@ -198,7 +204,7 @@ Append the desired ``scrape_configs`` job generated in the previous step to the :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job-node @@ -215,7 +221,7 @@ Append the desired ``scrape_configs`` job generated in the previous step to the :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job-bucket @@ -231,7 +237,7 @@ Append the desired ``scrape_configs`` job generated in the previous step to the :class: copyable global: - scrape_interval: 15s + scrape_interval: 60s scrape_configs: - job_name: minio-job-resource @@ -360,13 +366,10 @@ You can modify or otherwise use these examples as guidance in building your own summary: "Disks down in MinIO deployment" description: "Disks(s) in cluster {{ $labels.instance }} offline for more than 5 minutes" -Specify the path to the alert file to the Prometheus configuration as part of the ``rule_files`` key: +In the Prometheus configuration, specify the path to the alert file in the ``rule_files`` key: .. code-block:: yaml - global: - scrape_interval: 5s - rule_files: - minio-alerting.yml