From cb13890d27df4fff1895ed2597d626853bde1274 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Thu, 16 Jan 2025 15:24:19 +0100 Subject: [PATCH] DOCS-3366: Deduplicate noisy logs --- docs/manage/troubleshoot/troubleshoot.md | 4 ++++ docs/operate/reference/viam-server/_index.md | 11 +++++++++++ 2 files changed, 15 insertions(+) diff --git a/docs/manage/troubleshoot/troubleshoot.md b/docs/manage/troubleshoot/troubleshoot.md index 747dfd5e6b..053de4d795 100644 --- a/docs/manage/troubleshoot/troubleshoot.md +++ b/docs/manage/troubleshoot/troubleshoot.md @@ -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 diff --git a/docs/operate/reference/viam-server/_index.md b/docs/operate/reference/viam-server/_index.md index c01ad69590..c38891a551 100644 --- a/docs/operate/reference/viam-server/_index.md +++ b/docs/operate/reference/viam-server/_index.md @@ -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: