Convert README to reStructuredText
* convert README * add syntax check Story: 2002163 Task: 24461 Change-Id: I09e089f2c74684fef7f12d79b238002893942d4d
This commit is contained in:
Witold Bedyk
parent
2273aef8ab
commit
2f7153a59c
46
README.md
46
README.md
@ -1,46 +0,0 @@
|
||||
Team and repository tags
|
||||
========================
|
||||
|
||||
[](https://governance.openstack.org/tc/reference/tags/index.html)
|
||||
|
||||
<!-- Change things from this point on -->
|
||||
|
||||
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
|
||||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||||
**Table of Contents**
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Detailed Documentation](#detailed-documentation)
|
||||
- [License](#license)
|
||||
|
||||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||||
|
||||
# Introduction
|
||||
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 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 service 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.
|
||||
|
||||
The Agent is extensible through configuration of additional plugins, written in Python.
|
||||
|
||||
# Detailed Documentation
|
||||
|
||||
For an introduction to the Monasca Agent, including a complete list of the metrics that the Agent supports, see the "Agent" detailed documentation.
|
||||
|
||||
The Agent is extensible through configuration of additional check and setup plugins, written in Python. See the "Agent Customizations" detailed documentation.
|
||||
|
||||
Agent [github.com/openstack/monasca-agent/blob/master/docs/Agent.md](https://github.com/openstack/monasca-agent/blob/master/docs/Agent.md)
|
||||
|
||||
Agent Customizations [github.com/openstack/monasca-agent/docs/Customizations.md](https://github.com/openstack/monasca-agent/blob/master/docs/Customizations.md)
|
||||
|
||||
Monasca Metrics [github.com/openstack/monasca-agent/docs/MonascaMetrics.md](https://github.com/openstack/monasca-agent/blob/master/docs/MonascaMetrics.md)
|
||||
|
||||
Agent Plugin details [github.com/openstack/monasca-agent/docs/Plugins.md](https://github.com/openstack/monasca-agent/blob/master/docs/Plugins.md)
|
||||
63
README.rst
Normal file
63
README.rst
Normal file
@ -0,0 +1,63 @@
|
||||
Team and repository tags
|
||||
========================
|
||||
|
||||
|Team and repository tags|
|
||||
|
||||
Introduction
|
||||
============
|
||||
|
||||
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.
|
||||
|
||||
The Agent is extensible through the configuration of additional plugins,
|
||||
written in Python.
|
||||
|
||||
Detailed Documentation
|
||||
======================
|
||||
|
||||
For an introduction to the Monasca Agent, including a complete list of
|
||||
the metrics that the Agent supports, see the "Agent" detailed
|
||||
documentation.
|
||||
|
||||
The Agent is extensible through the configuration of additional check and
|
||||
setup plugins, written in Python. See the "Agent Customizations"
|
||||
detailed documentation.
|
||||
|
||||
Agent
|
||||
`github.com/openstack/monasca-agent/blob/master/docs/Agent.md <https://github.com/openstack/monasca-agent/blob/master/docs/Agent.md>`__
|
||||
|
||||
Agent Customizations
|
||||
`github.com/openstack/monasca-agent/docs/Customizations.md <https://github.com/openstack/monasca-agent/blob/master/docs/Customizations.md>`__
|
||||
|
||||
Monasca Metrics
|
||||
`github.com/openstack/monasca-agent/docs/MonascaMetrics.md <https://github.com/openstack/monasca-agent/blob/master/docs/MonascaMetrics.md>`__
|
||||
|
||||
Agent Plugin details
|
||||
`github.com/openstack/monasca-agent/docs/Plugins.md <https://github.com/openstack/monasca-agent/blob/master/docs/Plugins.md>`__
|
||||
|
||||
* License: Simplified BSD License
|
||||
* Source: http://git.openstack.org/cgit/openstack/monasca-agent
|
||||
* Bugs: https://storyboard.openstack.org/#!/project/861 (please use `bug` tag)
|
||||
|
||||
.. |Team and repository tags| image:: https://governance.openstack.org/tc/badges/monasca-agent.svg
|
||||
:target: https://governance.openstack.org/tc/reference/tags/index.html
|
||||
14
setup.cfg
14
setup.cfg
@ -1,16 +1,16 @@
|
||||
[metadata]
|
||||
name=monasca-agent
|
||||
maintainer=monasca
|
||||
maintainer_email=monasca@lists.launchpad.net
|
||||
description-file = README.md
|
||||
name = monasca-agent
|
||||
maintainer = OpenStack
|
||||
maintainer_email = openstack-dev@lists.openstack.org
|
||||
description-file = README.rst
|
||||
summary = Monitoring agent for gathering metrics and sending them to the Monasca API.
|
||||
home-page = https://github.com/openstack/monasca-agent
|
||||
keywords=
|
||||
openstack
|
||||
monitoring
|
||||
license=Apache-2
|
||||
include_package_data=True
|
||||
test_suite=nose.collector
|
||||
license = Apache-2
|
||||
include_package_data = True
|
||||
test_suite = nose.collector
|
||||
classifier=
|
||||
Development Status :: 5 - Production/Stable
|
||||
License :: OSI Approved :: Apache Software License
|
||||
|
||||
@ -8,3 +8,4 @@ coverage!=4.4,>=4.0 # Apache-2.0
|
||||
oslotest>=3.2.0 # Apache-2.0
|
||||
prometheus_client
|
||||
os-testr>=1.0.0 # Apache-2.0
|
||||
docutils>=0.11 # OSI-Approved Open Source, Public Domain
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user