From d5aa78a717c89f9588b81ba01cec0dd6655375a2 Mon Sep 17 00:00:00 2001 From: dmaiocchi Date: Thu, 24 Sep 2020 19:10:26 +0200 Subject: [PATCH] API --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 081d1a9..82d3f46 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,10 @@ # Rationale The alert handler serve as central component for building reactive self-healing systems, based on Prometheus. - It is meant to be a single binary, which will be distribued and installed to all nodes of clusters. -The routing itself is delegated to alertmanager of prometheus. +The routing itself is delegated to alertmanager of Prometheus. It is main functionality is to `selfheal` and handle Prometheus alerts automatically, which are fired by Prometheus. +The alert-handler share a common declarative API with the alertmanager (based on labels) which need to be respected by users. See [API](doc/api.md) # Devel