DOCSEARCHbyAlgolia
Submit Docs

Arthas Documentation

website·Indexed 19 days ago

https://arthas.aliyun.com/doc/

Documentation for Arthas, a Java diagnostic tool open-sourced by the Alibaba middleware team. It includes guides on manual installation, Docker usage, and Java Agent startup, as well as detailed references for commands such as watch, trace, profiler, vmtool, and jad. The documentation also covers the Http API, Arthas Tunnel for remote agent management, and the Arthas Spring Boot Starter.

Tokens
121.3K
Snippets
895
Records
1.1K
Agent score
91%

What's inside Arthas

  1. Overview of the Arthas jfr command

    The jfr command in Arthas provides a way to manage Java Flight Recorder (JFR) recordings during a dynamic program run. JFR collects diagnostic and profiling events (such as CPU usage and heap size) with minimal performance overhead.

    Requirement: JFR is supported only in JDK 8 version 8u262 and later.

  2. Overview of Arthas Dashboard capabilities

    Arthas provides a suite of diagnostic tools for real-time system monitoring and troubleshooting, including:

    • Dashboard: Real-time view of system operating status.
    • Parameters/Return values/Exceptions: Inspection of method parameters, return values, and exceptions.
    • Online Hotswap: Support for online hotswap using jad, sc, and redefine commands.
    • Class Conflict Resolution: Rapid location of class loading paths to resolve class conflicts.
    • Flame Graph: Generation of flame graphs to identify application hotspots.
    • WebConsole: Online diagnosis capabilities.

  3. Overview of Arthas Dashboard capabilities

    The Arthas Dashboard provides a real-time view of the system's operating status, allowing developers to monitor performance and health metrics visually.

  4. Overview of the tt (TimeTunnel) command

    The tt command acts as a 'time tunnel' for method execution data. It records the input parameters and return information for every call to a specified method, allowing developers to observe and analyze specific calls after they have occurred. This is particularly useful when the exact cause of a problem is unknown and watch expressions are too restrictive.

  5. Overview of the tt (Time Tunnel) command

    The tt command allows you to record the calling context of methods (parameters, return values, and exceptions) and store them in a history. This is particularly useful when watch is too complex to locate an issue, as tt lets you inspect the execution history of a method at different points in time.

  6. Overview of Arthas Http API

    The Arthas Http API provides a RESTful-like interactive interface using JSON for both requests and responses. It allows for structured data retrieval and complex diagnostic operations, serving as an alternative to the unstructured text output of Telnet or WebConsole.

    Access Details:

    • Endpoint: http://ip:port/api (e.g., http://127.0.0.1:8563/api)
    • Method: All requests must use POST.
    • Recommended Port: Use port 8563 for HTTP API access to avoid compatibility issues with Chrome browser found on telnet port 3658.

  7. Overview of Arthas Tunnel

    Arthas Tunnel allows developers to remotely manage and connect to multiple Arthas Agents via a Tunnel Server and Client. This is particularly useful in distributed environments (like stream computing) where Java processes are started on different machines and the user lacks direct SSH/machine access or cannot easily identify the correct Java process.

  8. Overview of Arthas Java diagnostic tool

    Arthas is an open-source Java diagnostic tool developed by Alibaba. It allows developers to monitor and diagnose production issues in real-time from a global perspective without modifying application code or restarting the JVM. It provides visibility into application load, memory, GC, and thread status, and can be used to inspect method parameters, return values, exceptions, execution time, and class loading information.

  9. Overview of Arthas Java diagnostic tool

    Arthas is an open-source Java diagnostic tool developed by Alibaba that allows developers to monitor and diagnose production applications in real-time without modifying code or restarting the JVM. It provides a global perspective on application health, including load, memory, GC, and thread status. It is designed to replace the need for adding logs and redeploying or using remote IDE debugging in production, which can pause threads and disrupt service.

  10. Overview of Arthas HTTP API

    The Arthas HTTP API provides a RESTful interface using JSON for requests and responses. It is designed to provide structured data, making it suitable for complex diagnostic automation compared to the unstructured text output of Telnet or the Web Console. The API is accessible via POST requests to http://ip:port/api (default port is 8563).
    # Example endpoint
POST http://127.0.0.1:8563/api

  11. Overview of Arthas MCP Server

    Arthas MCP Server is an experimental module that implements the Model Context Protocol (MCP) version 2025-06-18. It provides a unified JSON-RPC 2.0 interface via HTTP/Netty, enabling AI assistants (such as Claude Desktop, Cherry Studio, and Cline) to perform Java application diagnostics by calling Arthas tools. It supports Streamable HTTP transport and Bearer Token authentication.

  12. Overview of Arthas Java diagnostic tool

    Arthas is an open-source Java diagnostic tool developed by the Alibaba middleware team. It allows developers to troubleshoot issues in production environments for Java-based applications without modifying code or restarting servers. Unlike traditional debuggers, Arthas acts as an observer and does not suspend running threads, preventing service downtime during diagnostics. It supports JDK 6+ and is compatible with Linux, Mac, and Windows.