Intégration domotique Plausible Analytics, gratuite et open source

Visiteurs en ce moment et visites du jour de vos sites Plausible dans Gladys, avec scène sur un pic.

• Publiée par guim31
• Appareils
• Version 1.0.0
• Nécessite Gladys >=5.1.0
• ★ 0

Voir sur GitHubToutes les intégrations

Plausible Analytics est un outil de statistiques web simple et respectueux de la vie privée, libre (AGPL), sur plausible.io ou auto-hébergé (Community Edition). Cette intégration amène les chiffres de vos sites Plausible dans Gladys : chaque site devient un appareil avec ses visiteurs en ce moment et ses visiteurs, visites, pages vues, taux de rebond, durée de visite et page la plus vue du jour. Des scènes peuvent réagir à un pic de visiteurs, au premier visiteur de la journée ou à un site qui ne reçoit plus de visite (script de suivi cassé), un widget de tableau de bord montre la journée d'un coup d'œil, et une action de scène met les chiffres d'un site dans un message.

Testée contre un vrai Plausible Community Edition 3.2.1 auto-hébergé (Docker, PostgreSQL et ClickHouse) ; pas encore sur plausible.io : vos retours sont les bienvenus sur les issues.

Ce qu'il vous faut

• Gladys Assistant 5.1.0 ou plus récent.
• Un Plausible : sur plausible.io, ou votre propre serveur (Community Edition 2.1 ou plus, la première avec l'API Stats v2), joignable depuis la machine de Gladys.
• Une clé « Stats API » de votre compte Plausible.
• Les domaines des sites à suivre, tels qu'écrits dans Plausible (par exemple blog.example.org) : une clé Stats API ne sait pas lister ses sites.

À chaque lecture, l'intégration envoie une requête par site (les visiteurs en ce moment). Toutes les 15 minutes, elle lit aussi les chiffres du jour et la page la plus vue (deux requêtes par site) et, quand personne n'est sur un site, les visites des dernières heures. plausible.io accepte 600 requêtes par heure et par clé : là, l'intégration allonge d'elle-même l'intervalle pour rester sous 540 (avec 20 sites, une lecture toutes les 4 minutes). La Community Edition n'a pas cette limite.

Mise en route

1. Créer une clé Stats API

Dans Plausible, ouvrez Settings → API keys (les réglages de votre compte), cliquez sur New API key, choisissez le type Stats API et copiez la clé (elle n'est affichée qu'une fois).

2. Configurer l'intégration

Dans Gladys, ouvrez Intégrations → Plausible Analytics → Configuration :

• Adresse de Plausible : vide pour plausible.io, ou l'adresse de votre serveur (par exemple http://192.168.1.10:8000). Une adresse copiée depuis le navigateur est comprise.
• Clé d'API : la clé Stats API.
• Domaines des sites : séparés par des virgules, 25 au plus.
• Visiteurs en ce moment : intervalle : 1, 2 ou 5 minutes (1 minute par défaut).
• Pic de visiteurs à partir de : les visiteurs simultanés qui déclenchent « Pic de visiteurs » (10 par défaut).
• Aucune visite depuis (heures) : les heures sans aucune visite qui déclenchent « Aucune visite depuis un moment » (24 par défaut).
• Langue des noms : langue des noms des fonctionnalités et des résultats de scène (français par défaut).

Enregistrez, puis cliquez sur Tester la connexion : le résultat donne le nombre de sites, les visiteurs du jour et ceux du moment, et les domaines que Plausible refuse à la clé, s'il y en a.

3. Ajouter les sites

Ouvrez l'onglet Découverte : chaque site est proposé sous son domaine. Ajoutez ceux que vous voulez voir dans Gladys. Les déclencheurs de scène et le widget fonctionnent pour tous les sites, ajoutés ou non.

Les appareils

Chaque site devient un appareil avec :

• Visiteurs en ce moment : les visiteurs des 5 dernières minutes, comme les « current visitors » de Plausible.
• Visiteurs aujourd'hui : visiteurs uniques depuis minuit.
• Visites aujourd'hui : visites (sessions) depuis minuit.
• Pages vues aujourd'hui : pages vues depuis minuit.
• Taux de rebond aujourd'hui : la part des visites qui n'ont vu qu'une page, en pourcentage.
• Durée de visite aujourd'hui : la durée moyenne d'une visite, en secondes.
• Page la plus vue aujourd'hui : son chemin, par exemple /posts/hello ; « - » avant la première page vue de la journée.

« Aujourd'hui » est le jour du site dans Plausible, dans le fuseau horaire de ses réglages : les chiffres du jour repartent de 0 à son minuit. Les visiteurs en ce moment suivent l'intervalle de la configuration, les chiffres du jour sont lus toutes les 15 minutes, et tout de suite à l'arrivée d'un premier visiteur. Une valeur qui ne change pas est renvoyée toutes les 12 heures, pour que Gladys la garde récente.

Tableau de bord

Le widget Plausible aujourd'hui montre quatre tuiles (visiteurs en ce moment, visiteurs, visites et pages vues du jour), additionnées sur les sites affichés, puis une ligne par site avec ses visiteurs du jour et du moment, le plus fréquenté en premier. Avec un seul site, la page la plus vue du jour s'affiche à la place. Dans les réglages du widget, choisissez des sites pour n'afficher qu'eux (appareils ajoutés à Gladys). Le bouton Actualiser relit Plausible.

Scènes

Déclencheurs

• Pic de visiteurs : les visiteurs en ce moment d'un site atteignent le seuil de la configuration. Une fois par pic, et 30 minutes au moins entre deux annonces pour un site : un pic qui dure encore à la fin de la pause est annoncé à ce moment-là. Variables : domaine, visiteurs en ce moment, seuil.
• Premier visiteur de la journée : un site reçoit son premier visiteur depuis son minuit. Variables : domaine, visiteurs aujourd'hui. Un premier visiteur arrivé sans être vu (intégration arrêtée, Plausible injoignable ou domaine refusé pendant plus d'environ 15 minutes) n'est pas annoncé.
• Aucune visite depuis un moment : un site qui avait des visites n'en reçoit plus pendant les heures de la configuration : le script de suivi est peut-être cassé, ou le site en panne. Une fois, jusqu'au retour d'une visite. Variables : domaine, heures sans visite.

Chaque déclencheur peut se limiter à certains sites (vide : tous). Ce que les déclencheurs retiennent est gardé dans le volume /data : un redémarrage de Gladys ou de l'intégration n'annonce pas deux fois un pic ou un premier visiteur. Rien n'est annoncé à la première lecture d'un site : un pic ou un silence déjà en cours est seulement noté.

Actions

• Lire les chiffres d'un site : donne le domaine (name), les visiteurs en ce moment (active), les visitors, visits, pageviews, bounce_rate et visit_duration du jour, la top_page, et une sentence toute prête, par exemple « blog.example.org : 132 visiteur(s) et 410 page(s) vue(s) aujourd'hui, 4 en ce moment, page la plus vue /posts/hello. ».

Idées de scènes

• Quand Pic de visiteurs se déclenche pour votre boutique, envoyer un message Telegram « Affluence sur {{domain}} : {{visitors}} visiteurs en ce moment ».
• Quand Aucune visite depuis un moment se déclenche, envoyer une notification « Aucune visite sur {{domain}} depuis {{hours}} h : vérifier le script de suivi ».
• Chaque soir à 21 h, Lire les chiffres d'un site et envoyer la sentence par message.
• Avec la fonctionnalité Visiteurs en ce moment en condition de scène, allumer une lampe en vert tant que quelqu'un est sur le site.

Dépannage

• « Collez une clé « Stats API » » : la clé est vide.
• « Indiquez les domaines de vos sites » : aucun domaine n'a pu être lu ; écrivez-les comme dans Plausible, séparés par des virgules.
• « clé d'API refusée, ou aucun domaine connu de Plausible » : Plausible répond de la même façon à une mauvaise clé et à un site que la clé ne voit pas. Recopiez la clé (type Stats API) et vérifiez les domaines. Si seuls certains domaines sont refusés, les autres sont lus, et Tester la connexion nomme les domaines refusés.
• « aucune API Stats de Plausible à cette adresse » : vérifiez l'adresse et le port (8000 par défaut), et la version (Community Edition 2.1 ou plus).
• « l'adresse redirige » : saisissez directement l'adresse en https://.
• « trop de requêtes » : choisissez un intervalle plus long, ou suivez moins de sites.
• Les logs de l'intégration (Intégrations → Plausible Analytics) en disent plus ; rien n'y est écrit pendant un cycle de lecture normal.

Limites

• Lecture seule : l'intégration ne change rien dans Plausible.
• Les domaines se saisissent à la main : une clé Stats API ne sait pas lister les sites (la Sites API n'existe pas dans la Community Edition, et elle est réservée à l'offre Enterprise sur plausible.io). Un site renommé dans Plausible doit l'être aussi dans la configuration, et devient un nouvel appareil.
• « Visiteurs en ce moment » est la fenêtre de 5 minutes de Plausible ; les chiffres du jour ont au plus 15 minutes, sauf au premier visiteur.
• Un compte Plausible (plausible.io ou un serveur) par intégration, 25 sites au plus.
• Les seuils de « Pic de visiteurs » et « Aucune visite depuis un moment » sont les mêmes pour tous les sites.
• Pas encore testée sur plausible.io, et sans lien avec Plausible Insights OÜ.

Paramètres de configuration

Voici les paramètres demandés par Plausible Analytics dans son écran de configuration dans Gladys.

Paramètre	Type	Obligatoire	Description
Votre compte Plausible	section	Non	plausible.io : laissez l'adresse vide. Votre serveur (Community Edition 2.1+) : son adresse. Puis une clé « Stats API » (Settings → API keys) et les domaines de vos sites, comme dans Plausible. Ajoutez ensuite les sites depuis l'onglet Découverte.
Adresse de Plausible	string	Non	Vide pour plausible.io, ou l'adresse de votre propre serveur.
Clé d'API	secret	Oui	Une clé de type « Stats API » : Settings → API keys dans Plausible.
Domaines des sites	string	Oui	Tels qu'écrits dans Plausible, séparés par des virgules (25 au plus).
Options	section	Non
Visiteurs en ce moment : intervalle	select	Non	Une requête par site à chaque fois ; les chiffres du jour toutes les 15 minutes. plausible.io : allongé pour rester sous 600 requêtes par heure.
Pic de visiteurs à partir de	number	Non	Visiteurs simultanés (5 dernières minutes) qui déclenchent le déclencheur de scène « Pic de visiteurs ».
Aucune visite depuis (heures)	number	Non	Heures sans aucune visite qui déclenchent le déclencheur de scène « Aucune visite depuis un moment ».
Langue des noms	select	Non	Langue des noms des fonctionnalités (fixés à l'ajout d'un appareil) et des résultats de scène.

Comment installer Plausible Analytics dans Gladys

1. Dans Gladys, ouvrez Intégrations : Plausible Analytics apparaît dans le catalogue, aux côtés des intégrations natives, avec un badge communautaire.
2. Cliquez sur Installer. Gladys télécharge l'image Docker (ghcr.io/guim31/gladys-plausible:1.0.0), la démarre dans un bac à sable isolé du cœur, et génère l'interface de l'intégration (appareils, découverte et configuration).
3. Ouvrez l'écran Configuration de l'intégration, remplissez les paramètres, puis enregistrez.
4. Vous pouvez aussi l'installer directement depuis l'URL de son dépôt : https://github.com/guim31/gladys-plausible.

Plausible Analytics nécessite Gladys >=5.1.0. Le catalogue dans Gladys se rafraîchit toutes les heures : une nouvelle version est donc disponible au plus tard une heure après sa sortie.

Vous n'utilisez pas encore Gladys ? C'est gratuit et open source : suivez le guide d'installation pour démarrer.

À propos des intégrations externes

Plausible Analytics est une intégration externe : une intégration communautaire empaquetée dans un conteneur Docker et publiée sur GitHub, que Gladys installe en un clic et exécute dans un bac à sable isolé de son cœur. Elle est publiée et maintenue par guim31, et non par l'équipe cœur de Gladys.

• Parcourir toutes les intégrations, natives et communautaires
• Créer et publier votre propre intégration externe
• Code source sur GitHub — source de cette documentation

Inscrivez-vous à la newsletter Gladys Assistant

Quelques emails par mois sur les nouveautés et l'actualité du projet. Envoyés par Pierre-Gilles Leymarie, le fondateur du projet. Désinscription possible à tout moment 🙂