/statistics-server forked from dongilbert/jstats-server

Server for collecting environment stats for Joomla Installations
  1. PHP 100.0%
PHP

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Pull request Compare This branch is 207 commits ahead of dongilbert:master.
Latest commit 08f6273 Jun 22, 2017 @mbabker mbabker committed on GitHub Merge pull request #33 from joomla/cms-on-fw-db 
Support Joomla! 4 using the Framework database package
Permalink
Failed to load latest commit information.
.github Add issue/PR template support Feb 20, 2016
bin A couple more file doc blocks Feb 27, 2017
cache Add caching support for aggregate data (Fix #23) Mar 26, 2016
etc Using bound params and require PDO MySQL Feb 26, 2017
logs Add logging support Nov 5, 2015
snapshots Add a command to take a snapshot Mar 26, 2016
src Support Joomla! 4 using the Framework database package Jun 7, 2017
tests Support Joomla! 4 using the Framework database package Jun 7, 2017
versions Updated PHP versions Jun 9, 2017
www A couple more file doc blocks Feb 27, 2017
.gitignore Unit tests for the application Oct 10, 2015
.scrutinizer.yml Add Scrutinizer-CI support Nov 17, 2015
.travis.yml Code updates for PHP 7 Jan 14, 2017
LICENSE License file Feb 25, 2017
README.md Change links Feb 27, 2017
boot.php Unit tests for the application Oct 10, 2015
composer.json Change app namespace, add file doc blocks Feb 27, 2017
composer.lock Vendor update May 30, 2017
phpunit.travisci.xml Add Travis-CI config Oct 10, 2015
phpunit.xml.dist Unit tests for the application Oct 10, 2015

README.md

Joomla Environment Stats

In order to better understand our install base and end user environments, a plugin has been created to send those stats back to a Joomla controlled central server. No worries though, no identifying data is captured at any point, and we only keep the data last sent to us.

Build Status

Travis-CI: Build Status Scrutinizer-CI: Scrutinizer Code Quality Code Coverage Build Status

Requirements

  • PHP 7.0+
  • PDO with MySQL support
  • MySQL
  • Composer
  • Apache with mod_rewrite enabled and configured to allow the .htaccess file to be read

Installation

  1. Clone this repo on your web server
  2. Create a database on your MySQL server
  3. Copy etc/config.dist.json to etc/config.json and fill in your database credentials
  4. Run the composer install command to install all dependencies
  5. Run the bin/stats install command to create the application's database

Additional Configuration

The DisplayControllerGet optionally supports several additional configuration values which affect the application's behavior, to include:

  • Caching - The joomla/cache package is used to provide a PSR-6 compliant caching API to store data. The supported configuration values are under the cache key in the configuration and include:
    • enabled - Is the cache enabled?
    • lifetime - The lifetime (in seconds) of the cache data
    • adapter - The cache adapter to use; the currently supported values can be found in the CacheServiceProvider
  • Raw Data Access - The API supports requesting the raw, unfiltered API data by sending a Joomla-Raw header with the API request. The value of this must match the stats.rawdata configuration key.

Additionally, the application behavior is affected by the following configuration settings:

  • Error Reporting - The errorReporting configuration key can be set to a valid bitmask to be passed into the error_reporting() function
  • Logging - The application's logging levels can be fine tuned by adjusting the log configuration keys:
    • log.level - The default logging level to use for all application loggers
    • log.application - The logging level to use specifically for the monolog.handler.application logger; defaults to the log.level value
    • log.database - The logging level to use specifically for the monolog.handler.database logger; defaults to the log.level value (Note: if database.debug is set to true then this level will ALWAYS correspond to the debug level)