Skip to content

Commit

Permalink
Fleshed out README
Browse files Browse the repository at this point in the history
  • Loading branch information
tibbe committed Dec 28, 2011
1 parent c9c0625 commit 3429e64
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -4,14 +4,39 @@ This library lets you remotely monitor a running process over HTTP.
It provides a simple way to integrate a monitoring server into any It provides a simple way to integrate a monitoring server into any
application. 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.

# 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! # Get involved!


Please report bugs via the Please report bugs via the
[GitHub issue tracker](http://github.com/tibbe/ekg/issues). [GitHub issue tracker](https://github.com/tibbe/ekg/issues).


Master [git repository](https://github.com/tibbe/ekg): Master [git repository](https://github.com/tibbe/ekg):


* `git clone https://github.com/tibbe/ekg.git` git clone https://github.com/tibbe/ekg.git




# Authors # Authors
Expand Down

0 comments on commit 3429e64

Please sign in to comment.