dhat-to-flamegraph 2.0.0

Convert dhat JSON output to a flamegraph
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

<h1 align="center">dhat-to-flamegraph</h1>
<div align="center">
  <strong>
    Convert dhat JSON output to a flamegraph
  </strong>
</div>

<br />

<div align="center">
  <!-- Crates version -->
  <a href="https://crates.io/crates/dhat-to-flamegraph">
    <img src="https://img.shields.io/crates/v/dhat-to-flamegraph.svg?style=flat-square"
    alt="Crates.io version" />
  </a>
  <!-- Downloads -->
  <a href="https://crates.io/crates/dhat-to-flamegraph">
    <img src="https://img.shields.io/crates/d/dhat-to-flamegraph.svg?style=flat-square"
      alt="Download" />
  </a>
  <!-- docs.rs docs -->
  <a href="https://docs.rs/dhat-to-flamegraph">
    <img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
      alt="docs.rs docs" />
  </a>
</div>

<div align="center">
  <h3>
    <a href="https://docs.rs/dhat-to-flamegraph">
      API Docs
    </a>
    <span> | </span>
    <a href="https://github.com/yoshuawuyts/dhat-to-flamegraph/releases">
      Releases
    </a>
    <span> | </span>
    <a href="https://github.com/yoshuawuyts/dhat-to-flamegraph/blob/master.github/CONTRIBUTING.md">
      Contributing
    </a>
  </h3>
</div>

## Installation
```sh
$ cargo install dhat-to-flamegraph
```

## Usage

```text
Convert dhat JSON output to a flamegraph

Usage: dhat-to-flamegraph [OPTIONS] <INPUT>

Arguments:
  <INPUT>
          The dhat JSON file to process

Options:
  -o, --output <OUTPUT>
          Where to place the output
          
          If not provided then stdout is used.

  -f, --format <FORMAT>
          Which output format to use

          Possible values:
          - svg:    Format as svg (default)
          - folded: Format as folded stack traces

  -h, --help
          Print help (see a summary with '-h')
```

Usage example:

```bash
dhat-to-flamegraph fixtures/dhat-heap.json > out.svg
open out.svg
```

## See Also

- [nnethercote/dhat-rs](https://github.com/nnethercote/dhat-rs)

## Safety
This crate uses ``#![deny(unsafe_code)]`` to ensure everything is implemented in
100% Safe Rust.

## Contributing
Want to join us? Check out our ["Contributing" guide][contributing] and take a
look at some of these issues:

- [Issues labeled "good first issue"][good-first-issue]
- [Issues labeled "help wanted"][help-wanted]

[contributing]: https://github.com/yoshuawuyts/dhat-to-flamegraph/blob/master.github/CONTRIBUTING.md
[good-first-issue]: https://github.com/yoshuawuyts/dhat-to-flamegraph/labels/good%20first%20issue
[help-wanted]: https://github.com/yoshuawuyts/dhat-to-flamegraph/labels/help%20wanted

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version
2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>

<br/>

<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.
</sub>