several changes to emphasize setup and use of auto-archiving rather than real-time processing #16603

diosmosis · 2020-10-23T04:53:45Z

Fixes #6210

Changes:

Add blurb to installation finished twig about cron setup.
Make cron setup an actual diagnostic instead of an informational result.
Emphasize system check widget in settings home so items are more likely to be noticed and taken care of.
- Also make tooltip use first diagnostic result's comment if there is no long message and use jquery tooltip to make them more noticeable.
Allow view access users to create auto archive segments.
Show count of pre-processed vs real-time segments in system summary.

TODO:

automated tests for segment creation change (allowing view access) once the PR is reviewed

Screenshots:

System Check Dash

Installation

System Summary

…han real-time processing

tsteur · 2020-10-28T22:26:12Z

plugins/Installation/templates/finished.twig

@@ -27,6 +27,10 @@
        </p>
    {% endif %}

+    <h3>Performance Settings</h3>
+    <p>{{ 'Installation_PerformanceSettingsDesc1'|translate('<a href="https://matomo.org/docs/setup-auto-archiving/" rel="noreferrer noopener">', '</a>')|raw }}</p>


could we add a target _blank here for both links @diosmosis ? That be great as when I clicked on it I left the installer

plugins/SegmentEditor/SegmentEditor.php

plugins/SegmentEditor/templates/_segmentSelector.twig

tsteur · 2020-10-28T22:44:36Z

plugins/SegmentEditor/API.php

-                // we require view access only when only pre processed can be created
-                Piwik::checkUserHasViewAccess($idSite);
-            }
+            Piwik::checkUserHasViewAccess($idSite);


I think it should be possible to set autoArchive=1 only when browser archiving is disabled? Otherwise the segment would be never archived?

We'll also need to adjust the config text in enable_create_realtime_segments as it no longer restricts which kinds of users can create segments to be archived on-demand. Could later if needed add a new setting like require_admin_access_for_preprocessed_segments=0 but not needed for now.

I think it should be possible to set autoArchive=1 only when browser archiving is disabled?

I think you mean when cron archiving isn't set up, but I don't think there's a good way to check for that? If browser archiving is enabled and cli archiving is enabled, then it should be possible to use auto archive.

I'm not sure we should see having both browser archiving and cli archiving enabled as a use case? Of course few users might do it (eg because they forget to disable browser archiving) but it should be rather edge cause and most of the times there wouldn't be much of a benefit of having both running AFAIK. Unless there would be some?

tsteur · 2020-10-28T22:47:50Z

plugins/Installation/lang/en.json

@@ -131,7 +131,7 @@
        "SystemCheckWriteDirs": "Directories with write access",
        "SystemCheckWriteDirsHelp": "To fix this error on your GNU\/Linux system, try typing in the following command(s)",
        "SystemCheckZlibHelp": "You need to configure and rebuild PHP with \"zlib\" support enabled, --with-zlib.",
-        "SystemCheckCronArchiveProcess": "Archive Cron",
+        "SystemCheckCronArchiveProcess": "Setup Cron",


I'm still finding it useful if it could be a bit more clear what the outcome/result is of fixing this warning so users will pay more attention to it as "Setup cron" you would likely simply ignore. Like "Setup Cron (faster report loading)" or something. Not too important but I think it will get the attention of users a lot more

tsteur · 2020-10-28T22:53:23Z

plugins/CoreHome/lang/en.json

@@ -82,7 +82,7 @@
        "PivotBySubtable": "This report is not pivoted %1$s Pivot by %2$s",
        "SystemSummaryWidget": "System Summary",
        "SystemSummaryNWebsites": "%d websites",
-        "SystemSummaryNSegments": "%d segments",
+        "SystemSummaryNSegments": "%1$d segments (%2$s pre-processed, %3$s processed in real-time)",


54 segments (7 pre-processed, 47 processed in real-time)

could we maybe rename %2$s pre-processed to something like %2$s processed in background or so? Although I reckon that doesn't make it much more clear what it means either.

What about processed periodically? Or reports generated periodically vs reports generated in real-time?

I reckon we can actually just leave it as it is. I don't think any other wording makes it more clear. Same for processed via cron etc.

tsteur

@diosmosis I reckon the only remaining change needed is to set in segment editor "pre-processed" as default when browser archiving is disabled. For me so far it still always shows real time as default

I also created a follow up issue #16646 to eventually improve segment editor as the option is barely visible depending on the resolution and people currently wouldn't know what to select when.

tsteur · 2020-11-01T23:09:50Z

plugins/SegmentEditor/API.php

-                // we require view access only when only pre processed can be created
-                Piwik::checkUserHasViewAccess($idSite);
+            if (Rules::isBrowserTriggerEnabled()) {
+                throw new Exception("Pre-processed segments can only be created if browser triggered archiving is disabled.");


Could we add a link to https://matomo.org/docs/setup-auto-archiving/ if it's a super user? Like To disable browser archiving follow the instructions in https://matomo.org/docs/setup-auto-archiving/ . Just to give them an idea of what to do next.

diosmosis · 2020-11-02T23:01:18Z

@tsteur applied some changes

tsteur · 2020-11-03T00:03:34Z

plugins/SegmentEditor/templates/_segmentSelector.twig

@@ -56,10 +56,10 @@
                    </strong></div>
                {{ 'General_And'|translate }} <div class="auto_archive"><strong>
                        <select class="auto_archive_select">
-                            {% if createRealTimeSegmentsIsEnabled %}
+                            {% if createRealTimeSegmentsIsEnabled or isBrowserArchivingEnabled %}


@diosmosis not sure this change is actually needed?

@tsteur you said:

I reckon the only remaining change needed is to set in segment editor "pre-processed" as default when browser archiving is disabled.

tsteur · 2020-11-03T00:05:03Z

plugins/SegmentEditor/templates/_segmentSelector.twig

                            <option selected="1" value="0">{{ 'SegmentEditor_AutoArchiveRealTime'|translate }} {{ 'General_DefaultAppended'|translate }}</option>
                            {% endif %}
-                            <option {% if not createRealTimeSegmentsIsEnabled %}selected="1"{% endif %} value="1">{{ 'SegmentEditor_AutoArchivePreProcessed'|translate }} </option>
+                            <option {% if not createRealTimeSegmentsIsEnabled and not isBrowserArchivingEnabled %}selected="1"{% endif %} value="1">{{ 'SegmentEditor_AutoArchivePreProcessed'|translate }} </option>


btw probably not an issue but do we maybe need to remove selected="1" from the previous option when selecting this one by default? I suppose the browser in this case automatically selects the later one?

I'm thinking maybe it needs to use an or and not an and? Like we want to preselect this one either when browser archiving is disabled or when real time segment is not allowed?

They should be mutually exclusive conditions.

@diosmosis I just disabled browser archiving but real time was still the default. It could alternatively be simplified to if not isBrowserArchivingEnabled.

Otherwise it would be only the default if someone was to disable real time segments but only few people would do this.

@tsteur that may be because browser archiving of segments is still enabled. Can you check that?

That's possible. I think we'd want to still enable it though by default in that case see #6210 (comment)

and then in #6210 (comment)

It wasn't really meant in relation to the segment specific archive setting but just the general browser archiving setting.

Ok, I will ignore segment specific archiving.

@tsteur changed.

tsteur · 2020-11-03T01:24:54Z

plugins/SegmentEditor/templates/_segmentSelector.twig

@@ -56,10 +56,10 @@
                    </strong></div>
                {{ 'General_And'|translate }} <div class="auto_archive"><strong>
                        <select class="auto_archive_select">
-                            {% if createRealTimeSegmentsIsEnabled %}
+                            {% if isBrowserArchivingEnabled %}


This would need to be reverted to the original if createRealTimeSegmentsIsEnabled ? If browser archiving is disabled, then you might still want to create a segment for "real time" if you use the segment for example only for the "visits log" or if you view it very rarely. It should just not be selected by default.

tsteur

Left one more comment @diosmosis and then feel free to merge once the tests pass.

diosmosis · 2020-11-03T01:36:34Z

@tsteur updated again, will merge if tests pass and no further comments

tsteur · 2020-11-03T02:05:26Z

Great. Thanks @diosmosis

several changes to emphasize setup and use of auto-archiving rather t…

9ab0a63

…han real-time processing

diosmosis added not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. Needs Review PRs that need a code review labels Oct 23, 2020

diosmosis added this to the 4.0.0-RC milestone Oct 23, 2020

tsteur requested changes Oct 28, 2020

View reviewed changes

diosmosis added 5 commits October 28, 2020 16:38

Merge branch '4.x-dev' into 6210-cli-archiving-related-tweaks

a63d461

apply some pr feedback

c548c63

Merge branch '4.x-dev' into 6210-cli-archiving-related-tweaks

a224ff8

Applying more pr feedback.

f81d617

Merge branch '4.x-dev' into 6210-cli-archiving-related-tweaks

3aeb55f

tsteur requested changes Nov 1, 2020

View reviewed changes

apply review fixes

1ad6b0a

tsteur reviewed Nov 3, 2020

View reviewed changes

ignore ability to archive segments in real time

6647b8a

tsteur reviewed Nov 3, 2020

View reviewed changes

another tweak

62ba081

diosmosis added 9 commits November 2, 2020 19:29

update tests

806e86a

Merge branch '4.x-dev' into 6210-cli-archiving-related-tweaks

e09ec5a

Merge branch '4.x-dev' into 6210-cli-archiving-related-tweaks

5c2b8fe

fix another test

e11c17f

fix ui tests

a9243a0

update test

77fc44e

fix evolution icon bug

b5a4a12

Update TreemapVisualization and update expected screenshots

1783fc8

update screenshots

90f476c

diosmosis merged commit 375dd9f into 4.x-dev Nov 4, 2020

diosmosis deleted the 6210-cli-archiving-related-tweaks branch November 4, 2020 07:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

several changes to emphasize setup and use of auto-archiving rather than real-time processing #16603

several changes to emphasize setup and use of auto-archiving rather than real-time processing #16603

diosmosis commented Oct 23, 2020 •

edited

tsteur Oct 28, 2020

tsteur Oct 28, 2020

diosmosis Oct 29, 2020

tsteur Oct 29, 2020

tsteur Oct 28, 2020

tsteur Oct 28, 2020

diosmosis Oct 29, 2020

tsteur Oct 29, 2020 •

edited

tsteur left a comment

tsteur Nov 1, 2020

diosmosis commented Nov 2, 2020

tsteur Nov 3, 2020

diosmosis Nov 3, 2020

tsteur Nov 3, 2020

diosmosis Nov 3, 2020

tsteur Nov 3, 2020

diosmosis Nov 3, 2020

tsteur Nov 3, 2020

diosmosis Nov 3, 2020

diosmosis Nov 3, 2020

tsteur Nov 3, 2020

tsteur left a comment

diosmosis commented Nov 3, 2020

tsteur commented Nov 3, 2020

several changes to emphasize setup and use of auto-archiving rather than real-time processing #16603

several changes to emphasize setup and use of auto-archiving rather than real-time processing #16603

Conversation

diosmosis commented Oct 23, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tsteur Oct 29, 2020 • edited

Choose a reason for hiding this comment

tsteur left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diosmosis commented Nov 2, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tsteur left a comment

Choose a reason for hiding this comment

diosmosis commented Nov 3, 2020

tsteur commented Nov 3, 2020

diosmosis commented Oct 23, 2020 •

edited

tsteur Oct 29, 2020 •

edited