Skip to main content

Generate flamecharts and error graphs from python stacktraces

Project description

pystackflame

Generate flamecharts from Python stacktraces in logs

pystackflame is a command-line tool that parses Python logs for stack traces and turns them into flamecharts or weighed graphs for performance analysis, visualization, and debugging.


Features

  • Generate FlameGraph-compatible output
  • Pickle json graphs
  • Build weighted execution graphs from logs and saves them in json format.
  • Python 3.14+ support
  • Fast and lightweight CLI built with click
  • Developer-friendly with optional linting via ruff

Installation

We recommend using uv for fast dependency management:

uv sync -p 3.14
source .venv/bin/activate
pystackflame --help

Possible applications

Web Service Error Hotspots

Aggregate Python exceptions in your web server (e.g. Flask/FastAPI/Django) logs to quickly pinpoint which request-handling paths are failing most often without any need of restarting your application.

pystackflame flame /var/log/myapp/**/*.log -o web_errors.flame

Analysis of the historical data

Identify problematic places in the codebase that require the most attention.

pystackflame flame /var/log/all_logs_we_have/**/*.log -o errors.flame
./flamegraph.pl errors.flame > example.svg

Performance Regression Detection in CI

As part of your GitHub Actions or GitLab CI pipeline, run against the previous and current test logs to compare flamecharts—spot new slow-paths introduced by recent commits.

pystackflame flame old_tests.log -o baseline.flame
pystackflame flame new_tests.log -o current.flame

Visualize of diff the two SVGs or flame files to analyze regressions

Batch-Job Profiling

For long-running data-processing jobs (ETL, ML training, batch analytics), collect stacktraces on failure or periodically dump traces, then visualize the cumulative “hot” stacks to optimize slow stages.

pystackflame flame /logs/batch_job_*.log -o batch_profile.flame

Chaos-Engineering Fault Analysis

During fault-injection experiments, collect and compare flamecharts from healthy vs. faulted runs to understand how injected errors propagate.

pystackflame flame healthy.log -o healthy.flame
pystackflame flame chaos.log   -o chaos.flame

Advanced filtering

You can specify an option --trace-filter / -tf [PATH_PREFIX] to filter tracebacks to include only those paths that start with the given prefix and filter out the prefix out from the output. This is useful to restrict the flamechart or graph output to only relevant code paths with relevant names.

Additionally, you can specify multiple --exclude / -e [PATH_PREFIX] to exclude traces that starts from the given path prefix. Wildcard is supported as well.

Example

This command

pystackflame flame ~/test.log -tf '/opt/app/venv/lib64/python3.9/site-packages' 

Will produce the following flame data output

package;database;session.py;wrapper 2
package;apihelper.py;_make_request 2
package;apihelper.py;_check_result 2

And this command

pystackflame flame ~/test.log

Will give you this

/;opt;app;venv;lib64;python3.9;site-packages;package;database;session.py;wrapper 2
/;opt;app;venv;lib64;python3.9;site-packages;package;apihelper.py;_make_request 2
/;opt;app;venv;lib64;python3.9;site-packages;package;apihelper.py;_check_result 2

However, this command

pystackflame flame ~/test.log -tf '/opt/app/venv/lib64/python3.9/site-packages/package/apihelper.py' 

Will produce the following output

_make_request 2
_check_result 2

Usage

  • The filter must start with / (absolute path).
  • * can be used to match any folder (e.g., /var/log/app-logs/dates/*/application).
  • The filter must not end with /.

Result:

  • Only stack trace frames that match the filter will be added to the flamechart or graph.
  • Useful for narrowing down logs to project-specific code or a specific dependency tree.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pystackflame-0.1.4.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pystackflame-0.1.4-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file pystackflame-0.1.4.tar.gz.

File metadata

  • Download URL: pystackflame-0.1.4.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for pystackflame-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ba821f51feb137ef0c135066f101cc538d453ebb4a66e1ad0e2aea88bee73607
MD5 1087f69ae7b95d61a056cb645e4cf427
BLAKE2b-256 7316b4dfa2124b2a346d7893a0f17e00484ebbd6bdac88a3faabd72d9fb422c6

See more details on using hashes here.

File details

Details for the file pystackflame-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pystackflame-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d77f2e40bd1898b39da50ef82aeccb692791b56756388c4450f6586179f92e73
MD5 2115b79b36fb3e9adaad4dc8f10da361
BLAKE2b-256 83d0bdce0e7e567fa2e1d2fa9906c95ed74bf6045abd0fb8ed349ea9c492d7f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page