Skip to content

Commit

Permalink
docs: update alloc logs to document new behaviour.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrasell committed Mar 20, 2023
1 parent 25b4dfb commit 75c93da
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions website/content/docs/commands/alloc/logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ allocation is only running a single task, the task name can be omitted.
Optionally, the `-job` option may be used in which case a random allocation from
the given job will be chosen.

Task name may also be specified using the `-task` option rather than a command
argument. If task name is given with both an argument and the `-task` option,
Task name may also be specified using the `-task` option rather than a command
argument. If task name is given with both an argument and the `-task` option,
preference is given to the `-task` option.

When ACLs are enabled, this command requires a token with the `read-logs`,
Expand All @@ -35,6 +35,10 @@ When ACLs are enabled, this command requires a token with the `read-logs`,

## Logs Options

- `-stdout`: Display stdout logs. This is used as the default value in all
commands expect when using the `-f` flag where both stdout and stderr are
used as default.

- `-stderr`: Display stderr logs.

- `-verbose`: Display verbose output.
Expand All @@ -45,7 +49,8 @@ When ACLs are enabled, this command requires a token with the `read-logs`,
- `-task`: Specify the task to view the logs.

- `-f`: Causes the output to not stop when the end of the logs are reached, but
rather to wait for additional output.
rather to wait for additional output. When supplied with no other flags except
optionally `-job` and `-task`, both stdout and stderr logs will be followed.

- `-tail`: Show the logs contents with offsets relative to the end of the logs.
If no offset is given, -n is defaulted to 10.
Expand Down

0 comments on commit 75c93da

Please sign in to comment.