Skip to content

Commit 363d7fb

Browse files
heitortsergentheitortsergent
authored
chore: update built-in metrics description (#1459)
* chore: remove "please" * chore: update web vitals descriptions * chore: reorder tables * chore: update previous versions * chore: fix iterations order * chore: remove extra column
1 parent 7676310 commit 363d7fb

File tree

3 files changed

+98
-98
lines changed

3 files changed

+98
-98
lines changed

‎docs/sources/next/using-k6/metrics/reference.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ k6 always collects the following metrics, no matter what protocol the test uses:
1515

1616
| Metric Name | Type | Description |
1717
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
18-
| vus | Gauge | Current number of active virtual users |
19-
| vus_max | Gauge | Max possible number of virtual users (VU resources are [pre-allocated](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/concepts/arrival-rate-vu-allocation), to avoid affecting performance when scaling up load). |
20-
| iterations | Counter | The aggregate number of times the VUs execute the JS script (the `default` function). |
21-
| iteration_duration | Trend | The time to complete one full iteration, including time spent in `setup` and `teardown`. To calculate the duration of the iteration's function for the specific scenario, [try this workaround](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/workaround-iteration-duration). |
22-
| dropped_iterations | Counter | The number of iterations that weren't started due to lack of VUs (for the arrival-rate executors) or lack of time (expired maxDuration in the iteration-based executors). Refer to [Dropped iterations](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/concepts/dropped-iterations) for more details. |
18+
| checks | Rate | The rate of successful checks. |
2319
| data_received | Counter | The amount of received data. [This example covers how to track data for an individual URL](https://grafana.com/docs/k6/<K6_VERSION>/examples/track-transmitted-data-per-url). |
2420
| data_sent | Counter | The amount of data sent. [Track data for an individual URL](https://grafana.com/docs/k6/<K6_VERSION>/examples/track-transmitted-data-per-url) to track data for an individual URL. |
25-
| checks | Rate | The rate of successful checks. |
21+
| dropped_iterations | Counter | The number of iterations that weren't started due to lack of VUs (for the arrival-rate executors) or lack of time (expired maxDuration in the iteration-based executors). Refer to [Dropped iterations](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/concepts/dropped-iterations) for more details. |
22+
| iteration_duration | Trend | The time to complete one full iteration, including time spent in `setup` and `teardown`. To calculate the duration of the iteration's function for the specific scenario, [try this workaround](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/workaround-iteration-duration). |
23+
| iterations | Counter | The aggregate number of times the VUs execute the JS script (the `default` function). |
24+
| vus | Gauge | Current number of active virtual users |
25+
| vus_max | Gauge | Max possible number of virtual users (VU resources are [pre-allocated](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/concepts/arrival-rate-vu-allocation), to avoid affecting performance when scaling up load). |
2626

2727
## HTTP-specific built-in metrics {#http}
2828

@@ -37,15 +37,15 @@ In other words, the timestamp happens when k6 receives the end of the response b
3737

3838
| Metric Name | Type | Description |
3939
| ------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
40-
| http_reqs | Counter | How many total HTTP requests k6 generated. |
4140
| http_req_blocked | Trend | Time spent blocked (waiting for a free TCP connection slot) before initiating the request. `float` |
4241
| http_req_connecting | Trend | Time spent establishing TCP connection to the remote host. `float` |
43-
| http_req_tls_handshaking | Trend | Time spent handshaking TLS session with remote host |
44-
| http_req_sending | Trend | Time spent sending data to the remote host. `float` |
45-
| http_req_waiting | Trend | Time spent waiting for response from remote host (a.k.a. “time to first byte”, or “TTFB”). `float` |
46-
| http_req_receiving | Trend | Time spent receiving response data from the remote host. `float` |
4742
| http_req_duration | Trend | Total time for the request. It's equal to `http_req_sending + http_req_waiting + http_req_receiving` (i.e. how long did the remote server take to process the request and respond, without the initial DNS lookup/connection times). `float` |
4843
| http_req_failed | Rate | The rate of failed requests according to [setResponseCallback](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-http/set-response-callback). |
44+
| http_req_receiving | Trend | Time spent receiving response data from the remote host. `float` |
45+
| http_req_sending | Trend | Time spent sending data to the remote host. `float` |
46+
| http_req_tls_handshaking | Trend | Time spent handshaking TLS session with remote host |
47+
| http_req_waiting | Trend | Time spent waiting for response from remote host (a.k.a. “time to first byte”, or “TTFB”). `float` |
48+
| http_reqs | Counter | How many total HTTP requests k6 generated. |
4949

5050
## Browser metrics {#browser}
5151

@@ -55,11 +55,11 @@ These core metrics will evolve over time when technology changes, but for now, k
5555

5656
<!-- vale off -->
5757

58-
| Core Web Vital | Description |
59-
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
60-
| browser_web_vital_lcp | Measures a page's loading performance. Please refer to [Largest Contentful Paint](https://web.dev/lcp/) for more information. |
61-
| browser_web_vital_fid | Measures a page's interactivity. Please refer to [First Input Delay](https://web.dev/fid/) for more information. |
62-
| browser_web_vital_cls | Measures a page's visual stability. Please refer to [Cumulative Layout Shift](https://web.dev/cls/) for more information. |
58+
| Core Web Vital | Description |
59+
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
60+
| browser_web_vital_cls | Measures the visual stability on a webpage by quantifying the amount of unexpected layout shift of visible page content. Refer to [Cumulative Layout Shift](https://web.dev/cls/) for more information. |
61+
| browser_web_vital_fid | Measures the responsiveness of a web page by quantifying the delay between a user’s first interaction, such as clicking a button, and the browser’s response. Refer to [First Input Delay](https://web.dev/fid/) for more information. |
62+
| browser_web_vital_lcp | Measures the time it takes for the largest content element on a page to become visible. Refer to [Largest Contentful Paint](https://web.dev/lcp/) for more information. |
6363

6464
<!-- vale on -->
6565

@@ -69,11 +69,11 @@ Apart from the Core Web Vitals, the browser module also reports [Other Web Vital
6969

7070
<!-- vale off -->
7171

72-
| Other Web Vital | Description |
73-
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74-
| browser_web_vital_ttfb | Measures the time it takes between the browser request and the start of the response from a server. Please refer to [Time to First Byte](https://web.dev/ttfb/) for more information. |
75-
| browser_web_vital_fcp | Measures the time it takes for the browser to render the first DOM element on the page, whether that's a text, image or header. Please refer to [First Contentful Paint](https://web.dev/fcp/) for more information. |
76-
| browser_web_vital_inp | An experimental metric that measures a page's responsiveness. Please refer to [Interaction to Next Paint](https://web.dev/inp/) for more information. |
72+
| Other Web Vital | Description |
73+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
74+
| browser_web_vital_fcp | Measures the time it takes for the browser to render the first DOM element on the page, whether that's a text, image or header. Refer to [First Contentful Paint](https://web.dev/fcp/) for more information. |
75+
| browser_web_vital_inp | An experimental metric that measures a page's responsiveness. Refer to [Interaction to Next Paint](https://web.dev/inp/) for more information. |
76+
| browser_web_vital_ttfb | Measures the time it takes between the browser request and the start of the response from a server. Refer to [Time to First Byte](https://web.dev/ttfb/) for more information. |
7777

7878
<!-- vale on -->
7979

@@ -84,22 +84,22 @@ Apart from the Core Web Vitals, the browser module also reports [Other Web Vital
8484
| Metric name | Type | Description |
8585
| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------ |
8686
| ws_connecting | Trend | Total duration for the WebSocket connection request. |
87+
| ws_msgs_received | Counter | Total number of messages received |
88+
| ws_msgs_sent | Counter | Total number of messages sent |
89+
| ws_ping | Trend | Duration between a ping request and its pong reception |
8790
| ws_session_duration | Trend | Duration of the WebSocket session. Time between the start of the connection and the end of the VU execution. |
8891
| ws_sessions | Counter | Total number of started WebSocket sessions. |
89-
| ws_ping | Trend | Duration between a ping request and its pong reception |
90-
| ws_msgs_sent | Counter | Total number of messages sent |
91-
| ws_msgs_received | Counter | Total number of messages received |
9292

9393
## Built-in gRPC metrics {#grpc}
9494

9595
k6 emits the following metrics when it interacts with a service through the [`gRPC`](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/) API.
9696

97-
| Metric Name | Type | Description |
98-
| ---------------------------- | ------- | ----------------------------------------- |
99-
| `grpc_req_duration` | Trend | Time to receive response from remote host |
100-
| `grpc_streams` | Counter | Total number of started streams |
101-
| `grpc_streams_msgs_sent` | Counter | Total number of messages sent |
102-
| `grpc_streams_msgs_received` | Counter | Total number of messages received |
97+
| Metric Name | Type | Description |
98+
| -------------------------- | ------- | ----------------------------------------- |
99+
| grpc_req_duration | Trend | Time to receive response from remote host |
100+
| grpc_streams | Counter | Total number of started streams |
101+
| grpc_streams_msgs_received | Counter | Total number of messages received |
102+
| grpc_streams_msgs_sent | Counter | Total number of messages sent |
103103

104104
{{% admonition type="note" %}}
105105

0 commit comments

Comments
 (0)