system forwarder-channels

Retrieves per-channel send and drop statistics, and swap usage for Forwarder Nodes.

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 forwarder-channels

Output fields

Field	Type	Description
type	string	Channel type. `node`: single node, `pair`: node pair, `roundrobin`: round-robin group
name	string	Channel name
sent	long	Number of records successfully sent
poll	long	Number of records read from the swap
drop	long	Number of records dropped
swap_capacity	long	Maximum capacity of the swap buffer (bytes)
swap_size	long	Size of data stored in the swap buffer (bytes)
swap_usage	long	Disk size currently used by the swap buffer (bytes)

Error codes

Parsing errors

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

Runtime errors

N/A

Description

The system forwarder-channels command retrieves statistics for each connection channel configured on Forwarder Nodes. It returns statistics for three channel types: single node (node), node pair (pair), and round-robin group (roundrobin).

The drop field indicates the number of records dropped because the swap buffer capacity was exceeded. Channels with drops can be identified by filtering with drop > 0.

Cluster administrator permission is required to run this command.

Examples

Retrieve all forwarder channel statistics
```
system forwarder-channels
```
Retrieves statistics for all connection channels configured on Forwarder Nodes.
Retrieve channels with dropped records
```
system forwarder-channels
| search drop > 0
| fields type, name, sent, drop, swap_capacity, swap_usage
```
Filters and retrieves only channels where records have been dropped.
Aggregate statistics by channel type
```
system forwarder-channels
| stats sum(sent) as total_sent, sum(drop) as total_drop by type
```
Aggregates the total sent count and dropped count by channel type.