Google Git
Sign in
gerrit / plugins / analytics-wizard / c75a4ba5b39901bfc2cbed0695d74cb8c6a0a6bc
commitc75a4ba5b39901bfc2cbed0695d74cb8c6a0a6bc[log] [tgz]
authorFabio Ponciroli <ponch78@gmail.com>Fri Nov 02 13:03:22 2018 +0100
committerFabio Ponciroli <ponch78@gmail.com>Fri Nov 02 13:08:25 2018 +0100
treed62cc77202b34ea8f31b1eafa49b02d64ff7a223
parent0eb14b520c8845a16152c7cb6a7735053ad79f7f [diff]
Add Virtual memory caveats

On Linux the Virtual Memory settings might need to be changed. See this link for more details:
https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html

Change-Id: Id373f95d8e4d6a7463b736f4f5cb54dc12525b6b
1 file changed
tree: d62cc77202b34ea8f31b1eafa49b02d64ff7a223
  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 you are logged in Gerrit you can access the dashboard configuration via the top menu (Analytics Wizard > Configure Dashboard).

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.

Caveats

  • Virtual Memory settings: run sysctl -w vm.max_map_count=262144 from command line, if you are using a Linux box and the dashboard creation fails with a similar error:
max virtual memory areas vm.max_map_count [XXXXX] is too low, increase to at least [262144]