Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterPaul-Perfana committed Sep 29, 2023
1 parent c3c86d1 commit 6830d49
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# JfrExporter

Send JFR events to time series databases.
Send JFR events to time series databases.

Makes use of [JFR Event Streaming](https://openjdk.org/jeps/349) as found in hotspot based JDK 14+.

Now in "beta", feedback welcome! The events and stack traces need accuracy checks.
More events can be added. Only InfluxDB time series database is supported
at the moment.

The metrics can be used in a Grafana dashboard.

Shows CPU, Heap, Threads and Memory Allocation Rate:
Expand All @@ -15,8 +19,7 @@ Shows Garbage Collection events:
Shows Safepoints and Big Allocations:
![dashboard overview 3](https://github.com/perfana/jfr-exporter/blob/main/images/dashboard-3.jpg)

And shows the stacktrace of a big allocations:
![stacktrace example 1](https://github.com/perfana/jfr-exporter/blob/main/images/stacktrace-1.jpg)
And shows the stacktrace of a big allocations (see screenshot below)

## Steps

Expand All @@ -31,6 +34,8 @@ To use JfrExporter:

## Download

Direct [download version 0.0.1](https://github.com/perfana/jfr-exporter/releases/download/0.0.1/jfr-exporter-0.0.1.jar)

Download the latest release from the [releases page](https://github.com/perfana/jfr-exporter/releases).

## Agent
Expand Down Expand Up @@ -90,6 +95,14 @@ Currently a subset of JFR events are processed.

For reference: [list of JFR events](https://bestsolution-at.github.io/jfr-doc/index.html).

## Stacktraces

Stack trace for big allocations are sent to InfuxDB.
Via the dashboard you can see the details by clicking in the big allocations table.

Example:
![stacktrace example 1](https://github.com/perfana/jfr-exporter/blob/main/images/stacktrace-1.jpg)

## Dashboard

A Grafana dashboard can be imported to view the JFR metrics.
Expand Down

0 comments on commit 6830d49

Please sign in to comment.