update doc

gh-pages
hengyunabc 5 years ago
parent c544052e7e
commit 72d0a1e74c

@ -6,12 +6,11 @@ options
| 名称 | 默认值 | 描述 |
| ------------------ | ----- | ---------------------------------------- |
| unsafe | false | 是否支持对系统级别的类进行增强打开该开关可能导致把JVM搞挂请慎重选择 |
| dump | false | 是否支持被增强了的类dump到外部文件中如果打开开关class文件会被dump到`/${application dir}/arthas-class-dump/`目录下,具体位置详见控制台输出 |
| dump | false | 是否支持被增强了的类dump到外部文件中如果打开开关class文件会被dump到`/${application working dir}/arthas-class-dump/`目录下,具体位置详见控制台输出 |
| batch-re-transform | true | 是否支持批量对匹配到的类执行retransform操作 |
| json-format | false | 是否支持json化的输出 |
| disable-sub-class | false | 是否禁用子类匹配,默认在匹配目标类的时候会默认匹配到其子类,如果想精确匹配,可以关闭此开关 |
| support-default-method | true | 是否支持匹配到default method默认会查找interface匹配里面的default method。参考 [#1105](https://github.com/alibaba/arthas/issues/1105) |
| debug-for-asm | false | 打印ASM相关的调试信息 |
| save-result | false | 是否打开执行结果存日志功能,打开之后所有命令的运行结果都将保存到`~/logs/arthas-cache/result.log`中 |
| job-timeout | 1d | 异步后台任务的默认超时时间,超过这个时间,任务自动停止;比如设置 1d, 2h, 3m, 25s分别代表天、小时、分、秒 |
| print-parent-fields | true | 是否打印在parent class里的filed |
@ -40,9 +39,6 @@ $ options
ean -class include sub class ass when matching class.
when class matchin
g
1 bool debug-for-a false Option to print DE This option enables to print DEBUG me
ean sm BUG message if ASM ssage of ASM for each method invocati
is involved on.
1 bool save-result false Option to print co This option enables to save each comm
ean mmand's result to and's result to log file, which path
log file is ${user.home}/logs/arthas-cache/res

@ -32,6 +32,8 @@ arthas.tunnel-server=ws://47.75.156.201:7777/ws
### 查看Endpoint信息
> 需要配置spring boot暴露endpoint[参考](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-endpoints)
假定endpoint端口是 8080则通过下面url可以查看
http://localhost:8080/actuator/arthas

@ -11,7 +11,6 @@ options
| json-format | false | whether to output in JSON format|
| disable-sub-class | false | whether to enable matching child classes. The default value is `true`. If exact match is desire, turn off this flag|
| support-default-method | true | whether to enable matching default method in interface. The default value is `true`. Refer to [#1105](https://github.com/alibaba/arthas/issues/1105) |
| debug-for-asm | false | whether to enable ASM debugging log|
| save-result | false | whether to save execution result. All execution results will be saved to `~/logs/arthas-cache/result.log` when it's turned on|
| job-timeout | 1d | default timeout for background jobs. Background job will be terminated once it's timed out (i.e. 1d, 2h, 3m, 25s)| print-parent-fields | true | This option enables print files in parent class, default value true.|

@ -32,6 +32,8 @@ All supported configuration: [Reference](https://github.com/alibaba/arthas/blob/
### View Endpoint Information
> Need to configure spring boot to expose endpoint: [Reference](https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-endpoints).
Assuming the endpoint port is 8080, it can be viewed via the following url.
http://localhost:8080/actuator/arthas

@ -259,11 +259,6 @@
<td>whether to enable matching default method in interface. The default value is <code>true</code>. Refer to <a href="https://github.com/alibaba/arthas/issues/1105">#1105</a></td>
</tr>
<tr>
<td>debug-for-asm</td>
<td>false</td>
<td>whether to enable ASM debugging log</td>
</tr>
<tr>
<td>save-result</td>
<td>false</td>
<td>whether to save execution result. All execution results will be saved to <code>~/logs/arthas-cache/result.log</code> when it's turned on</td>

File diff suppressed because one or more lines are too long

@ -202,6 +202,9 @@ arthas.tunnel-server=ws://47.75.156.201:7777/ws</pre>
</div>
<div class="section" id="view-endpoint-information">
<h2>View Endpoint Information<a class="headerlink" href="#view-endpoint-information" title="Permalink to this headline"></a></h2>
<blockquote>
<div><p>Need to configure spring boot to expose endpoint: <a class="reference external" href="https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-endpoints">Reference</a>.</p>
</div></blockquote>
<p>Assuming the endpoint port is 8080, it can be viewed via the following url.</p>
<p>http://localhost:8080/actuator/arthas</p>
<div class="highlight-js notranslate"><div class="highlight hljs"><pre class="js">{

@ -242,7 +242,7 @@
<tr>
<td>dump</td>
<td>false</td>
<td>是否支持被增强了的类dump到外部文件中如果打开开关class文件会被dump到<code>/${application dir}/arthas-class-dump/</code>目录下,具体位置详见控制台输出</td>
<td>是否支持被增强了的类dump到外部文件中如果打开开关class文件会被dump到<code>/${application working dir}/arthas-class-dump/</code>目录下,具体位置详见控制台输出</td>
</tr>
<tr>
<td>batch-re-transform</td>
@ -265,11 +265,6 @@
<td>是否支持匹配到default method默认会查找interface匹配里面的default method。参考 <a href="https://github.com/alibaba/arthas/issues/1105">#1105</a></td>
</tr>
<tr>
<td>debug-for-asm</td>
<td>false</td>
<td>打印ASM相关的调试信息</td>
</tr>
<tr>
<td>save-result</td>
<td>false</td>
<td>是否打开执行结果存日志功能,打开之后所有命令的运行结果都将保存到<code>~/logs/arthas-cache/result.log</code></td>
@ -308,9 +303,6 @@
ean -class include sub class ass when matching class.
when class matchin
g
1 bool debug-for-a false Option to print DE This option enables to print DEBUG me
ean sm BUG message if ASM ssage of ASM for each method invocati
is involved on.
1 bool save-result false Option to print co This option enables to save each comm
ean mmand&#x27;s result to and&#x27;s result to log file, which path
log file is ${user.home}/logs/arthas-cache/res

File diff suppressed because one or more lines are too long

@ -208,6 +208,9 @@ arthas.tunnel-server=ws://47.75.156.201:7777/ws</pre>
</div>
<div class="section" id="endpoint">
<h2>查看Endpoint信息<a class="headerlink" href="#endpoint" title="永久链接至标题"></a></h2>
<blockquote>
<div><p>需要配置spring boot暴露endpoint<a class="reference external" href="https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-features.html#production-ready-endpoints">参考</a></p>
</div></blockquote>
<p>假定endpoint端口是 8080则通过下面url可以查看</p>
<p>http://localhost:8080/actuator/arthas</p>
<div class="highlight-default notranslate"><pre class="literal-block">{

Loading…
Cancel
Save