Bugzilla-ETL

Extract Bugzilla change history; Transform into bug snapshots; and Load into Elasticsearch

Support

If you are here because the Mozilla's instance is down, please read the Operation Support Document

Motivation and Details

https://wiki.mozilla.org/BMO/ElasticSearch

Requirements

• Python 3.6 (or PyPy to run fast)
• MySQL/Maria database with Mozilla's Bugzilla schema
• ElasticSearch >= 6.1 cluster to hold the bug snapshot documents

Installation

Python and SetupTools are required. It is best you install on Linux, but if you do install on Windows please [follow instructions to get these installed] (https://github.com/klahnakoski/pyLibrary#windows-7-install-instructions-for-python).
When done, installation is easy:

git clone https://github.com/klahnakoski/Bugzilla-ETL.git

then install requirements:

cd Bugzilla-ETL
pip install -r requirements.txt

WARNING: pip install Bugzilla-ETL does not work - I have been unable to get Pip to install resource files consistently across platforms and Python versions.

Installation with PyPy

PyPy will execute 4 to 5 times faster then CPython. PyPy maintains its own environment, and its own version of the module binaries. This means running SetupTools is just a little different. After

git clone https://github.com/klahnakoski/Bugzilla-ETL.git

then install requirements with PyPy's version of pip:

cd Bugzilla-ETL
c:\PyPy27\bin\pip.exe install -r requirements.txt

Despite my Windows example, the equivalent must be done in Linux.

Setup

You must prepare a settings.json file to reference the resources, and its filename must be provided as an argument in the command line. Examples of settings files can be found in resources/settings

Inter-Run State

Bugzilla-ETL keeps local run state in the form of two files: first_run_time and last_run_time. These are both parameters in the ``settings.json` file.

• first_run_time is written only if it does not exist, and triggers a full ETL refresh. Delete this file if you want to create a new ES index and start ETL from the beginning.
• last_run_time is recorded whenever there has been a successful ETL.
  This file will not exist until the initial full ETL has completed successfully. Deleting this file should have no net effect, other than making the program work harder then it should.

Alias Analysis

You will require an alias file that matches the various email addresses that users have over time. This analysis is necessary for proper CC list history and patch review history. More on alias analysis.

• Make an alias_analysis_settings.json file. Which can be the same main ETL settings.json file.
• The param.alias_file.key can be null, or set to a AES256 key of your choice.
• Run alias_analysis.py

Running bz_etl.py

Asuming your settings.json file is in ~/Bugzilla_ETL:

cd ~/Bugzilla_ETL

pypy bugzilla_etl\bz_etl.py --settings=settings.json

Use --help for more options, and see example command line script

Got it working?

The initial ETL will take over two hours. If you want something quicker to confirm your configuration is correct, use --reset --quick arguments on the command line. This will limit ETL to the first 1000, and last 1000 bugs.

cd ~/Bugzilla_ETL
pypy bugzilla_etl\bz_etl.py  --settings=settings.json --reset --quick

Using Cron

Bugzilla-ETL is meant to be triggered by cron; usually every 10 minutes. Bugzilla-ETL limits itself to only one instance per settings.json file: That way, if more then one instance is accidentally run, the subsequent instances will do no work and shutdown cleanly.

Running Tests

The Git clone will include test code. You can run those tests, but you must...

• Have MySQL installed (no Bugzilla schema required)
• Have an ElasticSearch (v 6.x+) cluster to hold the test results
• A complete test_settings.json file to point to the resources (example)
• Use pypy (v5.9+) for 4x the speed: pypy .\tests\test_etl.py --settings=test_settings.json

python -m pip install virtualenv
cd ~/Bugzilla-ETL

python -m virtualenv .env
.env\Scripts\activate
pip install -r requirements.txt
set PYTHONPATH=.;vendor

python -m unittest discover -v -s tests

Fixing tests

Test runs are compared to documents found in the reference files at tests/resources/reference. They may need updating after changing the code.

python -m unittest test_examples 

The output file is found in tests/results, and can replace the reference file. Be sure to review the git diff; it will show the change in the reference file, just to be sure nothing went wrong.

Upgrades

There may be enhancements from time to time. To get them

cd ~/Bugzilla-ETL
git pull origin master
pip install -r requirements.txt

After upgrading the code, you may want to trigger a full ETL. To do this, you may either

1. run bz_etl.py with the --reset flag directly, or
2. remove the first_run_time file (and the next cron event will trigger a full ETL)

Submitting Bugs

We use Bugzilla for tracking bugs. If you want to submit a bug or feature request, please add a dependency to BZ ETL Metabug

More on ElasticSearch

If you are new to ElasticSearch, I recommend using ElasticSearch Head for getting cluster status, current schema definitions, viewing individual records, and more. Clone it off of GitHub, and open the index.html file from in your browser. Here are some alternate instructions.