https://github.com/sematext/solr-diagnostics
Gathers info from Solr: logs, configs, etc. Useful for remote debugging
https://github.com/sematext/solr-diagnostics
Last synced: about 1 year ago
JSON representation
Gathers info from Solr: logs, configs, etc. Useful for remote debugging
- Host: GitHub
- URL: https://github.com/sematext/solr-diagnostics
- Owner: sematext
- License: apache-2.0
- Created: 2018-05-01T15:18:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-28T14:48:06.000Z (about 5 years ago)
- Last Synced: 2023-03-23T23:43:27.878Z (about 3 years ago)
- Language: Java
- Homepage: https://sematext.com/blog/solr-diagnostics-tool/
- Size: 24.4 KB
- Stars: 5
- Watchers: 9
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# solr-diagnostics
Gathers info from Solr that should help diagnose issues:
* ps output
* dmesg output
* netstat output
* sysctl output
* uname output
* top output
* Solr logs and GC logs
* (optionally) syslog
* process limits
* java version
* solr.xml
* configs
* (Legacy Solr only) cores status
* (SolrCloud only) collections list
* (SolrCloud only) cluster status
* (SolrCloud only) aliases
* (SolrCloud only) overseer status
* metrics snapshot
# Usage
Download the binary from [releases](https://github.com/sematext/solr-diagnostics/releases). Then run it with:
sudo java -jar solr-diagnostics-x.y.z.jar
You'll need Java (7 or later). It will work without `sudo`, but some information will be missing (e.g. all the `sysctl` info).
The tool will politely say what it collects, then pack everything in a zip archive under `/tmp`. You can change this location by adding `-outputdir /some/other/path`
By default, solr-diagnostics will try to get all Solr logs. You can skip this by adding `-noSolrLogs`. Similarly, you can collect everything from `/var/log` (they are not fetched by default) by adding `-getVarLog`.
You can pass (basic) authentication credentials by adding `-user my_user` and `-pass my_pass`.
# Build from sources
Clone the repository, then run:
mvn clean package
The self-contained Jar will be `target/com.sematext.solr-diagnostics-x.y.z-SNAPSHOT.jar`
# Roadmap/TODO
See the list of [issues](https://github.com/sematext/solr-diagnostics/issues), and feel free to report new ones or submit pull requests!