Skip to content

Next release#1670

Open
jokob-sk wants to merge 3 commits into
mainfrom
next_release
Open

Next release#1670
jokob-sk wants to merge 3 commits into
mainfrom
next_release

Conversation

@jokob-sk
Copy link
Copy Markdown
Collaborator

@jokob-sk jokob-sk commented Jun 3, 2026

Summary by CodeRabbit

  • Documentation

    • Performance docs updated to explain how excessively large log files increase memory usage, include guidance for adjusting log retention for normal use vs. debugging, and add a memory-usage chart.
  • Chores

    • Reduced the default log retention value (250000 → 10000) and rewrote the setting description to include examples and note that setting 0 disables log purging.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 938d6db4-0bb6-46a9-b96e-40230d653d50

📥 Commits

Reviewing files that changed from the base of the PR and between 606dd10 and 491225d.

📒 Files selected for processing (1)
  • front/plugins/maintenance/config.json
✅ Files skipped from review due to trivial changes (1)
  • front/plugins/maintenance/config.json

📝 Walkthrough

Walkthrough

The PR reduces the default log retention length from 250,000 to 10,000 entries and updates the setting's documentation. Accompanying performance documentation explains the memory impact of large log files and guides users to adjust MAINT_LOG_LENGTH accordingly, with a visual reference chart.

Changes

Log Size Optimization

Layer / File(s) Summary
Log retention configuration and guidance
front/plugins/maintenance/config.json
The LOG_LENGTH setting's default_value is reduced from 250000 to 10000, and the English description is updated with new retention behavior and purging guidance text.
Memory impact documentation
docs/PERFORMANCE.md
The "Database and Log File Size" section now includes a note explaining that large log files increase memory consumption, introduces guidance to decrease MAINT_LOG_LENGTH for memory optimization or increase for debugging, and adds a memory-usage chart image.

Poem

🐰 Logs grow long, memory climbs high,
Trim them down—a thoughtful sigh.
Ten thousand entries, lean and neat,
Lighter memory, performance sweet.
Hop to tidy—debug then prune.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Next release' is vague and generic, using non-descriptive terms that don't convey meaningful information about the specific changes in this pull request. Replace with a descriptive title that summarizes the main changes, such as 'Reduce default log retention and update memory usage documentation' to better reflect the modifications to logging configuration and documentation.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch next_release

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@front/plugins/maintenance/config.json`:
- Line 243: Update the description for MAINT_LOG_LENGTH to reflect that it
applies to multiple logs, not just app.log: reword the string to state that
MAINT_LOG_LENGTH limits the number of retained lines for app.log,
nginx-error.log and stdout.log (and that setting 0 disables purging), keep the
existing guidance about debug log volume and memory impact, and reference the
MAINT_LOG_LENGTH setting name so readers know which config key controls this
behavior.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e2c5f9c1-8427-4d9b-b1a9-2d41495bc8d8

📥 Commits

Reviewing files that changed from the base of the PR and between 01d37fa and 606dd10.

⛔ Files ignored due to path filters (1)
  • docs/img/PERFORMANCE/logs_memory_usage.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • docs/PERFORMANCE.md
  • front/plugins/maintenance/config.json

Comment thread front/plugins/maintenance/config.json Outdated
{
"language_code": "en_us",
"string": "How many last <code>app.log</code> lines to keep. If <code>LOG_LEVEL</code> is set to <code>debug</code> the app generates about 10000 lines per hour, so when debugging an issue the recommended setting should cover the bug occurence timeframe. For example for a bug with a 3 day periodical appearence the value <code>1000000</code> should be sufficient. Setting this value to <code>1000000</code> generates approximatelly a 50MB <code>app.log</code> file. Set to <code>0</code> to disable log purging."
"string": "How many last <code>app.log</code> lines to keep. When <code>LOG_LEVEL</code> is set to <code>debug</code>, the application generates about 10,000 log lines per hour. Choose a value that covers the expected bug occurrence window. For example, <code>1000000</code> lines (~50 MB) is typically sufficient for issues that occur every 3 days. Set to <code>0</code> to disable log purging. Larger log files increase memory usage, so reduce this value after debugging is complete."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Widen description scope to match actual cleanup behavior.

Line 243 says this setting keeps app.log lines, but maintenance cleanup applies MAINT_LOG_LENGTH to multiple log files (app.log, nginx-error.log, stdout.log). Please reword this to avoid misleading retention expectations.

Suggested wording update
- "string": "How many last <code>app.log</code> lines to keep. When <code>LOG_LEVEL</code> is set to <code>debug</code>, the application generates about 10,000 log lines per hour. Choose a value that covers the expected bug occurrence window. For example, <code>1000000</code> lines (~50 MB) is typically sufficient for issues that occur every 3 days. Set to <code>0</code> to disable log purging. Larger log files increase memory usage, so reduce this value after debugging is complete."
+ "string": "How many last log lines to keep per maintained log file (for example <code>app.log</code>, <code>nginx-error.log</code>, and <code>stdout.log</code>). When <code>LOG_LEVEL</code> is set to <code>debug</code>, the application generates about 10,000 log lines per hour. Choose a value that covers the expected bug occurrence window. For example, <code>1000000</code> lines (~50 MB) is typically sufficient for issues that occur every 3 days. Set to <code>0</code> to disable log purging. Larger log files increase memory usage, so reduce this value after debugging is complete."
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
"string": "How many last <code>app.log</code> lines to keep. When <code>LOG_LEVEL</code> is set to <code>debug</code>, the application generates about 10,000 log lines per hour. Choose a value that covers the expected bug occurrence window. For example, <code>1000000</code> lines (~50 MB) is typically sufficient for issues that occur every 3 days. Set to <code>0</code> to disable log purging. Larger log files increase memory usage, so reduce this value after debugging is complete."
"string": "How many last log lines to keep per maintained log file (for example <code>app.log</code>, <code>nginx-error.log</code>, and <code>stdout.log</code>). When <code>LOG_LEVEL</code> is set to <code>debug</code>, the application generates about 10,000 log lines per hour. Choose a value that covers the expected bug occurrence window. For example, <code>1000000</code> lines (~50 MB) is typically sufficient for issues that occur every 3 days. Set to <code>0</code> to disable log purging. Larger log files increase memory usage, so reduce this value after debugging is complete."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@front/plugins/maintenance/config.json` at line 243, Update the description
for MAINT_LOG_LENGTH to reflect that it applies to multiple logs, not just
app.log: reword the string to state that MAINT_LOG_LENGTH limits the number of
retained lines for app.log, nginx-error.log and stdout.log (and that setting 0
disables purging), keep the existing guidance about debug log volume and memory
impact, and reference the MAINT_LOG_LENGTH setting name so readers know which
config key controls this behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant