update docs

maksimryndin · Mar 1, 2024 · b6e54de · b6e54de
1 parent 75c7299
commit b6e54de
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/.github/site/src/SUMMARY.md b/.github/site/src/SUMMARY.md
@@ -2,8 +2,8 @@
 
 - [Start](./start.md)
     - [System requirements](./system-requirements.md)
-    - [Setup](./setup.md)
     - [Installation](./installation.md)
+    - [Setup](./setup.md)
 - [Services](./services.md)
     - [General](./general.md)
     - [Healthcheck](./healthcheck.md)

diff --git a/.github/site/src/installation.md b/.github/site/src/installation.md
@@ -46,6 +46,7 @@ messenger.url = "https://api.telegram.org/bot12345678:XXXXXxxxxx-XXXddxxss-XXX/s
 spreadsheet_id = "<spreadsheet_id_1>"
 messenger.specific.chat_id = "-111111111111"
 messenger.url = "https://api.telegram.org/bot12345678:XXXXXxxxxx-XXXddxxss-XXX/sendMessage"
+messenger.send_google_append_error = false
 autotruncate_at_usage_percent = 90
 [[healthcheck.liveness]]
 name = "backend"

diff --git a/.github/site/src/recommended-deployment.md b/.github/site/src/recommended-deployment.md
@@ -2,7 +2,15 @@
 
 ## Linux
 
-Goral follows a fail-fast approach - if something violates assumptions (marked with `assert:`), the safest thing is to panic and restart. It doesn't behave like that for recoverable errors, of course. For example, if Goral cannot send a message via messenger, it will try to message via General service notifications and its logs. And will continue working and collecting data. If it cannot connect to Google API, it will retry first. 
+Goral follows a fail-fast approach - if something violates assumptions (marked with `assert:`), the safest thing is to panic and restart. It doesn't behave like that for recoverable errors, of course. For example, if Goral cannot send a message via messenger, it will try to message via General service notifications and its logs. And will continue working and collecting data. If it cannot connect to Google API, it will retry first.
+
+For some services like healthcheck you may want to suppress sending of Google API errors with 
+
+```toml
+messenger.send_google_append_error = false
+```
+
+to minimize unactionable notifications. Failure to append rows to a spreadsheet doesn't impact [rules notifications](./rules.md) and [healthchecks](./healthcheck.md) as they are triggered before an append operation.
 
 There is also a case of fatal errors (e.g. `MissingToken error` for Google API which usually means that system time has skewed). In that case only someone outside can help. And in case of such panics Goral first tries to notify you via a messenger configured for General service to let you know immediately.