From 9caa9fe79ff088424badb09c197a346307473851 Mon Sep 17 00:00:00 2001
From: Alex Samuel <alex@alexsamuel.net>
Date: Mon, 16 Dec 2024 16:56:28 -0500
Subject: [PATCH] Docs.

---
 docs/config.rst                  | 29 +++++++++++++++++++++++++++++
 test/manual/procstar/config.yaml |  4 ++++
 2 files changed, 33 insertions(+)

diff --git a/docs/config.rst b/docs/config.rst
index 866352a8..6e943b21 100644
--- a/docs/config.rst
+++ b/docs/config.rst
@@ -42,6 +42,14 @@ config file.
     host_groups:
       # ...
 
+    python:
+      gc:
+        enable: true
+        threshold: [100000, 100, 100]
+
+    procstar:
+      # ...
+
 
 A duration is in in seconds, or you may give durations like `30s`, `10 min`
 (600 seconds), `1.5h` (5400 seconds), and `1 day` (86400 seconds).
@@ -143,6 +151,27 @@ A single host name is effectively a host alias.
       my_alias: host4.example.com
 
 
+Python
+------
+
+Apsis allocates large numbers of Python objects, but does not heavily use Python
+data structures.  Python's garbage collection (GC) will occasionally run for a
+substantial time, which blocks Apsis and can lead to timeouts.  To enable
+(default) or disable GC, or adjust its thresholds:
+
+.. code:: yaml
+
+    python:
+      gc:
+        enable: false
+        threshold: [100000, 100, 100]
+
+The thresholds apply only if GC is enabled.  See documentation for
+`gc.set_threshold()
+<https://docs.python.org/3/library/gc.html#gc.set_threshold>`_ for an
+explanation of these values.
+
+
 Procstar
 --------
 
diff --git a/test/manual/procstar/config.yaml b/test/manual/procstar/config.yaml
index 6d7dd6c8..07bb449d 100644
--- a/test/manual/procstar/config.yaml
+++ b/test/manual/procstar/config.yaml
@@ -3,6 +3,10 @@ database:
   timeout: 0.1m
 jobs: jobs
 
+python:
+  gc:
+    enabled: False
+
 procstar:
   agent:
     enable: true