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.

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

Redesign how Plugins developer define custom data Archiver #7470

Open
mattab opened this issue Mar 18, 2015 · 2 comments
Open

Redesign how Plugins developer define custom data Archiver #7470

mattab opened this issue Mar 18, 2015 · 2 comments
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.

Comments

@mattab
Copy link
Member

mattab commented Mar 18, 2015

The goal of this issue is to provide a better way for Plugins to define Custom Archiver logic, to make the platform easier to use for ourselves and all third party developers creating custom plugins.

Why is it important?

This refactoring is very important and needed to improve the platform. In this issue we will focus especially on creating a simple meaningful public APIs for plugin's Archiver.php file, and let devs define rules on how data is aggregated, archived, etc.

Other features depend on it: custom dimensions, custom reports depend on custom dimensions, manage apps/server with new custom reports #5257, etc.

(fyi: here is an example of why refactoring the Archiver is much needed was our recent PR #7468 where had to add a new parameter to the already too long public method. )

Developer guides

Currently the archiver is a bit documented in the Piwik in depth guides: http://developer.piwik.org/guides/archiving and http://developer.piwik.org/guides/archive-data

Ideally, we'd make the guides as simple as possible (as the API become simpler) and we document all that plugin developers need to know in the Develop section.

Timeline

It would be nice to get this done prior to Piwik 3.0.0 as we could then deprecate the older Archiver logic and make it nice.

@mattab mattab added Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change. c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. labels Mar 18, 2015
@mattab mattab added this to the Short term milestone Mar 18, 2015
@mattab mattab modified the milestones: Short term, Piwik 3.0.0 Apr 7, 2015
@tsteur
Copy link
Member

tsteur commented May 5, 2015

Having an easy archiver (ideally plugins do not have to define an Archiver at all!) will be important for #7131 and #4734. This will allow us to easily define new reports for different types.

@mattab mattab removed the Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. label Oct 1, 2015
@mattab mattab added the Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. label Feb 8, 2016
@mattab
Copy link
Member Author

mattab commented May 6, 2016

When solving this issue, it may also help us provide a better developer experience when working with sub-tables, refs: #6167

@mattab mattab removed the Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. label Dec 15, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Platform For Matomo platform changes that aren't impacting any of our APIs but improve the core itself. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Projects
None yet
Development

No branches or pull requests

2 participants