Skip to content

Doc for disabling activity log#3182

Merged
mnocon merged 8 commits into5.0from
activity-log-disable
May 8, 2026
Merged

Doc for disabling activity log#3182
mnocon merged 8 commits into5.0from
activity-log-disable

Conversation

@mnocon
Copy link
Copy Markdown
Contributor

@mnocon mnocon commented May 5, 2026

As discussed on Slack.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026

Preview of modified files

Preview of modified Markdown:

Comment thread docs/administration/recent_activity/recent_activity.md Outdated
Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
@mnocon mnocon requested review from a team, Steveb-p and mateuszbieniek May 6, 2026 09:04
@ibexa-workflow-automation-1 ibexa-workflow-automation-1 Bot requested review from ViniTou, alongosz, barw4, bnowak, ciastektk, konradoboza, mikadamczyk, tbialcz and wiewiurdp and removed request for a team May 6, 2026 09:04
Comment thread docs/administration/recent_activity/recent_activity.md Outdated
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

code_samples/ change report

Before (on target branch)After (in current PR)

code_samples/recent_activity/src/recent_activity_disable.php


code_samples/recent_activity/src/recent_activity_disable.php

docs/administration/recent_activity/recent_activity.md@148:``` php
docs/administration/recent_activity/recent_activity.md@149:[[= include_code('code_samples/recent_activity/src/recent_activity_disable.php') =]]
docs/administration/recent_activity/recent_activity.md@150:```

001⫶<?php declare(strict_types=1);
002⫶
003⫶/** @var \Ibexa\Contracts\ActivityLog\ActivityLogServiceInterface $activityLogService */
004⫶$activityLogService->disable();
005⫶
006⫶// Perform operations that should not be logged to the activity log
007⫶// ...
008⫶
009⫶$activityLogService->enable();

Download colorized diff

Copy link
Copy Markdown
Contributor

@adriendupuis adriendupuis left a comment

Choose a reason for hiding this comment

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

I would group info about an enabled log, and move disabling info below.

Comment thread docs/administration/recent_activity/recent_activity.md Outdated
Comment thread docs/administration/recent_activity/recent_activity.md Outdated
Comment thread docs/administration/recent_activity/recent_activity.md
@adriendupuis adriendupuis self-requested a review May 7, 2026 13:44
@mnocon
Copy link
Copy Markdown
Contributor Author

mnocon commented May 7, 2026

Thanks @adriendupuis ! Moved the "disable" feature to the bottom of each section - I've decided to split each config section into a separate subsection.

`0 * * * * cd [path-to-ibexa]; php bin/console ibexa:activity-log:truncate --quiet --env=prod`
The `ibexa.repositories.<repository>.activity_log.enabled` setting can disable activity log entirely for a given [repository](repository_configuration.md).

To disable the activity log for a repository:
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.

For example, to disable the activity log from the default repository:

Comment thread docs/administration/recent_activity/recent_activity.md Outdated
@mnocon mnocon merged commit 737a1c8 into 5.0 May 8, 2026
6 checks passed
@mnocon mnocon deleted the activity-log-disable branch May 8, 2026 07:10
mnocon added a commit that referenced this pull request May 8, 2026
* Doc for disabling activity log

* Apply suggestions from code review

Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>

* Apply suggestion from @mnocon

* Review feedback

* Fixed example

* Added mention

* Apply suggestion from @mnocon

---------

Co-authored-by: Tomasz Dąbrowski <64841871+dabrt@users.noreply.github.com>
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 8, 2026

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants