Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arl committed Oct 7, 2023
1 parent 5854e23 commit 404f53b
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,17 @@ Visualize real time plots of your Go program runtime metrics, including heap, ob
<hr>

- [Statsviz](#statsviz)
- [Install](#install)
- [Usage](#usage)
- [Advanced Usage](#advanced-usage)
- [How does that work?](#how-does-that-work)
- [Documentation](#documentation)
- [Go API](#go-api)
- [User interface](#user-interface)
- [Plots](#plots)
- [User Plots](#user-plots)
- [Examples](#examples)
- [Questions / Troubleshooting](#questions--troubleshooting)
- [Updating from pre-v1 to v1](#updating-from-pre-v1-to-v1)
- [Contributing](#contributing)
- [Changelog](#changelog)
- [License](#license)
Expand Down Expand Up @@ -173,6 +175,14 @@ Depending on your go version, some plots may not be available.

<img width="50%" alt="cgo" src="https://github.com/arl/statsviz/raw/readme-docs/runtime-metrics/cgo.png">


### User Plots

Since `v0.6` you can add your own plots to Statsviz dashboard, in order to easily
visualize your application metrics next to runtime metrics.

Please see the [userplots example](_example/userplots/main.go).

## Examples

Check out the [\_example](./_example/README.md) directory to see various ways to use Statsviz, such as:
Expand Down

0 comments on commit 404f53b

Please sign in to comment.