Fleshed out README
This commit is contained in:
parent
c9c0625020
commit
3429e648ca
1 changed files with 27 additions and 2 deletions
29
README.md
29
README.md
|
@ -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
|
||||
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!
|
||||
|
||||
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):
|
||||
|
||||
* `git clone https://github.com/tibbe/ekg.git`
|
||||
git clone https://github.com/tibbe/ekg.git
|
||||
|
||||
|
||||
# Authors
|
||||
|
|
Loading…
Reference in a new issue