Google Git
Sign in
gerrit / plugins / analytics-wizard / ced8e6a4ba9f0e2f7873526c03640fafb4d52e75
commitced8e6a4ba9f0e2f7873526c03640fafb4d52e75[log] [tgz]
authorFabio Ponciroli <ponch78@gmail.com>Fri Nov 02 09:41:28 2018 +0100
committerFabio Ponciroli <ponch78@gmail.com>Fri Nov 02 09:41:28 2018 +0100
treea60a57ff883a3fcb65ac3bbccaa77c0a4e18e8cf
parentc04381679b577e69c9700e8b997d21783f6de51c [diff]
Better aggregation name and ordering

* Renaming 'email' to 'author'
* Ascending granularity ordering of aggregations
* Improved tooltips for credentials

Feature: Issue 9964
Change-Id: I30c728584144680e861a6c5a43be3d8f5f925a52
1 file changed
tree: a60a57ff883a3fcb65ac3bbccaa77c0a4e18e8cf
  1. project/
  2. resources/
  3. src/
  4. .gitignore
  5. .scalafmt.conf
  6. build.sbt
  7. LICENSE
  8. README.md
README.md

Analytics Wizard plugin

Wizard to locally setup an Analytics Dashboard like the Gerrit's one. This will allow you to explore the potentials of DevOps Analytics on your own repositories.

What it DOES

  • Setup a ready to use Analytics Dashboard with some defaults charts
  • Populate the Dashboard with data coming from the repos you would like to analyse

What it DOES NOT

  • Schedule recurring import of the data, but just the first one
  • Create a production ready environment. It is meant to build a playground to explore the potential of DevOps analytics
  • Create multiple dashboards

Setup

Prerequisites

##Installation

Copy the latest available jar into the Gerrit plugins directory and restart it. Assuming /usr/local/gerrit is the location of your Gerrit installation simply execute the following:

curl -o /tmp/analytics-wizard.jar https://gerrit-ci.gerritforge.com/job/plugin-analytics-wizard-sbt-master-master/analytics-wizard.jar &&\
cp /tmp/analytics-wizard.jar /usr/local/gerrit/plugins

How to use it

Once the plugin is installed and you are logged in Gerrit browse to this url: https://<you_gerrit_url>/plugins/analytics-wizard/static/analytics-dashboard.html

You will land on this screen:

alt text

Different parameters can be configured:

  • Dashboard name (required): name of the dashboard you are about to create
  • Projects prefix (optional): prefix of the projects you want to import, i.e.: to import all the projects under the Gerrit namespace, you can specify gerrit/. Note: It is not a regular expression.
  • Aggregation type (required): the data can be aggregated by email only, by email per hour, by email per day, by email per month or by email per year.
  • Date time-frame (optional): time window you want to collect data about
  • Username/Password (optional): credentials for Gerrit API, if basic auth is needed

Once you set the parameters pressing the “Create Dashboard” button will trigger the Dashboard creation and the data import.

Beware this operation will take a while since it requires to download several Docker images and run an ETL job to collect and aggregate the data.

At the end of this operation you will be presented with a dashbaord similar to this one:

alt text

You can now navigate among the different charts and uncover the potentials of DevOps analytics!

Components interaction

alt text

Development

To build the plugin, JDK 1.8 and sbt are required. Once installed use sbt to build:

cd ./analytics-wizard
sbt assembly

This will compile, test and package the plugin artifact, which can be found in ./target/scala-2.11/analytics-wizard.jar.