Skip to content
This repository has been archived by the owner on Jan 12, 2024. It is now read-only.

Commit

Permalink
Fix to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
stijndehaes committed Jun 24, 2017
1 parent 1fe4b6c commit a7a2cca
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
#Play prometheus play.prometheus.filters
# Play prometheus play.prometheus.filters

This play library provides three types of filters that collect prometheus metrics.

##The filters
## The filters

####Request counter
### Request counter
This filter counts all the requests in your application and adds a label for the status

####Latency filter
### Latency filter
This filter collects the latency of all requests

####Route Action Method Latency Filter
### Route Action Method Latency Filter
This filter collects the latency for all requests and adds a label call RouteActionMethod.
This action method is the method name of the method you provided your routes file.
This filter makes it possible to measure the latency for all your routes.
Expand All @@ -23,7 +23,7 @@ GET /metrics play.prometheus.controllers.PrometheusController.g

The RouteActionMethod for the above example would be getMetrics

##How to enable the filters
## How to enable the filters
See the [documentation of play](https://www.playframework.com/documentation/2.5.x/ScalaHttpFilters#Using-filters)

You should make a filters class:
Expand All @@ -46,7 +46,7 @@ And the enable this filter in the application.conf
play.http.filters=com.example.MyFilters
```

##Prometheus controller
## Prometheus controller
The project also provides a prometheus controller with a get metric method. If you add the following to your routes file:

```
Expand Down

0 comments on commit a7a2cca

Please sign in to comment.