https://github.com/haskell-github-trust/ekg

Remote monitoring of running processes over HTTP
https://github.com/haskell-github-trust/ekg

Last synced: 4 days ago
JSON representation

Remote monitoring of running processes over HTTP

• Host: GitHub
• URL: https://github.com/haskell-github-trust/ekg
• Owner: haskell-github-trust
• License: bsd-3-clause
• Created: 2011-12-16T13:20:18.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T13:07:58.000Z (6 months ago)
• Last Synced: 2024-10-15T09:06:09.952Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 449 KB
• Stars: 255
• Watchers: 10
• Forks: 70
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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://github.com/l0negamer/ekg/actions/workflows/haskell-ci.yml/badge.svg)](https://github.com/l0negamer/ekg/actions/workflows/haskell-ci.yml)

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/l0negamer/ekg/issues).

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

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