From ea8dcc29f8eb0a7a75973fa86216f9e80f146689 Mon Sep 17 00:00:00 2001 From: Sandro Heinzelmann Date: Sat, 29 Dec 2018 11:08:38 +0100 Subject: [PATCH] Add motivation --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 55d0443..4d75d1d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,14 @@ prom_rest_exporter translates arbitrary REST endpoints to metrics for [Prometheu It uses the excellent [jq](https://github.com/stedolan/jq) to transform JSON responses to numeric metric values. -prom_rest_exporter runs as a process exposing one or more `/metrics` endpoints for Prometheus. +prom_rest_exporter runs as a separate process exposing one or more `/metrics` endpoints for Prometheus. + +## Motivation + +Sometimes you want to monitor third-party applications that do not provide Prometheus-compatible metrics. +If they provide other REST endpoints with valuable monitoring information, you can use prom_rest_exporter to make these available to Prometheus. + +**Note**: if possible, it's preferable to adapt the application to provide Prometheus metrics directly. This avoids operational complexity of running prom_rest_exporter in addition to the application. ## Installation