update doc

This commit is contained in:
hengyunabc committed 2020-09-03 16:31:47 +08:00
1 parent 3b0eb23ed0
commit d48410b176
28 files changed
+797 -16

No files matched your search

+4
View File
@@ -86,6 +86,10 @@ Arthas supports living inside a browser. The communication between arthas and br
* [Web Console](web-console.md)
## Arthas Properties
* [Arthas Properties](arthas-properties.md)
## Start as a Java Agent
* [Start as a Java Agent](agent.md)
+1 -1
View File
@@ -9,6 +9,6 @@ For example, download the full arthas zip package, decompress it and start it by
java -javaagent:/tmp/test/arthas-agent.jar -jar arthas-demo.jar
````
The default configuration is in the `arthas.properties` file in the decompression directory.
The default configuration is in the `arthas.properties` file in the decompression directory. Reference: [Arthas Properties](arthas-properties.md)
Reference: https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/package-summary.html
+38
View File
@@ -0,0 +1,38 @@
Arthas Properties
===
The `arthas.properties` file is in the arthas directory.
* If it is automatically downloaded arthas, the directory is under `~/.arthas/lib/3.x.x/arthas/`
* If it is a downloaded complete package, under the decompression directory of arthas
## Supported configuration items
```
#arthas.config.overrideAll=true
arthas.telnetPort=3658
arthas.httpPort=8563
arthas.ip=localhost
#arthas.tunnelServer=ws://127.0.0.1:7777/ws
#arthas.agentId=mmmmmmyiddddd
```
* If the configuration of `arthas.telnetPort` is -1, the telnet port will not be listened. `arthas.httpPort` is similar.
* If you configure `arthas.telnetPort` to 0, then random listen telnet port, you can find the random port log in `~/logs/arthas/arthas.log`. `arthas.httpPort` is similar.
> If you want to prevent multiple arthas port conflicts on a machine. It can be configured as a random port, or configured as -1, and use arthas through the tunnel server.
## Configured order
The order of configuration is: command line parameters > System Env > System Properties > arthas.properties.
such as:
* `./as.sh --telnet-port 9999` command line configuration will overwrite the default value `arthas.telnetPort=3658` in `arthas.properties`.
* If the application itself sets system properties `arthas.telnetPort=8888`, it will override the default value `arthas.telnetPort=3658` in `arthas.properties`.
If you want `arthas.properties` to have the highest order, you can configure `arthas.config.overrideAll=true`.
+1
View File
@@ -29,6 +29,7 @@ arthas.tunnel-server=ws://47.75.156.201:7777/ws
All supported configuration: [Reference](https://github.com/alibaba/arthas/blob/master/arthas-spring-boot-starter/src/main/java/com/alibaba/arthas/spring/ArthasProperties.java)
Reference: [Arthas Properties](arthas-properties.md)
### View Endpoint Information