tracking/Documentation/Changelog/2.0.0.rst

2.0.0
=====

Breaking
--------

* No longer has ``operating_system`` database column.

* No longer ships default rule to not track requests from bots.
  Does track them as bots now.

  How to update:

  Remove custom adjustments from :file:`Services.yaml` regarding bot detection.
  Instead extend built in bot extraction and adjust custom widgets to exclude those
  bots.

  Execute the provided command (scheduler task) to update existing data.
  Bots and operating system will be extracted from stored user agent.

  See: :ref:`tags`.

* Existing widgets will no longer work with custom configuration.
  Configuration needs to be adjusted.

  .. todo:: document how to migrate

* Widgets will not work with old data.
  How to migrate data:

  Execute the provided scheduler task.
  It will incrementally update pageviews and recordviews.
  3500 records of each will be updated per each run.
  Roughly executing every 10 minutes seems to be a good idea.

Features
--------

* Added support for tags

  Tags can now be added to :ref:`pageview` and :ref:`recordview`.
  The extension ships with some out of the box, but further can be added, see
  :ref:`tags`.

  Resolves: :issue:`46`.

  Sponsored by: https://www.werkraum-media.de/

* Uses ``matomo/device-detector`` library to detect bots.
  Some known bots are added on top.

Fixes
-----

Nothing

Tasks
-----

Nothing

Deprecation
-----------

Nothing
WIP\|Add flags feature Allow each tracking record to contain arbitrary tags. Those tags are generated via an API and can be extended by foreign extensions or for individual projects. Existing operating_system was moved to this new feature. The update command allows to migrate existing records to this new feature. Those flags can be used when configuring widgets. A new flag was added bot:yes and bot:no. Bots are now tracked but flagged. That new feature allows to build fine grained reports and makes the extension way more flexible. Possible new implications: - Show visits from none bots - Show visits from bots - Show visits from specific bot - Add color to page views per page (bar chart) to color bot or none bot WIP: - Update Yaml file to work like before, no bots in widgets - Add documentation (widgets) - Add documentation (migration *.yaml) 2021-08-16 09:56:19 +02:00			`2.0.0`
			`=====`

			`Breaking`
			`--------`

			* No longer has ``operating_system`` database column.

			`* No longer ships default rule to not track requests from bots.`
			`Does track them as bots now.`

			`How to update:`

			Remove custom adjustments from :file:`Services.yaml` regarding bot detection.
			`Instead extend built in bot extraction and adjust custom widgets to exclude those`
			`bots.`

			`Execute the provided command (scheduler task) to update existing data.`
			`Bots and operating system will be extracted from stored user agent.`

			See: :ref:`tags`.

			`* Existing widgets will no longer work with custom configuration.`
			`Configuration needs to be adjusted.`

			`.. todo:: document how to migrate`

			`* Widgets will not work with old data.`
			`How to migrate data:`

			`Execute the provided scheduler task.`
			`It will incrementally update pageviews and recordviews.`
			`3500 records of each will be updated per each run.`
			`Roughly executing every 10 minutes seems to be a good idea.`

			`Features`
			`--------`

			`* Added support for tags`

			Tags can now be added to :ref:`pageview` and :ref:`recordview`.
			`The extension ships with some out of the box, but further can be added, see`
			:ref:`tags`.

			Resolves: :issue:`46`.

			`Sponsored by: https://www.werkraum-media.de/`

			* Uses ``matomo/device-detector`` library to detect bots.
			`Some known bots are added on top.`

			`Fixes`
			`-----`

			`Nothing`

			`Tasks`
			`-----`

			`Nothing`

			`Deprecation`
			`-----------`

			`Nothing`