Skip to main content

git-stacktrace

git-stacktrace is a tool to help you associate git commits with stacktraces.

It helps you identify related commits by looking at:

  • commits in given range that touched files present in the stacktrace

  • commits in given range that added/removed code present in the stacktrace

Supported Languages

Development

Run tests with: tox

Installation

$ pip install git_stacktrace

Usage

Run git stacktrace within a git initialized directory.

usage: git stacktrace [<options>] [<RANGE>] < stacktrace from stdin

Lookup commits related to a given stacktrace.

positional arguments:
  range                 git commit range to use

optional arguments:
  -h, --help            show this help message and exit
  --since <date1>       show commits more recent than a specific date (from
                        git-log)
  --server              start a webserver to visually interact with git-
                        stacktrace
  --port PORT           Server port
  -f, --fast            Speed things up by not running pickaxe if the file for
                        a line of code cannot be found
  -b [BRANCH], --branch [BRANCH]
                        Git branch. If using --since, use this to specify
                        which branch to run since on. Runs on current branch
                        by default
  --version             show program's version number and exit
  -d, --debug           Enable debug logging

For the Python API see: git_stacktrace/api.py

To run as a web server: git stacktrace --server --port=8080 or GIT_STACKTRACE_PORT=8080 git stacktrace --server

Use the web server as an API:

$ curl \
  -d '{"option-type":"by-date", "since":"1.day", "trace":"..."}' \
  -H "Content-Type: application/json" \
  -X POST http://localhost:8080/

Examples

Example output:

$ git stacktrace --since=1.day < trace
Traceback (most recent call last):
 File "webapp/framework/resource.py", line 72, in _call
   result = getattr(self, method_name)()
 File "webapp/resources/interests_resource.py", line 232, in get
   if self.options['from_navigate'] == "true":
KeyError


commit da39a3ee5e6b4b0d3255bfef95601890afd80709
Commit Date: Tue, 19 Jul 2016 14:18:08 -0700
Author:      John Doe <johndoe@pinterest.com>
Subject:     break interest resource
Link:        https://example.com/D1000
Files Modified:
   - webapp/resources/interests_resource.py:232
Lines Added:
   - "if self.options['from_navigate'] == "true":"

Change Log

1.0.0

0.9.0

0.8.1

  • Add several missing rare git file states (T, U, X)

0.8.0

  • Fix pickaxe support for python3

  • Improve java traceback support

  • Improve the python api

0.7.2

0.7.1

0.7.0

  • Add python 3 support

0.6.0

  • Support arbitrary sized abbreviated hashes

  • Clarify CLI help message

0.5.0

  • Match file line numbers in stacktrace to lines changed in commits

  • Differentiate files added, deleted and modified

  • print stacktrace headers and footers

  • Fix git pickaxe error (Use ‘–’ to separate paths from revisions)

  • Add initial java stacktrace support. Begin supporting basic java stacktraces, some more complex formats are not supported yet.

0.4.1

  • Get ready for pypi

0.4.0

  • Initial open source commit

Metadata

Release files for git-stacktrace 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for git-stacktrace 1.0.0
File Size Uploaded
git-stacktrace-1.0.0.tar.gz 34.8 kB Details

Release files / git-stacktrace-1.0.0.tar.gz

Download URL git-stacktrace-1.0.0.tar.gz
Size 34.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0100ce8d507991a9fa732d4bcc533aab7438730367e43f7ce78f10bffa059b47
BLAKE2b-256 checksum
How to use checksums
77d75ce538dc17bb2ee3ee91f63bd6078722883db18b9aa56d0d62fc49cc9652
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.4

Release history Release notifications | RSS feed

This release

1.0.0 This release

1 release file

0.9.0

1 release file

0.8.1

1 release file

0.8.0

1 release file

0.7.2

1 release file

0.7.1

1 release file

0.7.0

1 release file

0.6.0

1 release file

0.5.0

1 release file

0.4.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page