clients (instance statistics)
Selecting the clients resource will list all connected clients by name. Selecting a single client will show various statistics for that client.
| Metric | Description | Type |
|---|---|---|
authenticated_id | The ID used to authenticate this client, if any. | fixed |
bytes_in | Number of bytes received. | cumulative |
bytes_in_per_sec | Rate of bytes received. | interval average |
bytes_out | Number of bytes sent. | cumulative |
bytes_out_per_sec | Rate of bytes received. | interval average |
client_name | Identifier for the client, set during logon. | fixed |
client_name_hash | AMPS hash for the client name. | fixed |
client_version | Version string provided by the client. | fixed |
connect_time | UTC time client connection is established. | fixed |
connection_name | Name of the connection. | fixed |
correlation_id | The CorrelationId provided with the logon command, if any. | fixed |
denied_reads | Number of read requests which have been denied due to an entitlement filter. | cumulative |
denied_writes | Number of write requests which have been denied due to an entitlement filter. | cumulative |
messages_in | Number of messages received from client. | cumulative |
messages_in_per_sec | Rate of messages received. | interval average |
messages_out | Number of messages sent to the client. | cumulative |
messages_out_per_sec | Rate of messages sent to the client. | interval average |
query_time | The amount of time spent for queries from this client. | cumulative |
queue_depth_out | Number of messages queued to be sent to client. This represents a count of the messages that AMPS cannot write to the outgoing socket due to the transmit buffer being full. This does not count messages already written to the transmit buffer. (The transport_tx_queue has information about the transmit buffer.) | snapshot |
queue_max_latency | The age of the oldest item in the queue which has not yet been sent. This is used as a measure of how far behind AMPS believes a subscribing client is. This measures the age of the oldest message that AMPS cannot write to the outgoing socket due to the transmit buffer being full. This does not count messages already written to the transmit buffer. (The transport_tx_queue has information about the transmit buffer.) The latency is measured in seconds at the resolution of the system clock. | snapshot |
queued_bytes_out | Number of queued bytes waiting to be sent. This represents a count of the number of bytes that AMPS cannot write to the outgoing socket due to the transmit buffer being full. This does not count messages already written to the transmit buffer (transport_tx_queue will show messages written to the transmit buffer that have not yet been sent). | snapshot |
remote_address | Address and port of the remote side of the client connection. | fixed |
subscription_count | Number of subscriptions currently active for the client. | snapshot |
tcp_zero_window_advert | Shows whether this client is currently advertising a zero window size. This is 1 if the client is advertising a windows size of zero, set to 0 if the client is advertising any other value or if the client connection does not use TCP (for example, the client uses UDS to connect to AMPS). | snapshot |
transport_rx_queue | Number of bytes in the transport receive buffer (typically the TCP buffer) for this client. This measures messages arriving from the client. | snapshot |
transport_tx_queue | Number of bytes in transport transmit buffer (typically the TCP buffer) for this client. This measures messages being sent to the client. | snapshot |
Statistics Database Tables: ICLIENTS_STATIC, ICLIENTS_DYNAMIC
Admin Path: /amps/instance/clients/<id>/<metric>