[skywalking] branch master updated: Update the network profiling documentation (#10072)

[wusheng]

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

wusheng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking.git


The following commit(s) were added to refs/heads/master by this push:
     new a269a0016e Update the network profiling documentation (#10072)
a269a0016e is described below

commit a269a0016e824cfb74803e9b31070f8929f7dc85
Author: mrproliu <741550...@qq.com>
AuthorDate: Fri Dec 2 11:34:30 2022 +0800

    Update the network profiling documentation (#10072)
---
 docs/en/changes/changes.md                         |  1 +
 .../backend/backend-k8s-network-monitoring.md      | 24 ++++++++++++++++++++++
 docs/en/ui/README.md                               |  1 +
 3 files changed, 26 insertions(+)

diff --git a/docs/en/changes/changes.md b/docs/en/changes/changes.md
index fefcb17362..51fd088aee 100644
--- a/docs/en/changes/changes.md
+++ b/docs/en/changes/changes.md
@@ -205,5 +205,6 @@
 * Add new docs for `Record` query protocol
 * Update `Server Agents` and `Compatibility` for PHP agent.
 * Add docs for profiling.
+* Update the network profiling documentation.
 
 All issues and pull requests are 
[here](https://github.com/apache/skywalking/milestone/149?closed=1)
diff --git a/docs/en/setup/backend/backend-k8s-network-monitoring.md 
b/docs/en/setup/backend/backend-k8s-network-monitoring.md
index 4cc35d5446..a61390c987 100644
--- a/docs/en/setup/backend/backend-k8s-network-monitoring.md
+++ b/docs/en/setup/backend/backend-k8s-network-monitoring.md
@@ -16,6 +16,19 @@ agent-analyzer:
     meterAnalyzerActiveFiles: 
${SW_METER_ANALYZER_ACTIVE_FILES:network-profiling}
 ```
 
+## Sampling config
+
+**Notice the precondition, the HTTP request must have the trace header in 
SkyWalking(`sw8` header) or Zipkin(`b3` header(s)) format.**
+
+The sampling configurations define the sampling boundaries for the HTTP 
traffic. When a HTTP calling is sampled,
+the SkyWalking Rover could collect the HTTP request/response raw data and 
upload it to the span attached event. 
+
+The sampling config contains multiple rules, and each of rules has the 
following configurations:
+1. `URI Regex`: The match pattern for HTTP requests is HTTP URI-oriented. 
Match all requests if the URI regex is not set.
+2. `Minimal Request Duration (ms)`: Sample the HTTP requests with slower 
latency than this threshold.
+3. `Sample HTTP requests and responses with tracing when the response code is 
between 400 and 499`: This is OFF by default.
+4. `Sample HTTP requests and responses with tracing when the response code is 
between 500 and 599`: This is ON by default.
+
 ## Supported metrics
 
 After SkyWalking OAP server receives the metrics from the SkyWalking Rover, it 
supports to analysis the following data:
@@ -33,3 +46,14 @@ After SkyWalking OAP server receives the metrics from the 
SkyWalking Rover, it s
 3. Local process communicate with peer address exception data, including 
following types:
    1. **Retransmit**: The count of TCP package is retransmitted.
    2. **Drop**: The count of TCP package is dropped.
+4. HTTP/1.x request/response related metrics, including following types:
+   1. **Request CPM**: The calls per minute of requests.
+   2. **Response CPM**: The calls per minute of responses with status code.
+   3. **Request Package Size**: The size(KB) of the request package.
+   4. **Response Package Size**: The size(KB) of the response package.
+   5. **Client Side Response Duration**: The duration(ms) of the client 
receive the response.
+   6. **Server Side Response Duration**: The duration(ms) of the server send 
the response.
+5. HTTP sampled request with traces, including following types:
+   1. **Slow traces**: The traces which have slow duration.
+   2. **Traces from HTTP Code in [400, 500) (ms)**: The traces which response 
status code in [400, 500).
+   3. **Traces from HTTP Code in [500, 600) (ms)**: The traces which response 
status code in [500, 600).
diff --git a/docs/en/ui/README.md b/docs/en/ui/README.md
index 78ba62f2df..58dee08dcd 100644
--- a/docs/en/ui/README.md
+++ b/docs/en/ui/README.md
@@ -55,6 +55,7 @@ To display one or more metrics in a graph, the following 
information is required
 |read all values of labels in the duration|Table|<img 
src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-tables.png";
 />|
 |read all values in the duration|Area|<img 
src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-area.png";
 />|
 |read all values in the duration|Service/Instance/Endpoint List|<img 
src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-entity-table.png";
 />|
+|read sampled records in the duration|Records List|<img 
src="https://skywalking.apache.org/screenshots/9.2.0/customized-dashboard-metrics-20221201-sampled-records.png";
 />|
 
 #### Calculations