[skywalking] 01/01: Add documents for apdex and parameter explanation for heatmap, apdex and p99

[wu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wusheng pushed a commit to branch fix-oal-doc
in repository https://gitbox.apache.org/repos/asf/skywalking.git

commit 0906dc5090a203939425e603e56fbaaca578f6b7
Author: Wu Sheng <wu...@foxmail.com>
AuthorDate: Fri Dec 27 21:27:17 2019 +0800

    Add documents for apdex and parameter explanation for heatmap, apdex and p99
---
 docs/en/concepts-and-designs/oal.md | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/docs/en/concepts-and-designs/oal.md b/docs/en/concepts-and-designs/oal.md
index 1721e26..b132115 100644
--- a/docs/en/concepts-and-designs/oal.md
+++ b/docs/en/concepts-and-designs/oal.md
@@ -60,11 +60,20 @@ In this case, calls of each service.
 - `p99`, `p95`, `p90`, `p75`, `p50`. Read [p99 in WIKI](https://en.wikipedia.org/wiki/Percentile)
 > All_p99 = from(All.latency).p99(10);
 
-In this case, p99 value of all incoming requests.
+In this case, p99 value of all incoming requests. The parameter is the precision of p99 latency calculation, such as in above case, 120ms and 124 are considered same.
 - `thermodynamic`. Read [Heatmap in WIKI](https://en.wikipedia.org/wiki/Heat_map))
 > All_heatmap = from(All.latency).thermodynamic(100, 20);
 
-In this case, thermodynamic heatmap of all incoming requests.
+In this case, thermodynamic heatmap of all incoming requests. 
+The parameter (1) is the precision of latency calculation, such as in above case, 113ms and 193ms are considered same in the 101-200ms group.
+The parameter (2) is the group amount. In above case, 21(param value + 1) groups are 0-100ms, 101-200ms, ... 1901-2000ms, 2000+ms 
+
+- `apdex`. Read [Apdex in WIKI](https://en.wikipedia.org/wiki/Apdex)
+> service_apdex = from(Service.latency).apdex(name, status);
+
+In this case, apdex score of each service.
+The parameter (1) is the service name, which effects the Apdex threshold value loaded from service-apdex-threshold.yml in the config folder.
+The parameter (2) is the status of this request. The status(success/failure) effects the Apdex calculation.
 
 ## Metrics name
 The metrics name for storage implementor, alarm and query modules. The type inference supported by core.