Skip to content

Redesign how Plugins developer define custom data Archiver  #7470

@mattab

Description

@mattab

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    TaskIndicates an issue is neither a feature nor a bug and it's purely a "technical" change.c: PlatformFor Matomo platform changes that aren't impacting any of our APIs but improve the core itself.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions