system-udp-metrics

Retrieves UDP communication statistics for the local server.

Command properties

Property	Description
Command type	Driver query
Required permission	Cluster administrator
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

system-udp-metrics

Output fields

Field	Type	Description
rx_pkts	long	Number of received UDP packets
rx_errors	long	Number of receive errors
rx_buf_errors	long	Number of receive buffer errors
tx_pkts	long	Number of transmitted UDP packets
tx_buf_errors	long	Number of transmit buffer errors

Error codes

Parsing errors

Error code	Message	Description
10000	no-read-permission	The user does not have cluster administrator privileges

Runtime errors

N/A

Description

The system-udp-metrics command retrieves UDP communication statistics for the local server. It parses the UDP section of netstat -s output, so it works only on Linux. If the net-tools package, which provides the netstat command, is not installed on the server, the query fails.

You can monitor UDP-based communications such as syslog reception by checking receive (rx_*) and transmit (tx_*) buffer errors.

Cluster administrator privileges are required to run this command.

Examples

Retrieve UDP communication statistics
```
system-udp-metrics
```
Retrieves UDP receive and transmit statistics for the local server.
Check for buffer errors
```
system-udp-metrics
| search rx_buf_errors > 0 or tx_buf_errors > 0
```
Filters results to show only cases where UDP buffer errors have occurred.

Change history

The system-udp-metrics command is available since version 5.0.2603.0.