Pluggable Flame Graphs for Clojure.
It's easier than you think. Get the newest release. Require the flames.core namespace and start the profiler.
(require '[flames.core :as flames])
(def flames (flames/start! {:port 54321, :host "localhost"}))Wait 5 seconds and check out http://localhost:54321/flames.svg.
When you're done stop the profiler by invoking:
(flames/stop! flames)or
(.close flames)clojure.core/with-open works too.
flames.core/start! accepts a map of following options:
:host– host to which the HTTP server will bind,:port– port on which the HTTP server will listen,:dt– number of seconds of profiling between updates of the flame graph,:load– target fraction of one core's CPU time to use for profiling.
Find more information about :dt and :load options as well as principles of
operation of the profiler in README of riemann-jvm-profiler.
Contents of the flame graph can be filtered using regular expressions passed
in filter and remove query params.
GET /flames.svg?remove=%28socketRead|epollWait|socketAccept|readBytes%29
GET /flames.svg?filter=flames.core
Some convenience functions are supplied in the flames.repl ns.
user> (require '[flames.repl :as fr)
Warning: protocol #'clj-radix/IRadixTree is overwriting function update
WARNING: update already refers to: #'clojure.core/update in namespace: clj-radix, being replaced by: #'clj-radix/update
nil
user> (fr/flames-start!)
View flames graph at http://localhost:54321/flames.svg
In case of error consult the output of (doctor)
nil
user> (fr/flames-stop!)
nilThere is support for opening the resultant svg in a suitable app, either by delegating to xdg with {:open-method :xdg-open} or letting the JVM open a platform browser via {:open-method :browse}
user> (fr/flames-start!)
View flames graph at http://localhost:54321/flames.svg
In case of error consult the output of (doctor)
nil
user> (fr/flames-stop! {:open-method :xdg-open})
opening file:/tmp/flames8445716098061321230.svg using :xdg-open
Opening in existing browser session.
nil
The flames graph output can be manipulated by passing a regex :remove or :filter argument, where remove and filter are analogous to clojure remove and filter
user> (fr/flames-start! {:remove #"nrepl.bencode"})
View flames graph at http://localhost:54321/flames.svg?remove=nrepl.bencode
user> (fr/flames-start! {:filter #"(myapp|another-app)"})
View flames graph at http://localhost:54321/flames.svg?filter=%28myapp%7Canother-app%29
There are some external application dependencies. The (doctor) fn checks they are available.
user> (fr/doctor) ;; Checks system dependencies
{:perl "5.034001", :riemann "0.3.6"}
;; When riemann jvm profiler not found
user> (doctor)
{:perl "5.034001",
:riemann
"Cannot run program \"riemann\": error=2, No such file or directory"}
user>
Completely experimental.
Copyright © 2015 Jan Stępień
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.