Skip to content

Commit

Permalink
add a note in the doc about Prometheus metrics availability
Browse files Browse the repository at this point in the history
  • Loading branch information
kermitt2 committed Jun 7, 2021
1 parent 06f2679 commit cdc33ff
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/Grobid-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ You can check whether the service is up and running by opening the following URL
The service provides also an admin console, reachable at <http://yourhost:8071> where some additional checks like ping, metrics, hearthbeat are available.
We recommend, in particular to have a look at the metrics (using the [Metric library](https://metrics.dropwizard.io/3.1.0/getting-started/)) which are providing the rate of execution as well as the throughput of each entry point.

In addition, [Prometheus](https://prometheus.io/) format export metrics are available at <http://yourhost:8071/metrics/prometheus>.

## Configure the server

If required, modify the file under `grobid/grobid-service/config/config.yaml` for starting the server on a different port or if you need to change the absolute path to your `grobid-home` (e.g. when running on production). By default `grobid-home` is located under `grobid/grobid-home`. `grobid-home` contains all the models and static resources required to run GROBID.
Expand Down

0 comments on commit cdc33ff

Please sign in to comment.