Hackage :: [Package]

ekg-wai: Remote monitoring of processes

[ bsd3, library, network, system ] [ Propose Tags ] [ Report a vulnerability ]

This library lets you remotely monitor a running process over HTTP. It provides a simple way to integrate a monitoring server into any application. This is a port of the ekg library to depend on wai instead of snap.

[Skip to Readme]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.1.0
Dependencies aeson, base (>=4.8 && <5), bytestring (<1.0), ekg-core (>=0.1 && <0.2), ekg-json (>=0.1 && <0.2), filepath (<1.5), http-types, network, text, time (<1.10), transformers, unordered-containers, wai, wai-app-static, warp [details]
Tested with ghc ==7.10.3, ghc ==8.0.2, ghc ==8.2.2, ghc ==8.4.1, ghc ==8.8.3
License BSD-3-Clause
Author Timo von Holtz, Johan Tibell
Maintainer tvh@tvholtz.de
Category System, Network
Home page https://github.com/tvh/ekg-wai
Bug tracker https://github.com/tvh/ekg-wai/issues
Source repo head: git clone https://github.com/tvh/ekg-wai.git
Uploaded by TvH at 2022-05-16T08:27:48Z
Distributions
Reverse Dependencies 2 direct, 40 indirect [details]
Downloads 5326 total (109 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2022-05-16 [all 1 reports]

Readme for ekg-wai-0.1.1.0

[back to package description]

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

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/tvh/ekg-wai.git

Authors

This library is maintained by Timo von Holtz, tvh@tvholtz.de. It was originally written using Snap by Johan Tibell, johan.tibell@gmail.com.