Skip to content

Commit

Permalink
update docs LogFileSize
Browse files Browse the repository at this point in the history
Signed-off-by: Naren Krishna <naren@ponder.io>
  • Loading branch information
naren-ponder committed Jun 8, 2022
1 parent e056e8c commit 18cee50
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/usage_guide/advanced_usage/modin_logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ in addition to Modin API calls (see the usage examples below).

The logs generated by Modin Logging will be written to a ``.modin/logs/job_<uuid>`` directory, uniquely named after the job uuid.
The logs that contain the Modin API stack traces are named ``trace.log``. The logs that contain the memory utilization metrics are
named ``memory.log``. By default, if any log file exceeds 10MB, the logs will rollover and several files will be created. For instance, if
users have 20MB worth of Modin API logs, they can expect to find ``trace.log.1`` and ``trace.log.2`` in the ``.modin/logs/job_<uuid>`` directory.
named ``memory.log``. By default, if any log file exceeds 10MB (configurable with ``LogFileSize``), that file will be saved and a
separate log file will be created. For instance, if users have 20MB worth of Modin API logs, they can expect to find ``trace.log.1``
and ``trace.log.2`` in the ``.modin/logs/job_<uuid>`` directory. After ``10 * LogFileSize`` MB or by default 100MB of logs, the logs will
rollover and the original log files beginning with ``trace.log.1`` will be overwritten with the new log lines.

**Developer Warning:** In some cases, running services like JupyterLab in the ``modin/modin`` directory may result in circular dependency issues.
This is due to a naming conflict between the ``modin/logging`` directory and the Python ``logging`` module, which may be used as a default in
Expand Down

0 comments on commit 18cee50

Please sign in to comment.