Skip to content

Commit

Permalink
DOCS-3366: Deduplicate noisy logs
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel committed Jan 16, 2025
1 parent 2c7e413 commit cb13890
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/manage/troubleshoot/troubleshoot.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ For example:

For more information on setting log levels see, [Logging](/manage/troubleshoot/troubleshoot/#check-logs).

You may also find that not all logs you are expecting are displayed.
By default, `viam-server` deduplicates log messages that are deemed noisy.
To disable this behavior, see [Disable log deduplication](/operate/reference/viam-server/).

To access logs from the commandline, use [`viam machines logs`](/dev/tools/cli/#machines-alias-robots) on the command line or the [Machines API](/dev/reference/apis/robot/).

## Remote shell on the machine
Expand Down
11 changes: 11 additions & 0 deletions docs/operate/reference/viam-server/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,17 @@ Patterns are processed from top to bottom.
If multiple patterns apply, the last pattern to be processed will apply.
If log configurations are applied at a resource level using the `log_configuration` field, these take precedence over log levels applied in the `log` field of the machine configuration.

#### Disable log deduplication

By default, `viam-server` deduplicates log messages that are deemed noisy.
A log is deemed noisy if it has been output 3 times in the past 10 seconds.

To disable log deduplication, set `disable_log_deduplication` in your machine's configuration:

```json
"disable_log_deduplication": true
```

#### Debugging

You can enable debug level logs in two ways:
Expand Down

0 comments on commit cb13890

Please sign in to comment.