The ekg package

[Tags:bsd3, library]

This library lets you remotely monitor a running process over HTTP. It provides a simple way to integrate a monitoring server into any application.

[Skip to Readme]

Properties

Versions	0.1.0.0, 0.2.0.0, 0.3.0.0, 0.3.0.1, 0.3.0.2, 0.3.0.3, 0.3.0.4, 0.3.0.5, 0.3.1.0, 0.3.1.1, 0.3.1.2, 0.3.1.3, 0.3.1.4, 0.4.0.0, 0.4.0.1, 0.4.0.2, 0.4.0.3, 0.4.0.4, 0.4.0.5, 0.4.0.6, 0.4.0.7, 0.4.0.8, 0.4.0.9, 0.4.0.10, 0.4.0.11, 0.4.0.12, 0.4.0.13
Change log	CHANGES.md
Dependencies	aeson (<1.3), base (>=4.5 && <4.10), bytestring (<1.0), ekg-core (==0.1.), ekg-json (==0.1.), filepath (<1.5), network (<2.7), snap-core (<1.1), snap-server (<1.1), text (<1.3), time (<1.7), transformers (<0.6), unordered-containers (<0.3) [details]
License	BSD3
Author	Johan Tibell
Maintainer	johan.tibell@gmail.com
Category	System, Network
Home page	https://github.com/tibbe/ekg
Bug tracker	https://github.com/tibbe/ekg/issues
Source repository	head: git clone https://github.com/tibbe/ekg.git
Uploaded	Wed Apr 19 00:57:23 UTC 2017 by JohanTibell
Distributions	Debian:0.4.0.8, FreeBSD:0.4.0.8, LTSHaskell:0.4.0.13, NixOS:0.4.0.13, Stackage:0.4.0.13, Tumbleweed:0.4.0.13
Downloads	12689 total (1291 in the last 30 days)
Votes	4 []
Status	Docs available [build log] Last success reported on 2017-04-19 [all 1 reports] Hackage Matrix CI

Modules

System
- Remote

[Index]

Downloads

ekg-0.4.0.13.tar.gz [browse] (Cabal source package)
Package description (included in the package)

Maintainer's Corner

For package maintainers and hackage trustees

edit package information

Readme for ekg

Readme for ekg-0.4.0.13

EKG: Remote monitoring of running processes over HTTP

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/ 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.

Master git repository:

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

Authors

This library is written and maintained by Johan Tibell, johan.tibell@gmail.com.