https://github.com/ocharles/prometheus-effect

Yet another Haskell Prometheus client
https://github.com/ocharles/prometheus-effect

haskell instrumentation metrics monitoring prometheus

Last synced: 15 days ago
JSON representation

Yet another Haskell Prometheus client

• Host: GitHub
• URL: https://github.com/ocharles/prometheus-effect
• Owner: ocharles
• License: bsd-3-clause
• Created: 2017-01-31T14:02:22.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-08T17:32:01.000Z (almost 7 years ago)
• Last Synced: 2024-04-27T01:21:14.133Z (6 months ago)
• Topics: haskell, instrumentation, metrics, monitoring, prometheus
• Language: Haskell
• Homepage: https://hackage.haskell.org/package/prometheus-effect
• Size: 44.9 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[Prometheus](https://prometheus.io) is an open-source systems monitoring and

alerting toolkit originally built at SoundCloud. Since its inception in 2012,

many companies and organizations have adopted Prometheus, and the project has a

very active developer and user community. It is now a standalone open source

project and maintained independently of any company. To emphasize this and

clarify the project's governance structure, Prometheus joined the Cloud Native

Computing Foundation in 2016 as the second hosted project after Kubernetes.

This library provides a Haskell client to Prometheus. It supports:

* The metric types __counter__, __gauge__ and __histogram__.

* Publishing metrics over HTTP (via WAI middleware).

* Pushing metrics to the Prometheus push gateway.

* Labels, along with dynamic labels.

* Instrumentation, both for internal Prometheus monitoring and GHC statistics.

The library is intended to be easy to use, because instrumentation is already

boring enough - the last thing you want is to be 5 pages deep in obscure GHC

extensions just to bump a counter!

Here's one example to demonstrate how you could use this library:

```haskell

{-# LANGUAGE OverloadedStrings #-}

{-# LANGUAGE RecordWildCards #-}

import Control.Concurrent

import Control.Monad

import Network.HTTP.Types.Status

import Prometheus

import System.Random

import qualified Network.Wai as Wai

import qualified Network.Wai.Handler.Warp as Warp

data Metrics = Metrics

  { iterations :: Counter

  , timePerLoop :: Histogram

  }

main :: IO ()

main = do

  (metrics, registry) <- buildRegistry $ do

    iterations <- register "iterations" "Total completed iterations" mempty counter

    timePerLoop <- register "time_per_loop" "Distribution of time per loop" mempty (histogram ioDurationBuckets)

    return Metrics{..}

  forkIO $ Warp.run 8000 $ publishRegistryMiddleware ["metrics"] registry $ \req mkRes ->

    mkRes (Wai.responseLBS notFound404 mempty mempty)

  forever $ time (timePerLoop metrics) $ do

    threadDelay =<< randomIO

    incCounter (iterations metrics)

```