monasca-agent/README.md
Flavio Percoco d403291091 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/00dc42c7509475325cf25d6b7740303d

Change-Id: I996d69c9d717b86250997f4cfc8b57cc1caab59a
2016-11-25 18:32:16 +01:00

2.8 KiB

Team and repository tags

Team and repository tags

Table of Contents

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

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

(C) Copyright 2015 Hewlett Packard Enterprise Development Company LP