OpenStack analytics dashboard
Go to file
Ilya Shakhat 5d79f8aa9f Fix warnings in doc build
Change-Id: I405cac1e5e1a21c9b5d4292550afc917e225eb46
2017-04-10 15:19:38 +04:00
doc/source Fix warnings in doc build 2017-04-10 15:19:38 +04:00
etc Merge "Add my information to default_data.json" 2017-04-10 10:58:22 +00:00
stackalytics Merge "Revert "Add support for user correction"" 2017-04-10 10:54:43 +00:00
tools Remove white space between print () 2017-01-17 10:15:37 +07:00
.gitignore Add .idea pattern to .gitignore 2017-04-10 16:10:46 +05:30
.gitreview Update .gitreview for new namespace 2015-10-17 22:38:57 +00:00
.testr.conf Move tests under stackalytics package 2015-08-18 15:38:17 +03:00
LICENSE Initial code commit 2013-06-22 15:42:32 +04:00
MANIFEST.in Initial code commit 2013-06-22 15:42:32 +04:00
README.rst Add Quickstart 2017-04-04 14:09:29 -07:00
config-generator.conf Separate config module 2017-03-24 13:15:33 -07:00
requirements.txt Sync requirements with OpenStack global requirements 2017-03-29 16:45:01 +04:00
setup.cfg Separate config module 2017-03-24 13:15:33 -07:00
setup.py Sync requirements with OpenStack global requirements 2017-03-29 16:45:01 +04:00
test-requirements.txt Sync requirements with OpenStack global requirements 2017-03-29 16:45:01 +04:00
tox.ini fix setup.cfg and tox.ini 2017-03-10 16:14:39 +08:00

README.rst

Stackalytics

Application Features

Stackalytics is a service that automatically analyzes OpenStack development activities and displays statistics on contribution. The features are: * Extraction of author information from git log, store it in the database; * Calculate metrics on number of lines changed (LOC) and commits; * Mapping authors to companies and launchpad ids; * Filter statistics by time, modules, companies, authors; * Extract blueprint and bug ids from commit messages; * Auto-update of database.

Quickstart

To run Stackalytics, you first need to create two kind of configuration files. The one is default_data.json which shows which sources(git repo, ml, etc.) need to be analyzed. Another is stackalytics.conf which shows basic configuration like HTTP listening host and port, etc. Stackalytics repository contains the default files of these configuration under etc/ directory. It would be useful to copy and change them as you like.

  1. You need to install Stackalytics. This is done with pip after you check out Stackalytics repository:

    $ git clone http://git.openstack.org/openstack/stackalytics
    $ cd stackalytics
    $ sudo pip install -r requirements.txt
    $ sudo python setup.py install
  2. Install and run memcached DB:

    $ sudo apt-get install -y memcached
    $ memcached -u memcache -d
  3. Analyze data which are specifed on default_data.json and store the data into memcached DB:

    $ stackalytics-processor
  4. Start HTTP server of Stackalytics:

    $ stackalytics-dashboard
  5. Users can access Stackalytics site on http://127.0.0.1:8080 as the default.

Project Info