Integración domótica Plausible Analytics, gratuita y de código abierto

Visitantes ahora y visitas del día de sus sitios Plausible en Gladys, con escena en caso de pico.

• Publicado por guim31
• Dispositivos
• Versión 1.0.0
• Requiere Gladys >=5.1.0
• ★ 0

Ver en GitHubTodas las integraciones

Plausible Analytics es una herramienta de analítica web sencilla y respetuosa con la privacidad, de código abierto (AGPL), en plausible.io o autoalojada (Community Edition). Esta integración lleva las cifras de sus sitios Plausible a Gladys: cada sitio se convierte en un dispositivo con sus visitantes ahora mismo y sus visitantes, visitas, páginas vistas, tasa de rebote, duración de la visita y página más vista del día. Las escenas pueden reaccionar a un pico de visitantes, al primer visitante del día o a un sitio que ya no recibe visitas (script de seguimiento roto), un widget del panel muestra el día de un vistazo, y una acción de escena pone las cifras de un sitio en un mensaje.

Probada con un Plausible Community Edition 3.2.1 real y autoalojado (Docker, PostgreSQL y ClickHouse); todavía no en plausible.io: sus comentarios son bienvenidos en las issues.

Lo que necesita

• Gladys Assistant 5.1.0 o posterior.
• Un Plausible: en plausible.io, o su propio servidor (Community Edition 2.1 o posterior, la primera con la API Stats v2), accesible desde la máquina de Gladys.
• Una clave «Stats API» de su cuenta de Plausible.
• Los dominios de los sitios que quiere seguir, tal como figuran en Plausible (por ejemplo blog.example.org): una clave Stats API no puede listar sus sitios.

En cada lectura, la integración envía una petición por sitio (los visitantes ahora mismo). Cada 15 minutos lee además las cifras del día y la página más vista (dos peticiones por sitio) y, cuando no hay nadie en un sitio, las visitas de las últimas horas. plausible.io acepta 600 peticiones por hora y clave: allí, la integración alarga el intervalo por sí misma para no superar 540 (con 20 sitios, una lectura cada 4 minutos). La Community Edition no tiene ese límite.

Primeros pasos

1. Crear una clave Stats API

En Plausible, abra Settings → API keys (los ajustes de su cuenta), haga clic en New API key, elija el tipo Stats API y copie la clave (solo se muestra una vez).

2. Configurar la integración

En Gladys, abra Integraciones → Plausible Analytics → Configuración:

• Dirección de Plausible: vacía para plausible.io, o la dirección de su servidor (por ejemplo http://192.168.1.10:8000). Se entiende una dirección copiada del navegador.
• Clave de API: la clave Stats API.
• Dominios de los sitios: separados por comas, 25 como máximo.
• Visitantes ahora: intervalo: 1, 2 o 5 minutos (1 minuto por defecto).
• Pico de visitantes a partir de: los visitantes simultáneos que activan «Pico de visitantes» (10 por defecto).
• Sin visitas desde hace (horas): las horas sin ninguna visita que activan «Sin visitas desde hace un tiempo» (24 por defecto).
• Idioma de los nombres: idioma de los nombres de las funciones y de los resultados de escena (francés por defecto).

Guarde y haga clic en Probar la conexión: el resultado indica el número de sitios, los visitantes del día y los de ahora mismo, y los dominios que Plausible rechaza para la clave, si los hay.

3. Añadir los sitios

Abra la pestaña Descubrir: cada sitio se propone con su dominio. Añada los que quiera ver en Gladys. Los desencadenantes de escena y el widget funcionan para todos los sitios, añadidos o no.

Los dispositivos

Cada sitio se convierte en un dispositivo con:

• Visitantes ahora mismo: los visitantes de los últimos 5 minutos, como los «current visitors» de Plausible.
• Visitantes hoy: visitantes únicos desde la medianoche.
• Visitas hoy: visitas (sesiones) desde la medianoche.
• Páginas vistas hoy: páginas vistas desde la medianoche.
• Tasa de rebote hoy: la proporción de visitas que vieron una sola página, en porcentaje.
• Duración de la visita hoy: la duración media de una visita, en segundos.
• Página más vista hoy: su ruta, por ejemplo /posts/hello; «-» antes de la primera página vista del día.

«Hoy» es el día del sitio en Plausible, en la zona horaria de sus ajustes: las cifras del día vuelven a 0 a su medianoche. Los visitantes ahora mismo siguen el intervalo de la configuración, las cifras del día se leen cada 15 minutos, y enseguida con la llegada de un primer visitante. Un valor que no cambia se reenvía cada 12 horas, para que Gladys lo mantenga reciente.

Panel

El widget Plausible hoy muestra cuatro mosaicos (visitantes ahora mismo, visitantes, visitas y páginas vistas del día), sumados sobre los sitios mostrados, y luego una fila por sitio con sus visitantes del día y de ahora mismo, el más visitado primero. Con un solo sitio, se muestra en su lugar la página más vista del día. En los ajustes del widget, elija algunos sitios para mostrar solo esos (dispositivos añadidos a Gladys). El botón Actualizar vuelve a leer Plausible.

Escenas

Desencadenantes

• Pico de visitantes: los visitantes ahora mismo de un sitio alcanzan el umbral de la configuración. Una vez por pico, y 30 minutos como mínimo entre dos avisos para un sitio: un pico que sigue al final de la pausa se anuncia entonces. Variables: dominio, visitantes ahora mismo, umbral.
• Primer visitante del día: un sitio recibe su primer visitante desde su medianoche. Variables: dominio, visitantes hoy. Un primer visitante que llegó sin ser visto (integración detenida, Plausible inaccesible o dominio rechazado durante más de unos 15 minutos) no se anuncia.
• Sin visitas desde hace un tiempo: un sitio que tenía visitas no recibe ninguna durante las horas de la configuración: quizá el script de seguimiento falla, o el sitio está caído. Una vez, hasta que vuelva una visita. Variables: dominio, horas sin visitas.

Cada desencadenante puede limitarse a algunos sitios (vacío: todos). Lo que recuerdan los desencadenantes se guarda en el volumen /data: un reinicio de Gladys o de la integración no anuncia dos veces un pico ni un primer visitante. No se anuncia nada en la primera lectura de un sitio: un pico o un silencio ya en curso solo se registra.

Acciones

• Leer las cifras de un sitio: da el dominio (name), los visitantes ahora mismo (active), los visitors, visits, pageviews, bounce_rate y visit_duration del día, la top_page y una frase lista (sentence), por ejemplo «blog.example.org: 132 visitante(s) y 410 página(s) vista(s) hoy, 4 ahora mismo, página más vista /posts/hello.».

Ideas de escenas

• Cuando Pico de visitantes se active para su tienda, enviar un mensaje de Telegram «Afluencia en {{domain}}: {{visitors}} visitantes ahora mismo».
• Cuando Sin visitas desde hace un tiempo se active, enviar una notificación «Ninguna visita en {{domain}} desde hace {{hours}} h: revise el script de seguimiento».
• Cada noche a las 21:00, Leer las cifras de un sitio y enviar la frase (sentence) por mensaje.
• Con la función Visitantes ahora mismo como condición de escena, encender una lámpara en verde mientras haya alguien en el sitio.

Solución de problemas

• «Pegue una clave «Stats API»»: la clave está vacía.
• «Indique los dominios de sus sitios»: no se pudo leer ningún dominio; escríbalos como en Plausible, separados por comas.
• «clave de API rechazada, o ningún dominio conocido por Plausible»: Plausible responde igual a una clave errónea y a un sitio que la clave no ve. Vuelva a copiar la clave (tipo Stats API) y compruebe los dominios. Si solo se rechazan algunos dominios, los demás se leen, y Probar la conexión nombra los rechazados.
• «no hay API Stats de Plausible en esta dirección»: compruebe la dirección y el puerto (8000 por defecto), y la versión (Community Edition 2.1 o posterior).
• «la dirección redirige»: introduzca directamente la dirección https://.
• «demasiadas peticiones»: elija un intervalo más largo, o siga menos sitios.
• Los registros de la integración (Integraciones → Plausible Analytics) dicen más; no se escribe nada en ellos durante un ciclo de lectura normal.

Límites

• Solo lectura: la integración no cambia nada en Plausible.
• Los dominios se escriben a mano: una clave Stats API no puede listar los sitios (la Sites API no existe en la Community Edition, y en plausible.io está reservada a la oferta Enterprise). Un sitio renombrado en Plausible debe renombrarse también en la configuración, y se convierte en un nuevo dispositivo.
• «Visitantes ahora mismo» es la ventana de 5 minutos de Plausible; las cifras del día tienen como máximo 15 minutos, salvo con el primer visitante.
• Una cuenta de Plausible (plausible.io o un servidor) por integración, 25 sitios como máximo.
• Los umbrales de «Pico de visitantes» y «Sin visitas desde hace un tiempo» son los mismos para todos los sitios.
• Todavía no probada en plausible.io, y sin relación con Plausible Insights OÜ.

Parámetros de configuración

Estos son los parámetros que Plausible Analytics te pide en su pantalla de configuración en Gladys.

Parámetro	Tipo	Obligatorio	Descripción
Su cuenta de Plausible	section	No	plausible.io: deje la dirección vacía. Su servidor (Community Edition 2.1+): su dirección. Luego una clave «Stats API» (Settings → API keys) y los dominios de sus sitios, como en Plausible. Después añada los sitios desde la pestaña Descubrir.
Dirección de Plausible	string	No	Vacía para plausible.io, o la dirección de su propio servidor.
Clave de API	secret	Sí	Una clave de tipo «Stats API»: Settings → API keys en Plausible.
Dominios de los sitios	string	Sí	Tal como figuran en Plausible, separados por comas (25 como máximo).
Opciones	section	No
Visitantes ahora: intervalo	select	No	Una petición por sitio cada vez; las cifras del día cada 15 minutos. plausible.io: se alarga para no superar 600 peticiones por hora.
Pico de visitantes a partir de	number	No	Visitantes simultáneos (últimos 5 minutos) que activan el disparador de escena «Pico de visitantes».
Sin visitas desde hace (horas)	number	No	Horas sin ninguna visita que activan el disparador de escena «Sin visitas desde hace un tiempo».
Idioma de los nombres	select	No	Idioma de los nombres de las funciones (fijados al añadir un dispositivo) y de los resultados de escena.

Cómo instalar Plausible Analytics en Gladys

1. En Gladys, abre Integraciones: Plausible Analytics aparece en el catálogo junto a las integraciones nativas, con una insignia de comunidad.
2. Haz clic en Instalar. Gladys descarga la imagen Docker (ghcr.io/guim31/gladys-plausible:1.0.0), la ejecuta en un entorno aislado del núcleo y genera la interfaz de la integración (dispositivos, descubrimiento y configuración).
3. Abre la pantalla de Configuración de la integración, rellena los parámetros y guarda.
4. También puedes instalarla directamente desde la URL de su repositorio: https://github.com/guim31/gladys-plausible.

Plausible Analytics requiere Gladys >=5.1.0. El catálogo de Gladys se actualiza cada hora, así que una nueva versión está disponible como máximo una hora después de publicarse.

¿Todavía no usas Gladys? Es gratuito y de código abierto: sigue la guía de instalación para empezar.

Sobre las integraciones externas

Plausible Analytics es una integración externa: una integración comunitaria empaquetada como contenedor Docker y publicada en GitHub. Gladys la instala con un clic y la ejecuta en un entorno aislado del núcleo. La publica y mantiene guim31, no el equipo principal de Gladys.

• Explorar todas las integraciones, nativas y de la comunidad
• Crear y publicar tu propia integración externa
• Código fuente en GitHub — fuente de esta documentación

Suscríbete a la newsletter de Gladys Assistant

Unos pocos correos al mes sobre nuevas versiones y novedades del proyecto. Enviados por Pierre-Gilles Leymarie, fundador del proyecto. Puedes darte de baja cuando quieras 🙂