From 2f7153a59c0f79059e977d4d189475771e99d15f Mon Sep 17 00:00:00 2001 From: Witold Bedyk Date: Thu, 9 Aug 2018 14:12:40 +0200 Subject: [PATCH] Convert README to reStructuredText * convert README * add syntax check Story: 2002163 Task: 24461 Change-Id: I09e089f2c74684fef7f12d79b238002893942d4d --- README.md | 46 ------------------------------- README.rst | 63 +++++++++++++++++++++++++++++++++++++++++++ setup.cfg | 14 +++++----- test-requirements.txt | 1 + tox.ini | 1 + 5 files changed, 72 insertions(+), 53 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index 500df254..00000000 --- a/README.md +++ /dev/null @@ -1,46 +0,0 @@ -Team and repository tags -======================== - -[![Team and repository tags](https://governance.openstack.org/tc/badges/monasca-agent.svg)](https://governance.openstack.org/tc/reference/tags/index.html) - - - - - -**Table of Contents** - -- [Introduction](#introduction) -- [Detailed Documentation](#detailed-documentation) -- [License](#license) - - - -# 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) diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..55147068 --- /dev/null +++ b/README.rst @@ -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 `__ + +Agent Customizations +`github.com/openstack/monasca-agent/docs/Customizations.md `__ + +Monasca Metrics +`github.com/openstack/monasca-agent/docs/MonascaMetrics.md `__ + +Agent Plugin details +`github.com/openstack/monasca-agent/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 diff --git a/setup.cfg b/setup.cfg index eb4682d7..98be1141 100644 --- a/setup.cfg +++ b/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 diff --git a/test-requirements.txt b/test-requirements.txt index b62b7ed8..92747b71 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -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 diff --git a/tox.ini b/tox.ini index 0ed3af80..67eb9fef 100644 --- a/tox.ini +++ b/tox.ini @@ -72,6 +72,7 @@ basepython = python3 commands = {[testenv:flake8]commands} {[testenv:bandit]commands} + python setup.py check --restructuredtext --strict [testenv:venv] basepython = python3