Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/configuration/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,29 @@
* **Fetch Interactions From** - Select the time frame for fetching interaction data. This determines how far back to look for interactions.
* **Interaction Fetch Limit** - Set the maximum number of interactions of each type - for example: Page hits, Email reads, Form submits - to retrieve for timing optimization.

Advanced Campaign performance settings

Check warning on line 193 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Headings] 'Advanced Campaign performance settings' should use sentence-style capitalization. Raw Output: {"message": "[Google.Headings] 'Advanced Campaign performance settings' should use sentence-style capitalization.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 193, "column": 1}}}, "severity": "WARNING"}
======================================

Mautic provides additional performance-related configuration parameters for Campaigns that you must configure by editing the ``config/local.php`` file directly. These settings help you balance UI responsiveness against database load on high-volume instances.
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Added documentation for campaign_event_cache_ttl parameter introduced in PR #16110. The PR adds this configurable parameter to app/bundles/CampaignBundle/Config/config.php:360 with a default of 600 seconds, controlling cache TTL for Campaign event statistics displayed in CampaignController.php.

Source: mautic/mautic#16110


* **campaign_event_cache_ttl** - Controls how long Mautic caches Campaign event statistics - such as execution counts shown in the Campaign builder - before refreshing them from the database. The default is ``600`` seconds (10 minutes). Lower values provide fresher statistics in the UI but increase database queries. Higher values reduce database load but delay when new executions appear in the UI. Set to ``0`` to turn off caching entirely.

Check warning on line 198 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 198, "column": 224}}}, "severity": "INFO"}

Check failure on line 198 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'campaign_event_cache_ttl'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'campaign_event_cache_ttl'?", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 198, "column": 5}}}, "severity": "ERROR"}

To configure this setting, add or modify the parameter in your ``config/local.php`` file:

Check warning on line 200 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.OxfordComma] Use the Oxford comma in 'To configure this setting, add or'. Raw Output: {"message": "[Google.OxfordComma] Use the Oxford comma in 'To configure this setting, add or'.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 200, "column": 3}}}, "severity": "WARNING"}

.. code-block:: php

'campaign_event_cache_ttl' => 600, // seconds

.. note::

This setting only takes effect if Doctrine result caching is enabled in your Mautic instance.

Check warning on line 208 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Passive] In general, use active voice instead of passive voice ('is enabled'). Raw Output: {"message": "[Google.Passive] In general, use active voice instead of passive voice ('is enabled').", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 208, "column": 65}}}, "severity": "INFO"}

* **campaign_contact_count_cache_ttl** - Controls how long Mautic caches Campaign Contact counts before refreshing them from the database. The default is ``43200`` seconds (12 hours). Adjust this value if you need Campaign Contact counts to update more frequently.

Check warning on line 210 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Google.Parens] Use parentheses judiciously. Raw Output: {"message": "[Google.Parens] Use parentheses judiciously.", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 210, "column": 173}}}, "severity": "INFO"}

Check failure on line 210 in docs/configuration/settings.rst

View workflow job for this annotation

GitHub Actions / prose

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'campaign_contact_count_cache_ttl'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'campaign_contact_count_cache_ttl'?", "location": {"path": "docs/configuration/settings.rst", "range": {"start": {"line": 210, "column": 5}}}, "severity": "ERROR"}

.. code-block:: php

'campaign_contact_count_cache_ttl' => 43200, // seconds

Email settings
**************

Expand Down
Loading