Skip to content

Commit

Permalink
[#6]: Update readme (#8)
Browse files Browse the repository at this point in the history
doc: add note how to define "custom" metrics

That's quite trivial, but might not be obvious, so it worse to note that.
  • Loading branch information
worm2fed authored Dec 15, 2023
1 parent af99252 commit 61ed2d6
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,17 @@

# Servant Performance Counters

This package lets you track performance counters for each of your Servant endpoints using Prometheus.
This package lets you track performance counters for each of your Servant endpoints using [Prometheus](https://prometheus.io/).

# Usage

Servant-Prometheus knows how to handle all official Servant combinators out of the box.
`servant-prometheus` knows how to handle all official Servant combinators out of the box.

## Instrumenting your API
To use Servant-Prometheus, you'll need to wrap your WAI application with the Servant-Prometheus middleware.

```
To use `servant-prometheus`, you'll need to wrap your WAI application with the provided middleware.

```haskell
import Network.Wai.Handler.Warp
import Prometheus.Servant

Expand All @@ -27,7 +28,14 @@ main = do
run 8080 app
```

## Custom metrics

Note, that in example above `defaultMetrics` used, which actually provided as an example and good starting point.
If you want to use your custom metrics (eg you want another labels), you'll need to define an implementation for `Metrics mLatencyLabel mActiveLabel` data.
That's not hard, just copy-paste and tweak accordingly to your needs.

## Runtime overhead

Instrumenting your API introduces a non-zero runtime overhead, on the order of 200 - 600 µsec depending upon your machine. It's a good idea to run the benchmarks on your intended production platform to get an idea of how large the overhead will be. You'll need to have `wrk` installed to run the benchmarks.

In general, the runtime overhead should be effectively negligible if your handlers are issuing network requests, such as to databases. If you have handlers that are small, CPU-only, and requested frequently, you will see a performance hit from `servant-prometheus`.

0 comments on commit 61ed2d6

Please sign in to comment.