Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kornilova203 committed Apr 11, 2020
1 parent 1b6cc90 commit 46539b2
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,13 @@

[![Build Status](https://travis-ci.org/kornilova203/FlameViewer.svg?branch=master)](https://travis-ci.org/kornilova203/FlameViewer)

## Download Plugin
https://plugins.jetbrains.com/plugin/10305-flameviewer
## Install Plugin

* Standalone command-line tool [FlameViewer-1.0.jar](https://github.com/kornilova203/FlameViewer/releases/tag/v1.0)
```
java -jar FlameViewer-1.0.jar path/to/my_app.jfr
```
* Plugin for JetBrains IDEs: https://plugins.jetbrains.com/plugin/10305-flameviewer

## Table of contents
* [Uploading file to FlameViewer](#uploading-file-to-flameviewer)
Expand All @@ -17,11 +22,10 @@ https://plugins.jetbrains.com/plugin/10305-flameviewer
* [Hot Spots](#hot-spots)
* [Call Tree](#call-tree)
* [Detailed View of Thread](#detailed-view-of-thread)
* [Contribution](#contribution)
* [Building from sources](#building-from-sources)

## Uploading file to FlameViewer
1. Click <strong>Tools | Open FlameViewer...</strong>
1. Click **Tools | Open FlameViewer...**
2. Upload a file of a supported profiler:
1. _jfr_ files generated by Flight Recorder
2. Yourkit _csv_ files. To generate csv file from a snapshot run following script: `java -jar -Dexport.call.tree.cpu -Dexport.csv /lib/yjp.jar -export ~/Snapshots/.snapshot`
Expand All @@ -30,7 +34,7 @@ https://plugins.jetbrains.com/plugin/10305-flameviewer

## Java performance recording. Quick start
Use Flight Recorder to profile your program and then open FlameViewer:
1. Make sure that you are using Oracle JDK (not OpenJDK) because Java Mission Control comes only with Oracle JDK. To do it open **File | Project Structure... | Project** then click **Edit** beside **Project SDK**, look at **JDK home path** it should be something like this: `.../jdk1.8.0_162` **not** like this: `.../java-8-openjdk-amd64`. You can download needed version from Oracle website: [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html), [JDK 9](http://www.oracle.com/technetwork/java/javase/downloads/jdk9-downloads-3848520.html)
1. Make sure you are using Oracle JDK (not OpenJDK) because Java Mission Control comes only with Oracle JDK. To do it open **File | Project Structure... | Project** then click **Edit** beside **Project SDK**, look at **JDK home path** it should be something like this: `.../jdk1.8.0_162` **not** like this: `.../java-8-openjdk-amd64`. You can download needed version from Oracle website: [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html), [JDK 9](http://www.oracle.com/technetwork/java/javase/downloads/jdk9-downloads-3848520.html)
2. Run JVM with following VM options: `-XX:+UnlockCommercialFeatures -XX:+FlightRecorder -XX:StartFlightRecording=duration=30s,filename=my_recording.jfr -XX:FlightRecorderOptions=stackdepth=256`
3. Open FlameViewer **Tools | Open FlameViewer...**
4. Upload my_recording.jfr
Expand Down Expand Up @@ -87,11 +91,6 @@ On this page you can see what was happening inside some thread. All method calls
You can see popup with detailed information about method if you place the cursor on the method (also there are parameters and return value if they were saved).
![](screenshots/thread.png)

## Contribution
If you would like to contribute please ping me on telegram @lkornilova, there are plenty of tasks to do :)

If you have a suggestions or found a bug [open an issue]

## Building from sources
If only want to use plugin then you should simply install ready-to-use [jar](https://plugins.jetbrains.com/plugin/10305-flamegraph-profiler).

Expand Down

0 comments on commit 46539b2

Please sign in to comment.