Add miss doc about collecting parameters in the profiled traces. (#4552)

This commit is contained in:
吴晟 Wu Sheng 2020-03-23 09:41:02 +08:00 committed by GitHub
parent ace781ff49
commit 259a147682
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 3 deletions

View File

@ -19,7 +19,7 @@ in Cloud Native architecture.
The core features are following.
- Service, service instance, endpoint metrics analysis
- Root cause analysis
- Root cause analysis. Profile the code on the runtime.
- Service topology map analysis
- Service, service instance and endpoint dependency analysis
- Slow services and endpoints detected

View File

@ -122,8 +122,8 @@ property key | Description | Default |
`plugin.opgroup.*`|Support operation name customize group rules in different plugins. Read [Group rule supported plugins](op_name_group_rule.md)|Not set|
`plugin.springtransaction.simplify_transaction_definition_name`|If true, the transaction definition name will be simplified.|false|
`plugin.jdkthreading.threading_class_prefixes` | Threading classes (`java.lang.Runnable` and `java.util.concurrent.Callable`) and their subclasses, including anonymous inner classes whose name match any one of the `THREADING_CLASS_PREFIXES` (splitted by `,`) will be instrumented, make sure to only specify as narrow prefixes as what you're expecting to instrument, (`java.` and `javax.` will be ignored due to safety issues) | Not set |
`plugin.tomcat.collect_http_params`| This config item controls that whether the Tomcat plugin should collect the parameters of the request. | `false` |
`plugin.springmvc.collect_http_params`| This config item controls that whether the SpringMVC plugin should collect the parameters of the request, when your Spring application is based on Tomcat, consider only setting either `plugin.tomcat.collect_http_params` or `plugin.springmvc.collect_http_params`. | `false` |
`plugin.tomcat.collect_http_params`| This config item controls that whether the Tomcat plugin should collect the parameters of the request. Also, activate implicitly in the profiled trace. | `false` |
`plugin.springmvc.collect_http_params`| This config item controls that whether the SpringMVC plugin should collect the parameters of the request, when your Spring application is based on Tomcat, consider only setting either `plugin.tomcat.collect_http_params` or `plugin.springmvc.collect_http_params`. Also, activate implicitly in the profiled trace. | `false` |
`plugin.http.http_params_length_threshold`| When `COLLECT_HTTP_PARAMS` is enabled, how many characters to keep and send to the OAP backend, use negative values to keep and send the complete parameters, NB. this config item is added for the sake of performance. | `1024` |
## Optional Plugins

View File

@ -80,6 +80,9 @@ have been highlighted.
<img src="http://skywalking.apache.org/ui-doc/7.0.0/profile-result.png"/>
### Advanced features
1. Since 7.1.0, the profiled trace collects the HTTP request parameters for Tomcat and SpringMVC Controller automatically.
## Alarm
Alarm page lists all triggered alarm. Read the backend setup documentation to know how to set up the alarm rule or integrate
with 3rd party system.