danielsiepmann/tracking
danielsiepmann/tracking
1
0
mirror of https://github.com/DanielSiepmann/tracking.git synced 2024-11-16 11:16:09 +01:00
Code Issues Releases Wiki Activity
tracking/Documentation/Pageview.rst
Daniel Siepmann 5f0490f493
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)
2022-09-21 17:33:27 +02:00

2.7 KiB
Raw Blame History

Pageview

Each view of a TYPO3 page is tracked by default. Requests can be ignored by configuring a rule that has to match the current request.

All configuration happens via t3coreapi:DependencyInjection inside of Services.yaml of your Sitepackage.

Screenshot of list view of created "pageview" records.
Screenshot of edit form view of created "pageview" records.

Saved record

Whenever a pageview is tracked, a new record is created. The record can be viewed via TYPO3 list module. That way all collected information can be checked.

Configure tracking

Let us examine an concrete example:

services:
  _defaults:
    autowire: true
    autoconfigure: true
    public: false

  DanielSiepmann\Tracking\Middleware\Pageview:
    public: true
    arguments:
      $rule: >
          not (context.getAspect("backend.user").isLoggedIn())
          and not (context.getAspect("frontend.preview").isPreview())

The first paragraph will not be explained, check out t3coreapi:configure-dependency-injection-in-extensions instead.

The second paragraph is where the tracking is configured. The PHP class DanielSiepmann\Tracking\Middleware\Pageview is registered as PHP middleware and will actually track the request. Therefore this class is configured. The only interesting argument to configure is $rule, which is a Symfony Expression. The same is used by TYPO3 for TypoScript conditions and is not explained here.

This rule is evaluated to either true or false, where true means that the current request should be tracked.

The current request is available as Psr\Http\Message\ServerRequestInterface via request, while TYPO3\CMS\Core\Context\Context is available via context. That way it is possible to check all kind of information like frontend user, backend user or cookies and parameters, as well as request header.

Check PSR-7: HTTP message interfaces as well as t3coreapi:context-api.

The above example blocks tracking for requests with logged in backend user.

Widgets

The extension does not provide any widgets, but providers for widgets of EXT:dashboard. That way widgets of EXT:dashboard can be combined with all providers of this extension.

The concepts are not documented here, check t3dashboard:start instead.

PageviewWidgets/*