Skip to content

Commit

Permalink
Document Prometheus in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
geertw committed Jun 28, 2022
1 parent 3916ff7 commit acb42d0
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,12 @@ The archive function allows you to store all data to an archive for further
processing or analysis at a later time. When running `gotrain archiver`,
GoTrain simply pushes all received services to a Redis queue (in JSON format).

Prometheus
----------

A [Prometheus](https://prometheus.io/) integration is included to expose metrics about recieved messages
and API requests. This integration can be enabled optionally on a separate port.

Installation
------------

Expand Down Expand Up @@ -180,7 +186,6 @@ The main objectives for GoTrain have now been developed, but there is a roadmap
for further development. The main planned improvements are:

* Increase test coverage - the API is currently not tested
* Better monitoring tools - analyze the data streams, monitor for errors, etc.
* Packaging - make it easier to install gotrain on a server by just downloading
and installing the binaries

Expand Down

0 comments on commit acb42d0

Please sign in to comment.