python / python/cpython

Improve Tachyon UX

Open
#142,927 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

3.15 stdlib topic-profiling type-feature
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

This is a meta issue to group all the items to improve the UX of the tachyon profiler.

Tasks

CLI
  • Standardize timing arguments — Currently mixing µs and seconds for related timing args, which is confusing
  • Duration should default to "until done" - The fact that we sample only for 10 seconds by default is confusing to users and a bad experience
Workflow
  • Auto-open browser with results — Reduce manual steps in the workflow; add --no-browser flag to disable
Flamegraph
  • Hide runner/bootstrap frames by default — Top rows showing interpreter startup aren't useful for most profiling tasks
  • The Gil/gc/exception indicators could be progress bars — this probably will show the information more clearly and take less space
  • Show module names instead of full file paths/home/user/project/pkg/mod.pypkg.mod for readability
  • Show "self" time for functions — Display time spent in function body excluding callees, not just total inclusive time
  • Move hotspots to top of sidebar — This is the most important info; currently buried below logo and stats
  • Fix inverted flamegraph width — Currently shows narrow chart when leaves sum to small percentage, wasting screen space
Pstats
  • Fix docs: -o output format — Docs imply text output but it's actually binary pstats format
  • Standardize --pstats behavior — Output format differs significantly with/without -o flag, which is unexpected

Thanks @dmoisset 🖤

Linked PRs
  • gh-142934
  • gh-142936
  • gh-142987
  • gh-143178
  • gh-143180
  • gh-143337
  • gh-143388
  • gh-144885
  • gh-145329
  • gh-145428
  • gh-146040
  • gh-147706
  • gh-148118
  • gh-148568

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

This is a meta issue for Tachyon profiler UX, and every listed task is marked complete. The issue references linked PRs gh-142934, gh-142936, gh-142987, gh-143178, gh-143180, gh-143337, gh-143388, gh-144885, gh-145329, gh-145428, gh-146040, gh-147706, gh-148118, and gh-148568; no remaining change or validation target is identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, devtools, performance
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
10/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.