DOCS-3366: Deduplicate noisy logs (#3860)

viamrobotics · Jan 22, 2025 · b7324ed · b7324ed
1 parent a007c79
commit b7324ed
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 0 deletions.
diff --git 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
@@ -144,6 +144,62 @@ 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.
 
+{{% expand "Click to view full configuration example" %}}
+
+```json {class="line-numbers linkable-line-numbers" data-line="10-18"}
+{
+  "components": [
+    {
+      "name": "camera1",
+      "type": "camera",
+      "model": "fake"
+    }
+  ],
+  "services": [],
+  "log": [
+    {
+      "pattern": "rdk.resource_manager",
+      "level": "info"
+    },
+    {
+      "pattern": "rdk.resource_manager.*",
+      "level": "debug"
+    }
+  ]
+}
+```
+
+{{% /expand%}}
+
+#### 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
+```
+
+{{% expand "Click to view full configuration example" %}}
+
+```json {class="line-numbers linkable-line-numbers" data-line="10"}
+{
+  "components": [
+    {
+      "name": "camera1",
+      "type": "camera",
+      "model": "fake"
+    }
+  ],
+  "services": [],
+  "disable_log_deduplication": true
+}
+```
+
+{{% /expand%}}
+
 #### Debugging
 
 You can enable debug level logs in two ways: