| commit | c50190a06468ae2734748eb7ef62729b0cf85475 | [log] [tgz] |
|---|---|---|
| author | Antonio Barone <syntonyze@gmail.com> | Fri Oct 12 17:12:08 2018 +0100 |
| committer | Antonio Barone <syntonyze@gmail.com> | Fri Oct 12 17:20:36 2018 +0100 |
| tree | f7a2f459510855085d169a71c5dc94ad0a773731 | |
| parent | c5124c3744b694b93faa9e0e743d69e089d18e7b [diff] |
Dockerize analytics ETL spark job Update sbt to generate a docker image running containerized ETL analytics job. The entrypoint of the docker file is a provided shell script that provides the relevant configuration and environment variables to the spark-submit command. Feature: Issue 9856 Change-Id: I8e1ad454bac79860a518d0f45e6c8016d0507350
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/analytics-etl.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 \ --username gerrit-api-username \ --password gerrit-api-password
You can also run this job in docker:
docker run -ti --rm \ -e ES_HOST="es.mycompany.com" \ -e GERRIT_URL="http://gerrit.mycompany.com" \ -e ANALYTICS_ARGS="--since 2000-06-01 --aggregate email_hour --writeNotProcessedEventsTo file:///tmp/failed-events -e gerrit/analytics" \ gerritforge/spark-gerrit-analytics-etl:latest
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.
If Elastisearch dies with exit code 137 you might have to give Docker more memory (check this article for more details)
If you want to run the etl job from within docker you need to make elasticsearch and gerrit available to it. You can do this by:
analytics-etl_ek if you used the docker-compose provided by this repo)--add-host="gerrit:<your_host_ip_address>")For example:
HOST_IP=`ifconfig en0 | grep "inet " | awk '{print $2}'` \ docker run -ti --rm \ --add-host="gerrit:$HOST_IP" \ --network analytics-etl_ek \ -e ES_HOST="elasticsearch" \ -e GERRIT_URL="http://$HOST_IP:8080" \ -e ANALYTICS_ARGS="--since 2000-06-01 --aggregate email_hour --writeNotProcessedEventsTo file:///tmp/failed-events -e gerrit/analytics" \ gerritforge/spark-gerrit-analytics-etl:latest
If the dockerized spark job cannot connect to elasticsearch (also, running on docker) you might need to tell elasticsearch to publish the host to the cluster using the _site_ address.
elasticsearch:
...
environment:
...
- http.host=0.0.0.0
- network.host=_site_
- http.publish_host=_site_
...
See here for more info
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 release. The tag is used to define the docker image tag too