Re #39: Documented shutdown timeout.

tkowalcz · Jul 30, 2021 · 51f28da · 51f28da
1 parent 81e419a
commit 51f28da
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/log4j2-appender/README.md b/log4j2-appender/README.md
@@ -228,3 +228,8 @@ in [promtail configuration](https://grafana.com/docs/loki/latest/clients/promtai
 Like
 in [promtail configuration](https://grafana.com/docs/loki/latest/clients/promtail/configuration/) `maximum amount of time to wait before sending a batch, even if that batch isn't full`
 .
+
+#### shutdownTimeoutSeconds (optional, default = 10s)
+
+On logging system shutdown (or config reload) Tjahzi will flush its internal buffers so that no logs are lost. This
+property sets limit on how long to wait for this to complete before proceeding with shutdown.
diff --git a/logback-appender/README.md b/logback-appender/README.md
@@ -202,3 +202,4 @@ or use Tjahzi optimized efficient, low allocation encoder:
 | UseOffHeapBuffer | true | Whether Tjahzi should allocate native buffer for `Log buffer` component. We can go into a rabbit hole of divagations what are the implications of this. Most important in our view is that having 10s or 100s of MB of space taken out of heap is not very friendly to garbage collector which might have to occasionally copy it around. |
 | BatchSize | 100 KB | Like in [promtail configuration](https://grafana.com/docs/loki/latest/clients/promtail/configuration/) `maximum batch size (in bytes) of logs to accumulate before sending the batch to Loki`.|
 | BatchWait | 5s | Like in [promtail configuration](https://grafana.com/docs/loki/latest/clients/promtail/configuration/) `maximum amount of time to wait before sending a batch, even if that batch isn't full`.|
+| shutdownTimeoutSeconds | 10s | On logging system shutdown (or config reload) Tjahzi will flush its internal buffers so that no logs are lost. This property sets limit on how long to wait for this to complete before proceeding with shutdown. |