From fcdef9ce644cd8eaae54db3dab3a3249f84dad43 Mon Sep 17 00:00:00 2001 From: Paul Traylor Date: Mon, 6 Nov 2023 10:50:44 +0900 Subject: [PATCH] Update terms in documentation Some of these terms have not been updated in a while and need to be updated to show the current relationship between them. --- docs/user/terms.rst | 34 ++++++++++++++++++++++++---------- 1 file changed, 24 insertions(+), 10 deletions(-) diff --git a/docs/user/terms.rst b/docs/user/terms.rst index b27077fcd..817ef52a1 100644 --- a/docs/user/terms.rst +++ b/docs/user/terms.rst @@ -5,41 +5,55 @@ Glossary digraph { rankdir=RL; - { Service Prometheus} -> Shard; { Rule Notifier Project} -> Service; + { Project Prometheus} -> Shard; { Rule Notifier Exporter URL Farm} -> Project; Host -> Farm; - { rank=same Project Rule }; + { rank=same Notifier Rule }; } Shard ----- -Shards are the top level object in Promgen which contain both Services and -Prometheus servers +Shards are a collection of Prometheus servers monitoring the same targets. Service ------- -A service in Prometheus is a group of related Projects and are assigned to a -specific shard +A service in Promgen is a group of related Projects and Rules. +Service is typically the top-level object in Promgen. Projects -------- Projects are one of the main groupings for Promgen. This represents a typical monitoring target and brings together a collection of servers (Farm) with -Exporters and URL endpoints +Exporters and URL endpoints. They are assigned to a Shard. Farm ---- -Farm is a group of servers. Farms may be updated using :doc:`discovery plugins ` +Farm is a group of servers. Farms may be updated using :doc:`discovery plugins `. Notifiers --------- :doc:`Notifiers ` are used for routing messages to a specific destination such as Email or -LINE Notify +LINE Notify. +They can be assigned to either a Project or a Service, watching for alerts that match that label. Rule ---- -Rules represent the rules that Prometheus itself uses for alerting +Rules represent the rules that Prometheus itself uses for alerting. +They can be assigned to a Project, or assigned to a parent Service that covers multiple Projects. + +Exporter +-------- + +These correspond to `Prometheus exporters`_ and other monitoring integrations. + +URL +--- + +These are URLs that are monitored via `blackbox_exporter`_ + +.. _Prometheus exporters: https://prometheus.io/docs/instrumenting/exporters/ +.. _blackbox_exporter: https://github.com/prometheus/blackbox_exporter