system-syslog-tcp-senders

Retrieves transmit statistics for syslog TCP senders.

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-syslog-tcp-senders

Output fields

Field	Type	Description
remote_ip	ipaddr	IP address of the destination server
remote_port	integer	Port number of the destination server
framing	string	TCP framing method. `LF` or `RFC6587`
is_connected	boolean	Current TCP connection status. `true` if connected
sent_count	long	Number of successfully transmitted messages
dropped_count	long	Number of messages dropped due to transmit failure
queued_count	long	Number of messages waiting to be transmitted
sent_bytes	long	Total data size successfully transmitted (bytes)
dropped_bytes	long	Total data size dropped due to transmit failure (bytes)
queued_bytes	long	Total data size waiting to be transmitted (bytes)
last_connect_time	timestamp	Most recent time a TCP connection was established
first_sent_time	timestamp	Time of the first message transmission
last_sent_time	timestamp	Time of the most recent message transmission

Error codes

Parsing errors

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

Runtime errors

N/A

Description

The system-syslog-tcp-senders command retrieves statistics for syslog TCP senders configured in Logpresso. For each destination server, you can check the connection status, sent/queued/dropped counts and sizes, and the first and most recent transmission times.

The framing field indicates the TCP framing method and takes one of the following values:

LF: Messages are delimited by a line feed (LF) character.
RFC6587: Octet counting method as defined in RFC 6587.

Cluster administrator permission is required. Running this command without administrator permission causes a parsing error.

Examples

Retrieve all syslog TCP sender status
```
system-syslog-tcp-senders
```
Retrieves statistics for all configured syslog TCP senders.
Retrieve disconnected senders
```
system-syslog-tcp-senders
| search is_connected == false
```
Filters and retrieves only senders whose TCP connection is currently disconnected.
Retrieve senders with dropped messages
```
system-syslog-tcp-senders
| search dropped_count > 0
```
Filters and retrieves only senders that have dropped messages to assess the scope of message loss.

Change history

The system-syslog-tcp-senders command is available since version 5.0.2603.0.