Skip to content

Commit a269a00

Browse files
authored
Update the network profiling documentation (#10072)
1 parent f2fd64b commit a269a00

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

docs/en/changes/changes.md

+1
Original file line numberDiff line numberDiff line change
@@ -205,5 +205,6 @@
205205
* Add new docs for `Record` query protocol
206206
* Update `Server Agents` and `Compatibility` for PHP agent.
207207
* Add docs for profiling.
208+
* Update the network profiling documentation.
208209

209210
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/149?closed=1)

docs/en/setup/backend/backend-k8s-network-monitoring.md

+24
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@ agent-analyzer:
1616
meterAnalyzerActiveFiles: ${SW_METER_ANALYZER_ACTIVE_FILES:network-profiling}
1717
```
1818
19+
## Sampling config
20+
21+
**Notice the precondition, the HTTP request must have the trace header in SkyWalking(`sw8` header) or Zipkin(`b3` header(s)) format.**
22+
23+
The sampling configurations define the sampling boundaries for the HTTP traffic. When a HTTP calling is sampled,
24+
the SkyWalking Rover could collect the HTTP request/response raw data and upload it to the span attached event.
25+
26+
The sampling config contains multiple rules, and each of rules has the following configurations:
27+
1. `URI Regex`: The match pattern for HTTP requests is HTTP URI-oriented. Match all requests if the URI regex is not set.
28+
2. `Minimal Request Duration (ms)`: Sample the HTTP requests with slower latency than this threshold.
29+
3. `Sample HTTP requests and responses with tracing when the response code is between 400 and 499`: This is OFF by default.
30+
4. `Sample HTTP requests and responses with tracing when the response code is between 500 and 599`: This is ON by default.
31+
1932
## Supported metrics
2033

2134
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
3346
3. Local process communicate with peer address exception data, including following types:
3447
1. **Retransmit**: The count of TCP package is retransmitted.
3548
2. **Drop**: The count of TCP package is dropped.
49+
4. HTTP/1.x request/response related metrics, including following types:
50+
1. **Request CPM**: The calls per minute of requests.
51+
2. **Response CPM**: The calls per minute of responses with status code.
52+
3. **Request Package Size**: The size(KB) of the request package.
53+
4. **Response Package Size**: The size(KB) of the response package.
54+
5. **Client Side Response Duration**: The duration(ms) of the client receive the response.
55+
6. **Server Side Response Duration**: The duration(ms) of the server send the response.
56+
5. HTTP sampled request with traces, including following types:
57+
1. **Slow traces**: The traces which have slow duration.
58+
2. **Traces from HTTP Code in [400, 500) (ms)**: The traces which response status code in [400, 500).
59+
3. **Traces from HTTP Code in [500, 600) (ms)**: The traces which response status code in [500, 600).

docs/en/ui/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ To display one or more metrics in a graph, the following information is required
5555
|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" />|
5656
|read all values in the duration|Area|<img src="https://skywalking.apache.org/screenshots/9.2.0/customize-dashboard-metrics-20220817-area.png" />|
5757
|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" />|
58+
|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" />|
5859

5960
#### Calculations
6061

0 commit comments

Comments
 (0)