Run ECE diagnostics tool

ECE diagnostics is a command line tool that you can run on hosts where the ECE instance is installed. It collects logs and metrics, and stores everything into an archive file that can be provided to Elastic support for troubleshooting and investigation purposes.

This archive file is privacy-redacted as much as possible, but may still contain host identifying metadata (such as IP/domain info). We therefore recommend against uploading this output to public forums. Any uploads to the Elastic Support Portal are treated according to the Elastic Privacy Statement.

Prepare

edit

Don’t use the diagnostics tool that comes bundled in ECE images. Always download the latest binary to avoid any known vulnerabilities in the diagnostics acquisition and shipping flow.

Download the bundled diagnostic binary.

For x86_64 CPU architectures: https://download.elasticsearch.org/cloud/amd64/ece-diagnostics
For ARM CPU architectures: https://download.elasticsearch.org/cloud/arm64/ece-diagnostics

Make it executable.

chmod +x ./ece-diagnostics

How to use

edit

To run the default diagnostic

./ece-diagnostics run

This tool supports various command line flags. You can also run it with -h or --help to print all available subcommands and options:

./ece-diagnostics --help

For example, Elastic Support frequently requests pulling the ECE diagnostic along with certain deployment diagnostics. You can pull these together via:

./ece-diagnostics run --deployments MY_DEPLOYMENT_ID_1,MY_DEPLOYMENT_ID_2

ECE deployment diagnostics are not the same as stack diagnostics, which Elastic support may also request. You can get stack diagnostics from Elastic Cloud Enterprise > Deployment > Operations > Prepare Bundle.

Example output

edit

When you run the ECE diagnostics tool on the host you want to troubleshoot, you might get an output similar to this one:

[...]
✓ collected information on certificates (took: 104ms)
✓ collected information on client-forwarder connectivity (took: 369ms)
✓ collected API information for ECE and Elasticsearch (took: 9.117s)
✓ collected ZooKeeper stats (took: 9.146s)
✓ collected ECE metricbeat data (took: 12.534s)
✓ collected system information (took: 12.992s)
✓ collected host logs for ECE (took: 29.222s)
✓ collected Docker info and logs (took: 29.246s)
Finished creating file: /tmp/ecediag-192.168.44.10-20220506-084902.tar.gz (total: 48.937s)

At that point, you’re ready to upload the .tar.gz file to Elastic Support.

« Verify Zookeeper Sync Status Ask for help »