Skip to content

Commit c1e2911

Browse files
author
Ariel Ben-Yehuda
committed
add decoder implementation
1 parent f532aae commit c1e2911

File tree

7 files changed

+1603
-16
lines changed

7 files changed

+1603
-16
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
/target
2+
/decoder/target

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,6 @@ Then make a new PR for the release and get it approved.
5757

5858
The automated release PR generation functionality is not used here.
5959

60-
This requires a crates.io token in GitHub secrets for the repo. Currently the "token" is literally the string `secret` but I will put a more realistic token once the repo is public.
61-
6260
[conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/
6361

6462
## Code of Conduct

Cargo.lock

Lines changed: 13 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,16 @@ emit `tokio.PollCatchV1` events this way:
8484
}
8585
```
8686

87+
## Decoder
88+
89+
The `decoder` directory in the Git repository contains a decoder that can be used to view JFR files, especially with PollCatch information.
90+
91+
The decoder is NOT intended right now to be used in production. In particular, it uses the [`jfrs`] crate for parsing `.jfr` files, and while that crate seems to be purely safe Rust, to my knowledge it has not been audited for security and probably contains at least denial-of-service issues if not worse.
92+
93+
If you want to use the decoder for anything but debugging on trusted `.jfr` files, you bear full responsibility for the consequences.
94+
95+
[`jfrs`]: https://docs.rs/jfrs
96+
8797
## Security
8898

8999
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

0 commit comments

Comments
 (0)