| commit | bc3655879539fe521a3397f21ee629d137ced0e2 | [log] [tgz] |
|---|---|---|
| author | Luca Milanesio <luca.milanesio@gmail.com> | Tue May 15 22:32:54 2018 +0100 |
| committer | Luca Milanesio <luca.milanesio@gmail.com> | Mon May 21 21:53:01 2018 +0100 |
| tree | 340d5184f83c2350a8273bfe1bfeded6ec617671 | |
| parent | f636db751cc06f2c22bb8300994ef3a2b0d68c76 [diff] |
Allow the installation of analytics-etl as plugin Introduce an SSH command to start the extraction of Gerrit Analytics and re-package the fat-jar as Gerrit plugin. To run the Spark job inside Gerrit, requires to have the Spark libraries linked into the /lib directory beforehand. Keep the ability to still run the Job in a Spark Cluster by keeping the main entry point and the Spark dependencies as provided. Bug: Issue 9021 Change-Id: I66a051250242b1534400d6baacad0cdaaf177266
Spark ETL to extra analytics data from Gerrit Projects.
Requires a Gerrit 2.13.x or later with the analytics plugin installed and Apache Spark 2.11 or later.
Job can be launched with the following parameters:
bin/spark-submit \
--conf spark.es.nodes=es.mycompany.com \
$JARS/SparkAnalytics-assembly.jar \
--since 2000-06-01 \
--aggregate email_hour \
--url http://gerrit.mycompany.com \
--events file:///tmp/gerrit-events-export.json
--writeNotProcessedEventsTo file:///tmp/failed-events
-e gerrit/analytics
Should ElasticSearch need authentication (i.e.: if X-Pack is enabled), credentials can be passed through the spark.es.net.http.auth.pass and spark.es.net.http.auth.user parameters.
since, until, aggregate are the same defined in Gerrit Analytics plugin see: https://gerrit.googlesource.com/plugins/analytics/+/master/README.md
-u --url Gerrit server URL with the analytics plugins installed
-p --prefix (optional) Projects prefix. Limit the results to those projects that start with the specified prefix.
-e --elasticIndex specify as / to be loaded in Elastic Search if not provided no ES export will be performed
-o --out folder location for storing the output as JSON files if not provided data is saved to /analytics- where is the system temporary directory
-a --email-aliases (optional) “emails to author alias” input data path.
--events location where to load the Gerrit Events If not specified events will be ignored
--writeNotProcessedEventsTo location where to write a TSV file containing the events we couldn't process with a description fo the reason why
CSVs with 3 columns are expected in input.
Here an example of the required files structure:
author,email,organization John Smith,john@email.com,John's Company John Smith,john@anotheremail.com,John's Company David Smith,david.smith@email.com,Indipendent David Smith,david@myemail.com,Indipendent
You can use the following command to quickly extract the list of authors and emails to create part of an input CSV file:
echo -e "author,email\n$(git log --pretty="%an,%ae%n%cn,%ce"|sort |uniq )" > /tmp/my_aliases.csv
Once you have it, you just have to add the organization column.
NOTE:
A docker compose file is provided to spin up an instance of Elastisearch with Kibana locally. Just run docker-compose up.
Kibana will run on port 5601 and Elastisearch on port 9200
If Elastisearch dies with exit code 137 you might have to give Docker more memory (check this article for more details)
To build the gerritforge/spark-gerrit-analytics-etl docker container just run sbt docker. If you want to distribute use sbt dockerBuildAndPush.
The build and distribution override the latest image tag too
Remember to create an annotated tag for a relase. The tag is used to define the docker image tag too