Hercules
Fast, insightful and highly customizable Git history analysis.
Overview • How To Use • Installation • Contributions • License
Table of Contents
- Overview
- Installation
- Contributions
- License
- Usage
- Roadmap
Overview
Hercules is an amazingly fast and highly customizable Git repository analysis engine written in Go. Batteries are included. Powered by go-git.
Notice (November 2020): the main author is back from the limbo and is gradually resuming the development. See the roadmap.
There are two command-line tools: hercules and labours. The first is a program written in Go which takes a Git repository and executes a Directed Acyclic Graph (DAG) of analysis tasks over the full commit history. The second is a Python script which shows some predefined plots over the collected data. These two tools are normally used together through a pipe. It is possible to write custom analyses using the plugin system. It is also possible to merge several analysis results together - relevant for organizations. The analyzed commit history includes branches, merges, etc.
Hercules has been successfully used for several internal projects at source{d}. There are blog posts: 1, 2 and a presentation. Please contribute by testing, fixing bugs, adding new analyses, or coding swagger!
The DAG of burndown and couples analyses with UAST diff refining. Generated with hercules --burndown --burndown-people --couples --feature=uast --dry-run --dump-dag doc/dag.dot https://github.com/src-d/hercules
torvalds/linux line burndown (granularity 30, sampling 30, resampled by year). Generated with hercules --burndown --first-parent --pb https://github.com/torvalds/linux | labours -f pb -m burndown-project in 1h 40min.
Installation
Grab hercules binary from the Releases page. labours is installable from PyPi:
pip3 install labours
pip3 is the Python package manager.
Numpy and Scipy can be installed on Windows using http://www.lfd.uci.edu/~gohlke/pythonlibs/
Build from source
You are going to need Go (>= v1.11) and protoc.
git clone https://github.com/src-d/hercules && cd hercules
make
pip3 install -e ./python
GitHub Action
It is possible to run Hercules as a GitHub Action: Hercules on GitHub Marketplace. Please refer to the sample workflow which demonstrates how to setup.
Contributions
...are welcome! See CONTRIBUTING and code of conduct.
License
Usage
The most useful and reliably up-to-date command line reference:
hercules --help
Some examples:
# Use "memory" go-git backend and display the burndown plot. "memory" is the fastest but the repository's git data must fit into RAM.
hercules --burndown https://github.com/go-git/go-git | labours -m burndown-project --resample month
# Use "file system" go-git backend and print some basic information about the repository.
hercules /path/to/cloned/go-git
# Use "file system" go-git backend, cache the cloned repository to /tmp/repo-cache, use Protocol Buffers and display the burndown plot without resampling.
hercules --burndown --pb https://github.com/git/git /tmp/repo-cache | labours -m burndown-project -f pb --resample raw
# Now something fun
# Get the linear history from git rev-list, reverse it
# Pipe to hercules, produce burndown snapshots for every 30 days grouped by 30 days
# Save the raw data to cache.yaml, so that later is possible to labours -i cache.yaml
# Pipe the raw data to labours, set text font size to 16pt, use Agg matplotlib backend and save the plot to output.png
git rev-list HEAD | tac | hercules --commits - --burndown https://github.com/git/git | tee cache.yaml | labours -m burndown-project --font-size 16 --backend Agg --output git.png
labours -i /path/to/yaml allows to read the output from hercules which was saved on disk.
Caching
It is possible to store the cloned repository on disk. The subsequent analysis can run on the corresponding directory instead of cloning from scratch:
# First time - cache
hercules https://github.com/git/git /tmp/repo-cache
# Second time - use the cache
hercules --some-analysis /tmp/repo-cache
GitHub Action
The action produces the artifact named hercules_charts. Since it is currently impossible to pack several files in one artifact, all the charts and Tensorflow Projector files are packed in the inner tar archive. In order to view the embeddings, go to projector.tensorflow.org, click "Load" and choose the two TSVs. Then use UMAP or T-SNE.
Docker image
docker run --rm srcd/hercules hercules --burndown --pb https://github.com/git/git | docker run --rm -i -v $(pwd):/io srcd/hercules labours -f pb -m burndown-project -o /io/git_git.png
Built-in analyses
Project burndown
hercules --burndown
labours -m burndown-project
Line burndown statistics for the whole repository. Exactly the same what git-of-theseus does but much faster. Blaming is performed efficiently and incrementally using a custom RB tree tracking algorithm, and only the last modification date is recorded while running the analysis.
All burndown analyses depend on the values of granularity and sampling. Granularity is the number of days each band in the stack consists of. Sampling is the frequency with which the burnout state is snapshotted. The smaller the value, the more smooth is the plot but the more work is done.
There is an option to resample the bands inside labours, so that you can define a very precise distribution and visualize it different ways. Besides, resampling aligns the bands across periodic boundaries, e.g. months or years. Unresampled bands are apparently not aligned and start from the project's birth date.
Files
hercules --burndown --burndown-files
labours -m burndown-file
Burndown statistics for every file in the repository which is alive in the latest revision.
Note: it will generate separate graph for every file. You don't want to run it on repository with many files.
People
hercules --burndown --burndown-people [--people-dict=/path/to/identities]
labours -m burndown-person
Burndown statistics for the repository's contributors. If --people-dict is not specified, the identities are discovered by the following algorithm:
- We start from the root commit towards the HEAD. Emails and names are converted to lower case.
- If we process an unknown email and name, record them as a new developer.
- If we process a known email but unknown name, match to the developer with the matching email, and add the unknown name to the list of that developer's names.
- If we process an unknown email but known name, match to the developer with the matching name, and add the unknown email to the list of that developer's emails.
If --people-dict is specified, it should point to a text file with the custom identities. The format is: every line is a single developer, it contains all the matching emails and names separated by |. The case is ignored.
Overwrites matrix
Wireshark top 20 devs - overwrites matrix
hercules --burndown --burndown-people [--people-dict=/path/to/identities]
labours -m overwrites-matrix
Beside the burndown information, --burndown-people collects the added and deleted line statistics per developer. Thus it can be visualized how many lines written by developer A are removed by developer B. This indicates collaboration between people and defines expertise teams.
The format is the matrix with N rows and (N+2) columns, where N is the number of developers.
- First column is the number of lines the developer wrote.
- Second column is how many lines were written by the developer and deleted by unidentified developers (if
--people-dictis not specified, it is always 0). - The rest of the columns show how many lines were written by the developer and deleted by identified developers.
The sequence of developers is stored in people_sequence YAML node.
Code ownership
Ember.js top 20 devs - code ownership
hercules --burndown --burndown-people [--people-dict=/path/to/identities]
labours -m ownership
--burndown-people also allows to draw the code share through time stacked area plot. That is, how many lines are alive at the sampled moments in time for each identified developer.
Couples
torvalds/linux files' coupling in Tensorflow Projector
hercules --couples [--people-dict=/path/to/identities]
labours -m couples -o <name> [--couples-tmp-dir=/tmp]
Important: it requires Tensorflow to be installed, please follow official instructions.
The files are coupled if they are changed in the same commit. The developers are coupled if they change the same file. hercules records the number of couples throughout the whole commit history and outputs the two corresponding co-occurrence matrices. labours then trains Swivel embeddings - dense vectors which reflect the co-occurrence probability through the Euclidean distance. The training requires a working Tensorflow installation. The intermediate files are stored in the system temporary directory or --couples-tmp-dir if it is specified. The trained embeddings are written to the current working directory with the name depending on -o. The output format is TSV and matches Tensorflow Projector so that the files and people can be visualized with t-SNE implemented in TF Projector.
Structural hotness
46 jinja2/compiler.py:visit_Template [FunctionDef]
42 jinja2/compiler.py:visit_For [FunctionDef]
34 jinja2/compiler.py:visit_Output [FunctionDef]
29 jinja2/environment.py:compile [FunctionDef]
27 jinja2/compiler.py:visit_Include [FunctionDef]
22 jinja2/compiler.py:visit_Macro [FunctionDef]
22 jinja2/compiler.py:visit_FromImport [FunctionDef]
21 jinja2/compiler.py:visit_Filter [FunctionDef]
21 jinja2/runtime.py:__call__ [FunctionDef]
20 jinja2/compiler.py:visit_Block [FunctionDef]
Thanks to Babelfish, hercules is able to measure how many times each structural unit has been modified. By default, it looks at functions; refer to Semantic UAST XPath manual to switch to something else.
hercules --shotness [--shotness-xpath-*]
labours -m shotness
Couples analysis automatically loads "shotness" data if available.
hercules --shotness --pb https://github.com/pallets/jinja | labours -m couples -f pb
Aligned commit series
tensorflow/tensorflow aligned commit series of top 50 developers by commit number.
hercules --devs [--people-dict=/path/to/identities]
labours -m devs -o <name>
We record how many commits made, as well as lines added, removed and changed per day for each developer. We plot the resulting commit time series using a few tricks to show the temporal grouping. In other words, two adjacent commit series should look similar after normalization.
- We compute the distance matrix of the commit series. Our distance metric is Dynamic Time Warping. We use FastDTW algorithm which has linear complexity proportional to the length of time series. Thus the overall complexity of computing the matrix is quadratic.
- We compile the linear list of commit series with Seriation technique. Particularly, we solve the Travelling Salesman Problem which is NP-complete. However, given the typical number of developers which is less than 1,000, there is a good chance that the solution does not take much time. We use Google or-tools solver.
- We find 1-dimensional clusters in the resulting path with HDBSCAN algorithm and assign colors accordingly.
- Time series are smoothed by convolving with the Slepian window.
This plot allows to discover how the development team evolved through time. It also shows "commit flashmobs" such as Hacktoberfest. For example, here are the revealed insights from the tensorflow/tensorflow plot above:
- "Tensorflow Gardener" is classified as the only outlier.
- The "blue" group of developers covers the global maintainers and a few people who left (at the top).
- The "red" group shows how core developers join the project or become less active.
Added vs changed lines through time
tensorflow/tensorflow added and changed lines through time.
hercules --devs [--people-dict=/path/to/identities]
labours -m old-vs-new -o <name>
--devs from the previous section allows to plot how many lines were added and how many existing changed (deleted or replaced) through time. This plot is smoothed.
Efforts through time
kubernetes/kubernetes efforts through time.
hercules --devs [--people-dict=/path/to/identities]
labours -m devs-efforts -o <name>
Besides, --devs allows to plot how many lines have been changed (added or removed) by each developer. The upper part of the plot is an accumulated (integrated) lower part. It is impossible to have the same scale for both parts, so the lower values are scaled, and hence there are no lower Y axis ticks. There is a difference between the efforts plot and the ownership plot, although changing lines correlate with owning lines.
Sentiment (positive and negative comments)
It can be clearly seen that Django comments were positive/optimistic in the beginning, but later became negative/pessimistic.hercules --sentiment --pb https://github.com/django/django | labours -m sentiment -f pb
We extract new and changed comments from source code on every commit, apply BiDiSentiment general purpose sentiment recurrent neural network and plot the results. Requires libtensorflow. E.g. sadly, we need to hide the rect from the documentation finder for now is negative and Theano has a built-in optimization for logsumexp (...) so we can just write the expression directly is positive. Don't expect too much though - as was written, the sentiment model is general purpose and the code comments have different nature, so there is no magic (for now).
Hercules must be built with "tensorflow" tag - it is not by default:
make TAGS=tensorflow
Such a build requires libtensorflow.
Everything in a single pass
hercules --burndown --burndown-files --burndown-people --couples --shotness --devs [--people-dict=/path/to/identities]
labours -m all
Plugins
Hercules has a plugin system and allows to run custom analyses. See PLUGINS.md.
Merging
hercules combine is the command which joins several analysis results in Protocol Buffers format together.
hercules --burndown --pb https://github.com/go-git/go-git > go-git.pb
hercules --burndown --pb https://github.com/src-d/hercules > hercules.pb
hercules combine go-git.pb hercules.pb | labours -f pb -m burndown-project --resample M
Bad unicode errors
YAML does not support the whole range of Unicode characters and the parser on labours side may raise exceptions. Filter the output from hercules through fix_yaml_unicode.py to discard such offending characters.
hercules --burndown --burndown-people https://github.com/... | python3 fix_yaml_unicode.py | labours -m people
Plotting
These options affects all plots:
labours [--style=white|black] [--backend=] [--size=Y,X]
--style sets the general style of the plot (see labours --help). --background changes the plot background to be either white or black. --backend chooses the Matplotlib backend. --size sets the size of the figure in inches. The default is 12,9.
(required in macOS) you can pin the default Matplotlib backend with
echo "backend: TkAgg" > ~/.matplotlib/matplotlibrc
These options are effective in burndown charts only:
labours [--text-size] [--relative]
--text-size changes the font size, --relative activate the stretched burndown layout.
Custom plotting backend
It is possible to output all the information needed to draw the plots in JSON format. Simply append .json to the output (-o) and you are done. The data format is not fully specified and depends on the Python code which generates it. Each JSON file should contain "type" which reflects the plot kind.
Caveats
- Processing all the commits may fail in some rare cases. If you get an error similar to https://github.com/src-d/hercules/issues/106 please report there and specify
--first-parentas a workaround. - Burndown collection may fail with an Out-Of-Memory error. See the next session for the workarounds.
- Parsing YAML in Python is slow when the number of internal objects is big.
hercules' output for the Linux kernel in "couples" mode is 1.5 GB and takes more than an hour / 180GB RAM to be parsed. However, most of the repositories are parsed within a minute. Try using Protocol Buffers instead (hercules --pbandlabours -f pb). - To speed up yaml parsing
# Debian, Ubuntu apt install libyaml-dev # macOS brew install yaml-cpp libyaml # you might need to re-install pyyaml for changes to make effect pip uninstall pyyaml pip --no-cache-dir install pyyaml
Burndown Out-Of-Memory
If the analyzed repository is big and extensively uses branching, the burndown stats collection may fail with an OOM. You should try the following:
- Read the repo from disk instead of cloning into memory.
- Use
--skip-blacklistto avoid analyzing the unwanted files. It is also possible to constrain the--language. - Use the hibernation feature:
--hibernation-distance 10 --burndown-hibernation-threshold=1000. Play with those two numbers to start hibernating right before the OOM. - Hibernate on disk:
--burndown-hibernation-disk --burndown-hibernation-dir /path. --first-parent, you win.
Roadmap
- Switch from
src-d/go-gittogo-git/go-git. Upgrade the codebase to be compatible with the latest Go version. - Update the docs regarding the copyrights and such.
- Fix the reported bugs.
- Remove the dependency on Babelfish for parsing the code. It is abandoned and a better alternative should be found.
- Remove the ad-hoc analyses added while source{d} was agonizing.
