automattic/jetpack-heartbeat

This adds a cronjob that sends a batch of internal automattic stats to wp.com once a day

Maintainers

Details

github.com/Automattic/jetpack-heartbeat

Source

Installs: 44 346

Dependents: 3

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 1

v1.3.5 2021-04-08 13:56 UTC

Requires

Requires (Dev)

GPL-2.0-or-later caeecb4e65070fa1cc4e7005672d4df2a81371bf

This package is auto-updated.

Last update: 2021-04-08 13:57:11 UTC

README

Sends a daily batch of stats to WP.com using the A8C MC Stats package.

These are internal usage stats for Automattic, not visible to site owners.

Usage

1. Make sure Hearbeat is initialized:

Automattic\Jetpack\Heartbeat::init();

2. Add your stats to the heartbeat

Add a filter callback:

add_filter( 'jetpack_heartbeat_stats_array', 'my_callback' );

In your callback, add the stats you want to the array with new key => value pairs where:

  • key is the stat group name
  • value is the stat name.
function my_callback( $stats ) {
	$stats['my-plugin'] = 'active';
	return $stats;
}

This will bump the stats for the 'my-plugin/active' stat.

And that's all!

Now your stats will be added to the batch of stats that are bumped once a day.