SiteBeacon Reporter

Description

When your site goes down or something breaks, SiteBeacon tells you by email, so you don’t hear it first from a customer.

SiteBeacon Reporter connects your WordPress site to SiteBeacon, a website monitoring service (uptime checks every 5 minutes, page content checks, SSL and domain expiry). The free plan monitors up to 2 sites, with no time limit.

Uptime checks from the outside can tell you that a site is down. They cannot tell you that a plugin update is waiting, that debug.log is filling up with fatal errors, or that someone changed a core file. This plugin reports those things from the inside.

Once an hour it sends a small JSON report to SiteBeacon:

  • WordPress, PHP and MySQL/MariaDB versions, and whether updates are available
  • Active theme and plugins with their versions and available updates (up to 200)
  • Number of inactive plugins and number of users per role (to notice a new administrator)
  • Number of fatal errors and warnings added to debug.log since the last report
  • Last published post, next scheduled post, number of scheduled posts, and late WP-Cron events
  • Failed logins and lockouts in the last 24 hours (only when SiteGuard WP Plugin is used)
  • Once a day: the result of comparing core and plugin files with the checksums published by WordPress.org (counts and relative paths only)
  • The result of the last automatic update (counts and slugs only)

SiteBeacon shows these on the site’s page and emails you when something needs attention.

Nothing is sent until you save a token

Right after activation the plugin connects nowhere: not to SiteBeacon, and not to WordPress.org. Reports and the daily file check start only after you save a SiteBeacon token. When you remove the token, both stop.

What is never sent

  • User names, email addresses or display names
  • File contents, debug.log lines, error messages, or absolute server paths
  • Database name, table prefix, WP-Cron hook names, passwords, keys or tokens (the token is only used in the Authorization header)

Requirements

A SiteBeacon account. The free plan monitors up to 2 sites.

External services

This plugin connects to the following services. Nothing is sent, and no connection is made, until you save a SiteBeacon token.

SiteBeacon (s-m.biz) – the monitoring service this plugin reports to.

  • What is sent: the site host name (from the Home URL), the date and time of the report, the version of this plugin, WordPress version and available update, PHP version, MySQL/MariaDB version, the active theme (slug, version, available update), the active plugins (file name such as akismet/akismet.php, version, available update, up to 200), the number of inactive plugins, the number of users per role, the number of fatal errors and warnings added to debug.log, the last published post time, the next scheduled post time and the number of scheduled posts, the number of WP-Cron events late by more than 1 hour and the longest delay, failed logins and lockouts in the last 24 hours (only with SiteGuard WP Plugin), the result of the daily file check (counts, and up to 10 relative paths for core and for each plugin, 50 plugin paths in total; or “turned off”), and the result of the last automatic update (counts and the slugs of up to 5 failed items).
  • Also received by SiteBeacon, as with any HTTP request: the IP address of your server and the User-Agent header that WordPress adds to its requests (it contains the WordPress version and your site URL).
  • When: once an hour by WP-Cron, and when you click “Send now” in Settings SiteBeacon Reporter. Only while a token is saved.
  • Where: https://s-m.biz/siteb/api/v1/siteb/report (HTTPS POST, with your token in the Authorization header, 10 second timeout).
  • Terms of use: https://s-m.biz/siteb/lp/agreement
  • Privacy policy: https://s-m.biz/siteb/lp/privacy

WordPress.org checksum API – used by the daily file check.

  • What is sent: your WordPress version and locale (for the core checksums), and the slug and version of each plugin that is compared (for the plugin checksums). As with any HTTP request, WordPress.org also receives your server’s IP address and the WordPress User-Agent (WordPress version and site URL).
  • When: once a day, continuing 10 minutes later when the check does not finish in 20 seconds (up to 30 times a day). Only while a token is saved and the file check is not turned off.
  • Where: https://api.wordpress.org/core/checksums/1.0/ and https://downloads.wordpress.org/plugin-checksums/
  • Terms and privacy: https://wordpress.org/about/privacy/

Screenshots

Installation

  1. Install and activate the plugin.
  2. In SiteBeacon, open the site and issue a report token (it starts with sbt_).
  3. In WordPress, go to Settings SiteBeacon Reporter, paste the token and save.
  4. Click “Send now”. When the result says “HTTP 200”, the site is connected.

If your site blocks outgoing requests with WP_HTTP_BLOCK_EXTERNAL, add s-m.biz (and api.wordpress.org, downloads.wordpress.org for the file check) to WP_ACCESSIBLE_HOSTS.

FAQ

Does it slow down my site?

No. Reports are sent by WP-Cron once an hour with a 10 second timeout. The daily file check stops after 20 seconds and continues 10 minutes later if needed (up to 30 times a day).

Does it connect anywhere before I save a token?

No. Without a token, the hourly event does nothing and the daily file check is not scheduled.

Can I turn off the file check?

Yes. Check “Do not check files” in Settings SiteBeacon Reporter. The report then says that the file check is turned off.

Which plugins are not compared with WordPress.org?

Plugins that are not hosted on WordPress.org are counted as “not compared” and are not looked up. A plugin is treated this way when, in this order:

  1. its header has an Update URI whose host is not wordpress.org or w.org (an Update URI on wordpress.org or w.org means it is compared), or
  2. its folder name starts with fstyle-, or
  3. its Author is fstyle or fstylegear09543, or its Author URI or Plugin URI is on fs-create.net or s-m.biz (or a subdomain).

Rules 2 and 3 match the plugins made by the author of this plugin, so that private versions of them are not reported as “changed”. This plugin itself is never compared.

What happens if SiteBeacon is down?

The plugin keeps the last result and tries again at the next hour. It never blocks your site.

What happens when the token is wrong?

When SiteBeacon answers 401, the plugin stops sending until you save the token again. When it answers 429, the plugin waits for the time given in Retry-After (10 minutes if none).

Is the plugin available in Japanese?

The plugin is written in English. A Japanese translation will be provided through translate.wordpress.org.

What is removed when I delete the plugin?

All options of this plugin (including the token), its WP-Cron events and its transients. Deactivating the plugin keeps the token and removes the WP-Cron events.

Reviews

There are no reviews for this plugin.

Contributors & Developers

“SiteBeacon Reporter” is open source software. The following people have contributed to this plugin.

Contributors

Translate “SiteBeacon Reporter” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.3.0

  • First release on WordPress.org.
  • Removed the self-update from s-m.biz. Updates now come from WordPress.org.
  • The daily file check is scheduled only while a token is saved. Without a token the plugin connects nowhere.
  • Added “Remove token” to the settings screen.
  • The settings screen is now in English and translatable (text domain siteb-reporter).
  • The database version is read with $wpdb->db_server_info().
  • Requires PHP 7.4.

1.2.3

  • File check: plugins not hosted on WordPress.org are no longer compared, and paths of changed plugin files are reported.
  • When the file check is turned off, the report says so.

1.2.2

  • File check: a plugin that makes PHP stop twice is skipped, so the check no longer stays “in progress”.

1.2.1

  • File check: when it does not finish in 20 seconds, it continues 10 minutes later.

1.2.0

  • Added the daily file check and the result of the last automatic update.

1.1.0

  • Added signed self-updates from s-m.biz (removed in 1.3.0).

1.0.1

  • The display name is now “SiteBeacon Reporter”.

1.0.0

  • First version.