From 5c50d245582745b9706bd07524f0cee28ceeac6e Mon Sep 17 00:00:00 2001 From: Kuni Sen Date: Wed, 22 Jul 2026 13:21:29 +0900 Subject: [PATCH 1/2] [Stack] Clarify the diagnostics capture impact Similar to https://github.com/elastic/support-tech-lead/issues/1856 and https://github.com/elastic/docs-content/pull/7363, per @romain-chanu's suggestion, add this to support diagnostic GH repo. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d17f69a2..ecdaa395 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,13 @@ The application can be run from any directory on the machine. It does not requir This software is licensed under [Elastic License v2](https://www.elastic.co/licensing/elastic-license). +## Performance and safety + +The Support Diagnostic tool can be run from any directory on the machine. It does not require installation to a specific location, and the only requirement is that the user has read access to the Elasticsearch artifacts, write access to the chosen output directory, and sufficient disk space for the generated archive. +The calls issued by the Support Diagnostic tool are read-only. It issues only GET requests to Elasticsearch APIs — primarily `_cat` APIs (such as `/_cat/nodes`, `/_cat/shards`, `/_cat/indices`), cluster and node stats endpoints, and settings endpoints. It does not modify any cluster state, indices, or data. In `local` mode, it also retrieves log files and operating system information directly from disk, which has no impact on the cluster. +On a healthy cluster, the overhead is negligible. On clusters with many indices, a small number of calls such as `/_cluster/state` and `/_stats` may take longer to respond, but they remain read-only and do not trigger any cluster operations such as shard movements or merges. +You can safely run the diagnostic on a production cluster. + ## Installation And Setup ### Run Requirements From 2ae8498ce667f26974484567ac45b1df17da2d88 Mon Sep 17 00:00:00 2001 From: Kuni Sen Date: Wed, 22 Jul 2026 13:56:31 +0900 Subject: [PATCH 2/2] Update README.md --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ecdaa395..472f3c1a 100644 --- a/README.md +++ b/README.md @@ -58,12 +58,9 @@ The application can be run from any directory on the machine. It does not requir This software is licensed under [Elastic License v2](https://www.elastic.co/licensing/elastic-license). -## Performance and safety +## Performance and safety -The Support Diagnostic tool can be run from any directory on the machine. It does not require installation to a specific location, and the only requirement is that the user has read access to the Elasticsearch artifacts, write access to the chosen output directory, and sufficient disk space for the generated archive. -The calls issued by the Support Diagnostic tool are read-only. It issues only GET requests to Elasticsearch APIs — primarily `_cat` APIs (such as `/_cat/nodes`, `/_cat/shards`, `/_cat/indices`), cluster and node stats endpoints, and settings endpoints. It does not modify any cluster state, indices, or data. In `local` mode, it also retrieves log files and operating system information directly from disk, which has no impact on the cluster. -On a healthy cluster, the overhead is negligible. On clusters with many indices, a small number of calls such as `/_cluster/state` and `/_stats` may take longer to respond, but they remain read-only and do not trigger any cluster operations such as shard movements or merges. -You can safely run the diagnostic on a production cluster. +For performance and safety guidance on capturing Elasticsearch support diagnostic bundles, review the official documentation at https://www.elastic.co/docs/troubleshoot/elasticsearch/diagnostic#diagnostic-performance-safety. ## Installation And Setup