1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
|
# EKG: Remote monitoring of running processes over HTTP [![Hackage version](https://img.shields.io/hackage/v/ekg.svg?label=Hackage)](https://hackage.haskell.org/package/ekg) [![Build Status](https://secure.travis-ci.org/tibbe/ekg.svg?branch=master)](http://travis-ci.org/tibbe/ekg)
This library lets you remotely monitor a running process over HTTP.
It provides a simple way to integrate a monitoring server into any
application.
# Getting started
Adding monitoring to your application is simple. Just launch the
monitoring server as soon as your application starts
import System.Remote.Monitoring
main = do
forkServer "localhost" 8000
...
and then visit [http://localhost:8000/](http://localhost:8000/) in
your web browser.
To make full use out of this module you must first enable GC
statistics collection in the run-time system. To enable GC
statistics collection, either run your program with
> +RTS -T
or compile it with
> -with-rtsopts=-T
The runtime overhead of `-T` is very small so it's safe to always
leave it enabled.
# JSON API
The monitoring server also lets you to retrieve the stats as JSON.
Simply send the server an HTTP GET request with the Accept header set
to "application/json":
curl -H "Accept: application/json" http://localhost:8000/
You can use the JSON API to e.g. write applications that monitor other
applications.
# Get involved!
Please report bugs via the
[GitHub issue tracker](https://github.com/tibbe/ekg/issues).
Master [git repository](https://github.com/tibbe/ekg):
git clone https://github.com/tibbe/ekg.git
# Authors
This library is written and maintained by Johan Tibell,
<johan.tibell@gmail.com>.
|