Skip to content

Live widget for piwik that displays the actual performance of your sites.

License

Notifications You must be signed in to change notification settings

chanzler/piwik-performance-monitor

Repository files navigation

Piwik PerformanceMonitor Plugin

Description

This is a plugin for the Open Source Web Analytics platform Piwik. If enabled, it will add a new widget that you can add to your dashboard and a new link in the top navigation.

The widget will show the performance index of a site that auto-refreshes every 30 seconds. It shows the number of visitors or visit time in a 30 minute period compared to the maximum number of visitors in any 30 minute period of the last 30 days.

This plugin is inspired by the piwik barometer plugin and uses a lightly modified jQuery-Dynameter (original by Tzechiu Lei.

This plugin should run fine with installations with up to 100.000 page impressions per day. If you run a very large piwik installation and have performance issues with this plugin, please contact me - there is a solution for this. I have it up and running in an installation with more than 5 million visits per day.

(Tested with piwik 2.7.0, but supposed to run with older versions)

Installation

Install it via Piwik Marketplace OR install manually:

  1. Clone the plugin into the plugins directory of your Piwik installation.

    cd plugins/
    git clone https://github.com/chanzler/piwik-performance-monitor.git PerformanceMonitor
    
  2. Login as superuser into your Piwik installation and activate the plugin under Settings -> Plugins

  3. You will now find the widget under the Live! section.

  4. (optional) When you update: As there have been made several changes in v0.2.0 you might have to clear your cache (console core:clear-caches)

  5. (optional) When you run a very large piwik installation please add the following index: ALTER TABLE piwik_log_visit ADD UNIQUE ( visit_first_action_time );

FAQ

###Features Here is a list of features that are included in this project:

  • Live widget ("Performance Monitor") with key performance indices
  • Add an item to the top navigation ("Performance overview") which displays the performance monitor widget for all your sites (configurable).

###Configuration Refresh interval: Defines how often the widgets will be updated. Every 30 seconds is a good value to choose.

Measurement period: Defines the measurement period in minutes. 5 minutes is a good value to choose.

Comparison period: Defines the period (x * 24h) the last 30 minutes are compared to. A good value for small sites with more or less static content is 30. For sites with peak days on weekends for example 1 will be a good value. 1 is also a good value for very big sites with a lot of traffic. You will have to play around with this value a little bit and figure out whalt will fit your needs.

Sites in overview: Defines which sites are displayed in the overview.

Changelog

0.2.6 Bugfix Release

  • changed SQL from visit_last_action_time to visit_first_action_time (be sure to add the index i mentioned in installation description if you run a very large piwik installation)

0.2.5 Bugfix Release

  • fixed bug with timezones that match /^UTC[+-]*/

0.2.4 Bugfix Release

  • reengineering of scheduled task

0.2.3 Bugfix Release

  • fixed bug in scheduled task

0.2.2 Bugfix Release

  • fixed an installation bug

0.2.0 Second Beta

  • made the plugin configurable by settings
  • added more key performance indices
  • performance overview now links to the dashboards
  • fixed the timezone bug (configure timezone for each site properly)
  • fixed several minor bugs

0.1.0 First Beta

  • initial release

License

GPL v3 or later

Support

Contribute

If you are interested in contributing to this plugin, feel free to send pull requests!

About

Live widget for piwik that displays the actual performance of your sites.

Resources

License

Stars

Watchers

Forks

Packages

No packages published