matomo-org/matomo

Diagnostic to check tracking code is installed on target website

Open

#12,801 opened on Apr 30, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)PHP (21,513 stars) (2,847 forks)batch import
Help wantedc: Onboarding

Description

We can add a new server side diagnostic to help users verify and diagnose tracking code issues. The diagnostic would fetch the target site's HTML, find the tracking code and check whether it's ok.

Specific checks could include:

  • That it's there and available.
  • That it uses https:// if force_ssl = 1 (or doesn't use :// if the target site is using https but for some reason matomo isn't).
    • For this one, might be useful to also show notification to admins if found. Not sure how easy it would be to achieve.
  • ???

It could also incorporate the "are there visits?" check that is done when displaying the dashboard. If the tracking code is there, but there are still no visits, we can say so giving the user more information they can use to diagnose & resolve their issue.

Contributor guide

Tech stack
php
Domain
analyticsbackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Matomo APIsFamiliarity with HTML parsing in PHP
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Explore existing diagnostics in the Matomo codebase to understand the pattern (e.g., in plugins/Diagnostics). The diagnostic should fetch a target site's HTML using PHP's file get contents or a similar method, then parse it to find the tracking code. Check for conditions like using https:// if force ssl is enabled. Also consider integrating with the existing 'no visits' check from the dashboard.
Diagnostic to check tracking code is installed on target website · matomo-org/matomo#12801 | Good First Issue