diff --git a/README.rst b/README.rst index 862faace..51fc8bec 100644 --- a/README.rst +++ b/README.rst @@ -6,28 +6,39 @@ Team and repository tags Introduction ============ -The Monasca Agent is a modern Python monitoring agent for gathering +The *Monasca Agent* is a modern Python monitoring agent for gathering metrics and sending them to the Monasca API. The Agent supports collecting metrics from a variety of sources as follows: -- System metrics such as cpu and memory utilization. -- Nagios plugins. The Monasca Agent can run Nagios plugins and send the - status code returned by the plugin as a metric to the Monasca API. -- Statsd. The Monasca Agent supports an integrated Statsd daemon which - can be used by applications via a statsd client library. -- Host alive. The Monasca Agent can perform active checks on a host to - determine if it is alive using ping (ICMP) or SSH. -- Process checks. The Monasca Agent can check a process and return - several metrics on the process such as a number of instances, memory, - io and threads. -- Http Endpoint checks. The Monasca Agent can perform active checks on - http endpoints by sending an HTTP request to an API. -- Service checks. The Agent can check services such as MySQL, RabbitMQ, - and many more. -- OpenStack metrics. The agent can perform checks on OpenStack - processes. -- The Agent can automatically detect and setup checks on certain - processes and resources. +System metrics + such as cpu and memory utilization. +Prometheus + The *Monasca Agent* supports scraping metrics from endpoints provided by + *Prometheus exporters* or *Prometheus* instrumented applications. +Statsd + The *Monasca Agent* supports an integrated *StatsD* daemon which + can be used by applications via a statsd client library. +OpenStack metrics + The agent can perform checks on OpenStack processes. +Host alive + The *Monasca Agent* can perform active checks on a host to + determine if it is alive using ping (ICMP) or SSH. +Process checks + The *Monasca Agent* can check a process and return + several metrics on the process such as a number of instances, memory, + io and threads. +Http Endpoint checks + The *Monasca Agent* can perform active checks on + http endpoints by sending an HTTP request to an API. +Service checks + The *Monasca Agent* can check services such as MySQL, RabbitMQ, + and many more. +Nagios plugins + The *Monasca Agent* can run *Nagios* plugins and send the + status code returned by the plugin as a metric to the Monasca API. + +The Agent can automatically detect and setup checks on certain +processes and resources. The Agent is extensible through the configuration of additional plugins, written in Python. diff --git a/docs/Plugins.md b/docs/Plugins.md index 1f66c46d..666caec7 100644 --- a/docs/Plugins.md +++ b/docs/Plugins.md @@ -2424,7 +2424,7 @@ The process checks return the following metrics ( if detailed is set to true, ot On Linux, if the Agent is not run as root or the owner of the process the io metrics and the open_file_descriptors metric will fail to be reported if the mon-agent user does not have permission to get it for the process. -## Prometheus Client +## Prometheus This plugin is for scraping metrics from endpoints that are created by prometheus client libraries - https://prometheus.io/docs/instrumenting/clientlibs/ It can be configured in two ways. One being manually setting all the endpoints that you want to scrape. The other being