Skip to content

Commit

Permalink
docs: add caveat of 200 line truncation in kurtosis service logs (#1209)
Browse files Browse the repository at this point in the history
## Description:
A user noticed that `kurtosis service logs` only displays 200 lines of
logs in the terminal. This was an arbitrary number chosen for UX. This
PR adds a tip in the docs for `kurtosis service shell` to recommend
users use the `kurtosis dump` command for a full snapshot of logs or the
`-f` flag for a stream of logs (i.e. follow the logs).

## Is this change user facing?
YES

## References (if applicable):
#1188
  • Loading branch information
leeederek committed Aug 31, 2023
1 parent 4df6a1c commit c774df0
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/docs/cli-reference/service-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,14 @@ kurtosis service logs $THE_ENCLAVE_IDENTIFIER $THE_SERVICE_IDENTIFIER

where `$THE_ENCLAVE_IDENTIFIER` and the `$THE_SERVICE_IDENTIFIER` are [resource identifiers](../concepts-reference/resource-identifier.md) for the enclave and service, respectively. The service identifier (name or UUID) is printed upon inspecting an enclave.

:::note Number of log lines
By default, logs printed in the terminal from this command are truncated at 200 lines. For a stream of logs, we recommend the `-f` flag. For a snapshot of the logs at a given point in time (e.g. after a change), we recommend the [`kurtosis dump`](./dump.md).
:::

The following optional arguments can be used:
1. `-f`, `-follow` can be added to continue following the logs, similar to `tail -f`.
1. `--match=text` can be used for filtering the log lines containing the text.
1. `--regex-match="regex"` can be used for filtering the log lines containing the regex. This filter will also work for text but will have degraded performance.
1. `-v`, `--invert-match` can be used to invert the filter condition specified by either `--match` or `--regex-match`. Log lines NOT containing the match will be returned.

Important: `--match` and `--regex-match` flags cannot be used at the same time. You should either use one or the other.
Important: `--match` and `--regex-match` flags cannot be used at the same time. You should either use one or the other.

0 comments on commit c774df0

Please sign in to comment.