Skip to content

Commit

Permalink
Docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhsamuel committed Dec 16, 2024
1 parent 800c875 commit 9caa9fe
Showing 2 changed files with 33 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
@@ -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
--------

4 changes: 4 additions & 0 deletions test/manual/procstar/config.yaml
Original file line number Diff line number Diff line change
@@ -3,6 +3,10 @@ database:
timeout: 0.1m
jobs: jobs

python:
gc:
enabled: False

procstar:
agent:
enable: true

0 comments on commit 9caa9fe

Please sign in to comment.