x/stackalytics
Code Issues Proposed changes
ffb80d98c8
stackalytics/README.rst
Sean McGinnis 3b72c01249
Fix up links and other updates 
Change-Id: I66e0fff47379d244a5216b65220301182a1034ea
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2020-03-10 15:38:25 -05:00

2.1 KiB
Raw Blame History

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 https://opendev.org/x/stackalytics
$ cd stackalytics
$ sudo pip install -r requirements.txt
$ sudo python setup.py install

  2. Install and run memcached DB:

    $ sudo apt-get install 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