openstack/monasca-agent
Code Issues Proposed changes

Merge "Add information about Prometheus plugin to README"

Browse Source
This commit is contained in:
Zuul 2019-05-30 13:15:49 +00:00 committed by Gerrit Code Review
commit 6fa4c8fcaf
2 changed files with 31 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.rst
View File

@ -6,27 +6,38 @@ 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
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.
- Host alive. The Monasca Agent can perform active checks on a host to
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
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 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,
Service checks
The *Monasca 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
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,

2
docs/Plugins.md
View File

@ -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