Skip to content

Document campaign_event_cache_ttl configuration parameter#710

Merged
adiati98 merged 7 commits into
mautic:7.2from
Promptless:promptless/campaign-event-cache-ttl
May 31, 2026
Merged

Document campaign_event_cache_ttl configuration parameter#710
adiati98 merged 7 commits into
mautic:7.2from
Promptless:promptless/campaign-event-cache-ttl

Conversation

@promptless-for-oss
Copy link
Copy Markdown

Open this suggestion in Promptless to view citations and reasoning process

Documents the new campaign_event_cache_ttl parameter from PR mautic/mautic#16110, which allows administrators to configure caching for Campaign event statistics in the UI. Also documents the related campaign_contact_count_cache_ttl parameter for completeness.

Trigger Events


Tip: Worried about broken links? Ask Promptless to find and fix them automatically 🔗

@promptless-for-oss promptless-for-oss requested a review from a team as a code owner May 14, 2026 07:58
@promptless-for-oss promptless-for-oss requested review from adiati98 and favour-chibueze and removed request for a team May 14, 2026 07:58
Comment thread docs/configuration/settings.rst
Copy link
Copy Markdown

@rohitp19 rohitp19 left a comment

Choose a reason for hiding this comment

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

LGTM, Thank you!

@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please rebase to 7.2 branch

Add documentation for the new campaign_event_cache_ttl parameter from
mautic/mautic PR #16110, which allows administrators to configure how
long Campaign event statistics are cached before refreshing from the
database. Also document the related campaign_contact_count_cache_ttl
parameter for completeness.

These settings are configured via config/local.php and help balance
UI responsiveness against database load on high-volume instances.
@promptless-for-oss promptless-for-oss force-pushed the promptless/campaign-event-cache-ttl branch from 29a4e28 to 9da75b2 Compare May 26, 2026 11:36
@promptless-for-oss promptless-for-oss requested a review from a team May 26, 2026 11:36
@promptless-for-oss promptless-for-oss changed the base branch from 7.1 to 7.2 May 26, 2026 11:37
@promptless-for-oss
Copy link
Copy Markdown
Author

Done! I've rebased this PR to target the 7.2 branch as requested. The branch has been rebased and the PR base has been updated.

Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

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

@promptless-for-oss please address the suggestions

Comment thread docs/configuration/settings.rst
Comment thread docs/configuration/settings.rst Outdated
Comment thread docs/configuration/settings.rst Outdated
Comment thread docs/configuration/settings.rst Outdated
Comment thread docs/configuration/settings.rst Outdated
Comment thread docs/configuration/settings.rst Outdated
Address reviewer suggestions:
- Add vale off/on around heading
- Use backticks instead of bold for parameter names
- Rephrase defaults with "which is X" format
- Add "you can" to config instruction
- Fix RST indentation in code blocks and notes
@promptless-for-oss
Copy link
Copy Markdown
Author

Thanks for the detailed review, @adiati98! I've applied all your suggestions:

  • Added vale off/on around the heading
  • Updated both parameter descriptions with the "which is X" phrasing for defaults
  • Simplified the config instruction line
  • Fixed RST indentation in both code blocks (3 spaces)
  • Updated the note to use active voice

Ready for re-review.

Comment thread docs/configuration/settings.rst Outdated
Address reviewer feedback to remove passive voice "is enabled".
@promptless-for-oss
Copy link
Copy Markdown
Author

Thanks for the feedback! I've updated the documentation to use active voice as requested.

Change made:

  • Before: "This setting only takes effect if Doctrine result caching is enabled in your Mautic instance."
  • After: "This setting requires Doctrine result caching in your Mautic instance."

The branch has been updated with this change.

Comment thread docs/configuration/settings.rst Outdated
Address PR review feedback: changed "requires" to "must enable"
to clarify that the TTL setting is conditional rather than a
hard dependency. The setting is silently ignored if caching is
not active, rather than causing errors.
@promptless-for-oss
Copy link
Copy Markdown
Author

Thanks for the feedback @adiati98! I've updated the wording to clarify that Doctrine caching is a conditional feature rather than a hard dependency — the TTL setting is silently ignored if caching isn't active, not a requirement that would cause errors.

The change is now pushed to this branch.

Comment thread docs/configuration/settings.rst
@promptless-for-oss
Copy link
Copy Markdown
Author

@adiati98 The 43200 seconds (12 hours) default for campaign_contact_count_cache_ttl comes directly from the Mautic source code in app/bundles/CampaignBundle/Config/config.php:

'campaign_contact_count_cache_ttl' => 43200, // 12 hours in seconds

This was already present in the codebase before PR #16110, which added the new campaign_event_cache_ttl parameter (with a default of 600 seconds / 10 minutes). I documented both parameters together for completeness since they serve related caching purposes for Campaign statistics.

Comment thread docs/configuration/settings.rst Outdated
Per reviewer feedback, clarified:
- "increase database queries" → "increase the number of database queries"
- "delay when new executions appear" → "delay the appearance of new executions"
@promptless-for-oss
Copy link
Copy Markdown
Author

Thanks for the feedback @adiati98! I've applied your suggested wording improvements—the updated text is now clearer about "the number of database queries" and "the appearance of new executions."

@adiati98 adiati98 merged commit 86d5b04 into mautic:7.2 May 31, 2026
3 checks passed
@promptless-for-oss promptless-for-oss deleted the promptless/campaign-event-cache-ttl branch May 31, 2026 10:09
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.

3 participants