Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cachethq.io/llms.txt

Use this file to discover all available pages before exploring further.

Cachet’s “beacon” system is an optional telemetry system that allows you to send anonymous usage data to Cachet. This data helps us to understand how Cachet is being used and how we can improve it.

​
Configuration

By default, Cachet’s beacon is turned off. You can opt in by setting the CACHET_BEACON environment variable to true.
.env
CACHET_BEACON=true
If you’re limiting outbound requests on your server and you’d like to opt into the beacon, you’ll need to allow outbound requests to https://cachethq.io.

​
Configuring the scheduler

Cachet automatically registers the cachet:beacon command to run daily at 00:00. You will need to configure your server to run the scheduler every minute using a cron job. To do so, you can do this by adding the following cron entry:
/etc/crontab
* * * * * php /path/to/cachet/artisan schedule:run >> /dev/null 2>&1
Be sure to replace /path/to/cachet with the actual path to your Cachet installation.

​
What data is collected?

  • Install ID: An anonymous identifier for your Cachet installation.
  • Cachet Version: The version of Cachet you’re running.
  • Docker: Whether you’re running Cachet in a Docker container.
  • Database: The type of database you’re using.
  • Usage Data: How you’re using Cachet, such as the number of incidents, components, subscribers, etc.