Config activity log as a post-installation step #2663
Conversation
|
Preview of modified Markdown: |
| ### Configure recent activity log | ||
|
|
||
| Actions in a repository are logged in its database, | ||
| you may want to [limit this log length by enabling its automatic truncation](recent_activity.md#configuration-and-cronjob). |
There was a problem hiding this comment.
"you may want" gives readers an option, but you do not explain why they might want to limit the length of the log. Is there defult value that is too big? Does it cause memory issues?
There was a problem hiding this comment.
Maybe we need to change the wording a bit. By default we are not truncating the log at all. The biggest problem is when the log is long overdue (milliions of records set to be deleted) on truncate the command will eat up resources rendering the site unavailable for a while. Imo if the command is implemented as it is right now, we should strongly recommend to have this cronjob set up by default.
There was a problem hiding this comment.
Since the advice is... performance related, I would move it to the following article: Performance
where we have more such pieces of advice.
And there, I would provide a longer explanation:
"Actions in a repository are logged in its database.
When there's a large number of records and they need to be processed, it may impact the productivity of your application.
To avoid this, you may want to limit the log's length by enabling its automatic truncation after a total number of entries reaches a certain threshold."
I would also include a direct link to the "Performance" article in the installation procedure, I feel like it is missing there.
At the end of installation process, suggest to configure activity log to limit its length.
I add "Configure recent activity log" section before the two other cron related sections because it can be critical to fill up DB with activity log while the other two are just feature enablements.
Preview
Checklist