mirror of https://github.com/alibaba/arthas.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
3.1 KiB
Plaintext
50 lines
3.1 KiB
Plaintext
Arthas Documentation
|
|
===
|
|
|
|
**[中文文档/Chinese Docs](https://alibaba.github.io/arthas/)**
|
|
|
|
|
|
|
|
`Arthas` is a Java Diagnostic tool open sourced by Alibaba.
|
|
|
|
Arthas help developers in trouble-shooting production issues for Java applications without modifying code or restarting servers.
|
|
|
|
### Background
|
|
|
|
Often times, the production system network is inaccessible from local development environment. If issues are encountered in production systems, it is impossible to use IDE to debug the application remotely. More importantly, debugging in production environment is unacceptable, as it will suspend all the threads, which leads to blocking of business services.
|
|
|
|
Developers could always try to reproduce the same issue on the test/staging environment. However, this is tricky as some issues cannot be be reproduced easily on a different environment, or even disappear once restarted.
|
|
|
|
And if you're thinking of adding some logs to your code to help trouble-shoot the issue, you will have to go through the following lifecycle; test, staging, and then to production. Time is money! This approach is inefficient! Besides, the issue may not be reproducible once the JVM is restarted, as described above.
|
|
|
|
Arthas was built to solve these issues. A developer can trouble-shoot your production issues on-the-fly. No JVM restart, no additional code changes. Arthas works as an observer, which will never suspend your existing threads.
|
|
|
|
### Key features
|
|
|
|
* Check whether a class is loaded? Or where the class is loaded from? (Useful for trouble-shooting jar file conflicts)
|
|
* Decompile a class to ensure the code is running as expected.
|
|
* View classloader statistics, e.g. the number of classloaders, the number of classes loaded per classloader, the classloader hierarchy, possible classloader leaks, etc.
|
|
* View the method invocation details, e.g. method parameter, return object, thrown exception, and etc.
|
|
* Check the stack trace of specified method invocation. This is useful when a developers wants to know the caller of the said method.
|
|
* Trace the method invocation to find slow sub-invocations.
|
|
* Monitor method invocation statistics, e.g. qps, rt, success rate and etc.
|
|
* Monitor system metrics, thread states and cpu usage, gc statistics, and etc.
|
|
* Supports command line interactive mode, with auto-complete feature enabled.
|
|
* Supports telnet and websocket, which enables both local and remote diagnostics with command line and browsers.
|
|
|
|
|
|
Contents
|
|
--------
|
|
|
|
English version has just been finished. If you would like to make it better, please check [here](https://github.com/alibaba/arthas/issues/51) and submit your PM.
|
|
|
|
* [Installation](install-detail.md)
|
|
* [Quick start](quick-start.md)
|
|
* [Advanced usage](advanced-use.md)
|
|
* [Commands](commands.md)
|
|
* [User cases](https://github.com/alibaba/arthas/issues?q=label%3Auser-case)
|
|
* [Release Notes](release-notes.md)
|
|
* [Questions and answers](https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered)
|
|
* [Fork me at GitHub](https://github.com/alibaba/arthas)
|
|
* [CONTRIBUTING](https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md)
|