Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

System check reports incorrect results when enable_general_settings_admin = 0 #19099

Open
DBX12 opened this issue Apr 14, 2022 · 3 comments
Open

System check reports incorrect results when enable_general_settings_admin = 0 #19099

DBX12 opened this issue Apr 14, 2022 · 3 comments
Labels
Bug For errors / faults / flaws / inconsistencies etc. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. c: Usability For issues that let users achieve a defined goal more effectively or efficiently.
Milestone
Backlog (Help wan...

Comments

@DBX12
Copy link

DBX12 commented Apr 14, 2022

Expected Behavior

System Check reports correct results no matter if enable_general_settings_admin is set to 1 or 0

Current Behavior

System Check reports Cron as not set up and suggests to disable Browser Archiving

#### Set up Cron (faster report-loading):
 ⚠ Warning: For optimal performance and a speedy Matomo, it is highly recommended to set up a crontab to automatically archive your reports, and to disable browser triggering in the Matomo settings. Learn more.

#### Browser and Auto-archiving enabled:
 ⚠ Warning: It looks like both browser and auto archiving are enabled. Auto archiving last started 40 min 26s ago. If auto archiving is enabled, you should disable browser archiving in "General Settings".

Steps to Reproduce (for Bugs)

  1. Configure auto archiving and disable Browser archiving in the UI
  2. Run system check and see that no issues regarding these two options are reported
  3. Set [General] enable_general_settings_admin=0 in config/config.ini.php
  4. Run system check again and see the two entries described in Current Behavior

Your Environment

  • Matomo Version: 4.9.0
  • PHP Version: 8.0.13
  • Server Operating System: Linux
  • Additionally installed plugins: (from Plugins Activated, I doubt they are relevant)
API, Actions, Annotations, BulkTracking, Contents, CoreAdminHome, CoreConsole, CoreHome, CorePluginsAdmin, CoreUpdater, CoreVisualizations, CoreVue, CustomDimensions, CustomJsTracker, CustomReports 4.0.12, Dashboard, DevicePlugins, DevicesDetection, Diagnostics, Ecommerce, Events, Feedback, GeoIp2, Goals, Heartbeat, ImageGraph, Insights, Installation, Intl, IntranetMeasurable, LanguagesManager, Live, Login, Marketplace, MobileMessaging, Monolog, Morpheus, MultiSites, Overlay, PagePerformance, PasswordVerifier 0.2.2, PrivacyManager, ProfessionalServices, Proxy, Referrers, Resolution, RssWidget, SEO, ScheduledReports, SegmentEditor, SitesManager, TagManager, Tour, Transitions, TwoFactorAuth, UserCountry, UserCountryMap, UserId, UserLanguage, UsersManager, VisitFrequency, VisitTime, VisitorInterest, VisitsSummary, WebsiteMeasurable, Widgetize
@DBX12 DBX12 added the Potential Bug Something that might be a bug, but needs validation and confirmation it can be reproduced. label Apr 14, 2022
@bx80
Copy link
Contributor

bx80 commented Apr 19, 2022

Hi @DBX12,

Setting [General] enable_general_settings_admin=0 in config/config.ini.php will completely prevent use of the browser archiving setting that was configured in the UI.

By default browser archiving is enabled, so to disable browser archiving when also using enable_general_settings_admin=0 you should also set enable_browser_archiving_triggering = 0 in the [General] section.

@DBX12
Copy link
Author

DBX12 commented Apr 20, 2022

Hi bx80,
I understand that the setting enable_general_settings_admin=0 will disable all settings in regard to browser archiving in the web UI. But if I have a cronjob set up, why would the system check report it as missing when I set enable_general_settings_admin=0?
It seems like it is linked to enable_browser_archiving_triggering. Basically "if enable_browser_archiving_triggering == 0 assume there is a cronjob set up and don't mention it on the system check" and "if `enable_browser_archiving_triggering == 1 AND enable_general_settings_admin == 0 then complain about missing cronjob".

It seems a bit misleading to me, I could set enable_browser_archiving_triggering = 0 and not configure a cronjob and the system check would say all good, right?

@bx80
Copy link
Contributor

bx80 commented Apr 21, 2022

Hi @DBX12,

But if I have a cronjob set up, why would the system check report it as missing when I set enable_general_settings_admin=0?

I agree, this is misleading.

It's happening because enable_general_settings_admin=0 will completely disable the browser archiving option you set in the UI, it doesn't just disable the UI but also no longer checks the (separate) UI setting at all, so enable_browser_archiving_triggering reverts back to it's default config file value of 1.

The diagnostic check is fairly simplistic and now sees that you have both a cronjob setup and browser archiving enabled, this results in both the "setup cron" and "Browser and Auto-archiving enabled" warning being shown. The "Set up cronjob" warning shouldn't be really shown in this case as the wording implies that a cronjob isn't setup. The "Browser and Auto-archiving enabled" warning is also misleading as it suggested changing the disabled UI setting.

I could set enable_browser_archiving_triggering = 0 and not configure a cronjob and the system check would say all good, right?

From what I can see, there would be no explicit warnings shown, though the 'Set up cronjob' check would show that no cronjob was configured.

I'll tag this as an Usability improvement.

Suggested changes:

  • Don't show the system check "setup cronjob" warning if a cronjob is already setup and browser archiving is enabled.
  • If enable_general_settings_admin = 0 is set then the "Browser and Auto-archiving enabled" system check warning should explain the use of enable_browser_archiving_triggering = 0 rather than suggesting the disabled 'General Settings' option.

@bx80 bx80 added c: Usability For issues that let users achieve a defined goal more effectively or efficiently. and removed Potential Bug Something that might be a bug, but needs validation and confirmation it can be reproduced. labels Apr 21, 2022
@mattab mattab added c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Bug For errors / faults / flaws / inconsistencies etc. labels Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug For errors / faults / flaws / inconsistencies etc. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. c: Usability For issues that let users achieve a defined goal more effectively or efficiently.
Projects
None yet
Milestone
Backlog (Help wanted)
Development

No branches or pull requests
4 participants
@mattab @justinvelluppillai @DBX12 @bx80