https://github.com/serceman/franky

Franky - a simple profiler that always speaks frankly
https://github.com/serceman/franky

Last synced: over 1 year ago
JSON representation

Franky - a simple profiler that always speaks frankly

• Host: GitHub
• URL: https://github.com/serceman/franky
• Owner: SerCeMan
• License: apache-2.0
• Created: 2016-06-11T11:07:25.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-12-11T12:49:52.000Z (over 9 years ago)
• Last Synced: 2025-03-29T22:22:27.375Z (over 1 year ago)
• Language: C++
• Homepage:
• Size: 342 KB
• Stars: 9
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

          
= Franky

image:https://travis-ci.org/SerCeMan/franky.svg?branch=master["Build Status", link="https://travis-ci.org/SerCeMan/franky"]

Franky - a simple profiler that always speaks frankly

== Project Goals

Goal of this project is creating a profiler which

 * Is truthful, because it is built on the top of private JVM API (AsyncGetCallTrace)

 * Can attach to any JVM on the fly

 * Easy to understand because UI is based on famous flame graphs

 * Have a rich integration with IDE with navigation and inspections showing you how to improve your code based on profiling results (actually, Franky is a plugin for IntelliJ IDEA)

== How to

 * View -> Tool Windows -> Franky Profiler

 * Choose JVM and press 'start profiling'

 * Enjoy the result!

image::screenshot.png[]

== Get it

Franky can be installed as a plugin for IntelliJ IDEA from the link:https://plugins.jetbrains.com/plugin/8619[repository]

== Project status

Currently, the project is in the alpha stage. Native code is not highly tested and can cause a crash in some rare cases. Agent binaries available only on a restricted set of platforms.

=== Can I contribute?

Yes! I highly appreciate any contribution! Let's make the profiling great again together! 

== Build it

[source,bash]

----

./gradlew plugin

----

== Supported platforms

Linux x64

== Thanks to

* https://github.com/apangin[@apangin] for his https://github.com/apangin/async-profiler[async-profiler]

* https://github.com/RichardWarburton[@RichardWarburton] for his https://github.com/RichardWarburton/honest-profiler[honest-profiler]

* https://github.com/nitsanw[@nitsanw] for his awesome talks and the article about http://psy-lob-saw.blogspot.ru/2016/06/the-pros-and-cons-of-agct.html[AsyncGetCallTrace profiling]