Skip to content

Commit eb1ed5c

Browse files
committed
update readme
1 parent 41d8bd7 commit eb1ed5c

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
1-
# StackGazer
1+
# Stackgazer
22

33
An interactive tool for analyzing Go stack trace dumps (goroutine profiles).
44

5-
It is designed to make browsing profiles containing larger numbers of goroutines easier, particularly when analyzing a collection of many profiles captured from separate but related processes in a distributed system or service like CockroachDB.
5+
Stackgazer designed to make browsing and searching profiles containing larger numbers of goroutines easier, particularly when analyzing a collection of many profiles captured from separate but related processes in a distributed system or service e.g. CockroachDB.
66

7-
[**Live Demo**](https://davidt.io/stackgazer)
7+
[**⚡ Live Demo**](https://davidt.io/stackgazer)
8+
9+
![StackGazer Screenshot](examples/screenshot.png)
810

911
## Features
1012

1113
- **Responsive, Quick Filtering**: Rapidly filter stacks by keywords or attributes.
1214
- **Customizable Categorization**: Hierarchical organization of related and identical stacks for faster browsing, using configurable rules to determine groups and useful and informative names.
13-
- **Interactive Navigation**: Navigate between creator/created goroutines with clickable links with previews.
14-
- **Multi-process/multi-file Analysis**: Combines and groups stack traces captured from multiple processes/nodes in a distributed system. Files can be added individually or en-masse via zip file.
15+
- **Interactive Navigation**: Navigate between creator/created goroutines with clickable links with previews, or browse in a zoomable tree.
16+
- **Multi-process/multi-file Analysis**: Combines and groups stack traces captured from multiple processes/nodes in a distributed system. Files can be added individually or en-masse via zip file.
17+
- Customizable rules can name files based on labels or extracting arguments from debug=2 stack frames (e.g. if you expect a stack to have a server.start() frame which includes a serverID as an argument, you can use a pattern to extract that ID to use as the file name).
1518
- **Multiple Display Modes**: Different viewing options for stack traces and goroutines.
19+
- **Support Multiple Formats**: supports all three goroutine profile formats: debug=2 (aka backtace), debug=1 (text with labels), and debug=0 (compressed pprof proto).
1620
- **Local analysis**: Everything is processed locally in the browser; nothing is uploaded.
1721
- **Customizable Settings**: Behavior can be customized through locally stored settings with configurable defaults
1822

examples/screenshot.png

960 KB
Loading

0 commit comments

Comments
 (0)