Skip to content

Commit

Permalink
doc: introduce uv.uv_metrics_info() api
Browse files Browse the repository at this point in the history
  • Loading branch information
zhaozg committed May 20, 2023
1 parent fc9c04f commit a6e8ee1
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3738,6 +3738,22 @@ time until calling `loop_configure` with `"metrics_idle_time"`.

**Returns:** `number`

### `uv.metrics_info()`

Get the metrics table from current set of event loop metrics.

**Returns:** `table`

The table contains event loop metrics. It is recommended to retrieve these
metrics in a uv_prepare_cb in order to make sure there are no inconsistencies
with the metrics counters.

- `loop_count` : `integer`
- `events` : `integer`
- `events_waiting` : `integer`

**Note**: New in libuv version 1.45.0.

---

[luv]: https://github.com/luvit/luv
Expand Down

0 comments on commit a6e8ee1

Please sign in to comment.