Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] HTTP client stats #70512

Merged
merged 12 commits into from
Mar 19, 2021
48 changes: 48 additions & 0 deletions docs/reference/cluster/nodes-stats.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1879,6 +1879,54 @@ Current number of open HTTP connections for the node.
`total_opened`::
(integer)
Total number of HTTP connections opened for the node.

`clients`::
(array of objects)
Information on current and recently-closed HTTP client connections.
+
.Properties of `clients`
[%collapsible%open]
=======
`id`::
(integer)
Unique ID for the HTTP client.
`agent`::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I'd add a newline between each definition for readability. Won't affect the HTML output tho.

(string)
Reported agent for the HTTP client. If unavailable, this property is not
included in the response.
`local_address`::
(string)
Local address for the HTTP client.
`remote_address`::
(string)
Remote address for the HTTP client.
`last_uri`::
(string)
The URI of the client's most recent request.
`x_forwarded_for`::
(string)
Value from the client's `x-forwarded-for` HTTP header. If unavailable, this
property is not included in the response.
`x_opaque_id`::
(string)
Value from the client's `x-opaque-id` HTTP header. If unavailable, this property
is not included in the response.
`opened_time_millis`::
(integer)
Time at which the client opened the connection.
`closed_time_millis`::
(integer)
Time at which the client closed the connection if the connection is closed.
`last_request_time_millis`::
(integer)
Time of the most recent request from this client.
`request_count`::
(integer)
Number of requests from this client.
`request_size_bytes`::
(integer)
Cumulative size in bytes of all requests from this client.
=======
======

[[cluster-nodes-stats-api-response-body-breakers]]
Expand Down