Skip to content

Commit

Permalink
fix: fix docs for log retention (#9149)
Browse files Browse the repository at this point in the history
  • Loading branch information
salonig23 authored Apr 11, 2024
1 parent bd29f1f commit d0497da
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/reference/deploy/master-config-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1570,13 +1570,13 @@ Specifies configuration settings for the retention of trial logs.
Number of days to retain logs for by default. This can be overridden on a per-experiment basis in
the :ref:`experiment configuration <log-retention-days>`. Values should be between ``-1`` and
``32767``. The default value is ``-1``, retaining logs indefinitely. If set to ``0``, logs will be
deleted during the next cleanup. If this value is not set, ``det master cleanup-logs`` can be called
to manually run retention.
deleted during the next cleanup.

``schedule``
============

Schedule for cleaning up logs. Can be provided as a cron expression or a duration string.
Schedule for cleaning up logs. Can be provided as a cron expression or a duration string. If this
value is not set, ``det task cleanup-logs`` can be called to manually run retention.

For example, to schedule cleanup for midnight every day:

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/logging-retention.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@
duration format. If retention days is set to ``-1``, logs will be retained indefinitely.
Conversely, setting retention days to 0 will result in logs being deleted during the next
scheduled log cleanup. Additionally, administrators can manually initiate log retention cleanup
using the ``det master cleanup-logs command``.
using the ``det task cleanup-logs command``.

0 comments on commit d0497da

Please sign in to comment.