sentryswap

Retrieves data pending transmission in the sentry disk swap buffer.

Command properties

Property	Description
Command type	Driver
Required permission	None
License usage	Excluded from license aggregation
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

sentryswap base=STR

Options

base=STR: The unique identifier name of the base server connected to the sentry. The base server refers to the Logpresso server that receives logs from the sentry.

Output fields

Field	Type	Description
_time	timestamp	Timestamp of the log.
_logger	string	Logger name.

In addition to the fields above, the original key-value pairs of records in the pending transmission buffer are also output.

Error codes

Parsing errors

Error code	Message	Description
invalid-base	-	The base server specified in the `base` option does not exist.

Runtime errors

N/A

Description

The sentryswap command queries data swapped to the sentry transmission queue when a sentry is installed on the same host as the Logpresso server. Because the sentry transmission queue is managed separately per base server, you must specify the target base using the base option.

This command is typically used to check the number of records pending in the transmission queue when a backlog occurs, or to back up the data in the queue and then delete the swap to restore the system connection state.

Data is retrieved starting from after the last read block.

Note

The `sentryswap` command is available only when Logpresso and the sentry are installed on the same host.

Examples

Retrieve swap data for a specific base server
```
sentryswap base=main
```
Retrieves the pending swap data for the main base server.