athena-logs
Command that manages Athena logs.
Usage
athena-logs [OPTIONS] COMMAND [ARGS]...
| Option | Description |
|---|---|
| -h, –help | Show built-in help documentation. |
| -v, –verbose | Enable verbose output. |
Commands
Activate
Enable disabled logs.
athena-logs activate <index>
Arguments
<index>- Index to enable.
Activate
Archive old logs.
athena-logs archive [OPTIONS]
| Option | Description |
|---|---|
| –age |
Age (in days) of log indexes to retain. |
| –overwrite | Should existing snapshots be overwritten. |
| –repo |
Snapshot repository name. |
Disable
Disable old logs.
athena-logs deactivate [OPTIONS]
| Option | Description |
|---|---|
| –age |
Age (in days) of log indexes to retain. |
| –red | Deactivate all red indices. |
List
List available logs.
athena-logs list [OPTIONS]
| Option | Description |
|---|---|
| –repo |
Snapshot repository name. |
Ping
Ping log agents.
athena-logs ping
Tail
Tail / follow current logs.
athena-logs tail [OPTIONS]
| Option | Description |
|---|---|
| -f, –forever | Continue polling logs. |
| -n, –num-lines |
Number of log records to show. |
| –poll-interval |
Polling interval. |
| –poll-window |
Polling window. |
| –service |
Service filter. |
Unarchive
athena-logs unarchive [OPTIONS] <index>
| Option | Description |
|---|---|
| –overwrite | Should existing snapshots be overwritten. |
| –repo |
Snapshot repository name. |
Arguments
<index>- Index to unarchive.
Examples
To activate logs on ‘index1’:
athena-logs activate index1
To archive logs with default settings:
athena-logs archive
To archive logs older than 60 days to ‘test’ repo, and override snapshots if existing:
athena-logs archive --repo test --override --age 60
To deactivate old indices / logs.
athena-logs deactivate
To deactivate indices / logs older than 60 days and all red indices.
athena-logs deactivate --red --age 60
To list all available logs:
athena-logs list
To list all available logs from ‘test’ repo:
athena-logs list --repo test
To ping all log agents:
athena-logs ping
To tail current logs:
athena-logs tail
To tail current logs for ‘redmine’ service:
athena-logs tail --service redmine
To tail current logs continuously and limit lines to 20.
athena-logs tail --num-lines 20 --forever
To unarchive logs of ‘index1’.
athena-logs unarchive index1
To unarchive logs of ‘index1’ from the ‘test’ repo, and override existing snapshots.
athena-logs unarchive --repo test --override index1