Drivers for the Watcher Metering agent
Project description
========================
Watcher Metering vSphere
========================
Introduction
============
Watcher Metering vSphere provides a set of metric-pulling drivers extending the
`Watcher Metering`_ project which is used to collect system metrics from a
`vSphere datacenter`_ before publishing them to a given store.
To sum up, Watcher Metering service is composed by 2 modules:
- The ``Agent`` who collects the desired metrics and sends it to a publisher.
- The ``Publisher`` who gathers measurements from one or more agent and pushes
them to the desired store.
Drivers easily extend metrics collecting features of Agent (we use `stevedore`_ library for managing plugins).
This project is part of the Watcher_ project.
.. _Watcher Metering: https://github.com/b-com/watcher-metering
.. _Watcher: https://wiki.openstack.org/wiki/Watcher
.. _stevedore: http://git.openstack.org/cgit/openstack/stevedore
.. _vSphere datacenter: http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fright-pane.html
Getting started
===============
System requirements
-------------------
Watcher Metering packages must be installed before installing the drivers.
Please follow the installation procedure of the `Watcher Metering`_ project first.
Installation
------------
To install this package, just use *pip*:
.. code-block:: shell
# pip install python-watcher_metering_vsphere
Activate a driver
-----------------
Within your Watcher Metering Agent configuration file ``/etc/watcher-metering/watcher-metering-agent.conf``,
add the name of the driver entry point, in the ``[agent]`` section, you wish to enable.
As an example, if you wish to acticate both the ``vsphere_mem_usage`` and the
``vsphere_cpu_usage`` drivers, just edit the aforementioned configuration file like
this:
.. code-block:: ini
[agent]
driver_names =
vsphere_mem_usage,
vsphere_cpu_usage
After updating the configuration file, you have to `restart the Watcher Metering Agent`_.
.. _restart the Watcher Metering Agent: https://github.com/b-com/watcher-metering/blob/master/doc/source/deploy/installation.rst#command
Driver configuration
====================
To find out about the available drivers, please refer to the `vSphere drivers configuration`_ page
Each driver can be also configurable by adding a dedicated section named
``[metrics_driver.driver_name]`` in a configuration file loaded by the Watcher
Metering Agent. Such a file is self documented, so you will find in it all
driver configuration documentation.
You will find a sample by editing the file `etc/watcher-metering-vsphere/watcher-metering-vsphere.conf.sample`_
.. _vSphere drivers configuration: https://forge.b-com.com/www/indeed-ccl/doc/watcher-metering-vsphere/deploy/configuration.html
.. _etc/watcher-metering/watcher-metering-vsphere.conf.sample: etc/watcher-metering/watcher-metering-vsphere.conf.sample
Watcher Metering vSphere
========================
Introduction
============
Watcher Metering vSphere provides a set of metric-pulling drivers extending the
`Watcher Metering`_ project which is used to collect system metrics from a
`vSphere datacenter`_ before publishing them to a given store.
To sum up, Watcher Metering service is composed by 2 modules:
- The ``Agent`` who collects the desired metrics and sends it to a publisher.
- The ``Publisher`` who gathers measurements from one or more agent and pushes
them to the desired store.
Drivers easily extend metrics collecting features of Agent (we use `stevedore`_ library for managing plugins).
This project is part of the Watcher_ project.
.. _Watcher Metering: https://github.com/b-com/watcher-metering
.. _Watcher: https://wiki.openstack.org/wiki/Watcher
.. _stevedore: http://git.openstack.org/cgit/openstack/stevedore
.. _vSphere datacenter: http://pubs.vmware.com/vsphere-60/index.jsp?topic=%2Fcom.vmware.wssdk.apiref.doc%2Fright-pane.html
Getting started
===============
System requirements
-------------------
Watcher Metering packages must be installed before installing the drivers.
Please follow the installation procedure of the `Watcher Metering`_ project first.
Installation
------------
To install this package, just use *pip*:
.. code-block:: shell
# pip install python-watcher_metering_vsphere
Activate a driver
-----------------
Within your Watcher Metering Agent configuration file ``/etc/watcher-metering/watcher-metering-agent.conf``,
add the name of the driver entry point, in the ``[agent]`` section, you wish to enable.
As an example, if you wish to acticate both the ``vsphere_mem_usage`` and the
``vsphere_cpu_usage`` drivers, just edit the aforementioned configuration file like
this:
.. code-block:: ini
[agent]
driver_names =
vsphere_mem_usage,
vsphere_cpu_usage
After updating the configuration file, you have to `restart the Watcher Metering Agent`_.
.. _restart the Watcher Metering Agent: https://github.com/b-com/watcher-metering/blob/master/doc/source/deploy/installation.rst#command
Driver configuration
====================
To find out about the available drivers, please refer to the `vSphere drivers configuration`_ page
Each driver can be also configurable by adding a dedicated section named
``[metrics_driver.driver_name]`` in a configuration file loaded by the Watcher
Metering Agent. Such a file is self documented, so you will find in it all
driver configuration documentation.
You will find a sample by editing the file `etc/watcher-metering-vsphere/watcher-metering-vsphere.conf.sample`_
.. _vSphere drivers configuration: https://forge.b-com.com/www/indeed-ccl/doc/watcher-metering-vsphere/deploy/configuration.html
.. _etc/watcher-metering/watcher-metering-vsphere.conf.sample: etc/watcher-metering/watcher-metering-vsphere.conf.sample
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for python-watcher_metering_vsphere-0.21.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f997c5cc9d87868d880b6ae591b0a9af1ec691757acdb6eb7571cd93ea7a4dbc |
|
MD5 | 9a37f63d570558de7d0674062b9f3ec6 |
|
BLAKE2b-256 | 36616a16fe6930aa5880002225001b566f3105e5e43078fd8a57b923985cfc03 |
Close
Hashes for python_watcher_metering_vsphere-0.21.13-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01e344420bffb3cda83b4a8ed2cb6419ece53359b167a6124f7ba66f97c4f440 |
|
MD5 | 670d65f957d5eb473e446fa2f31b555d |
|
BLAKE2b-256 | 311ff8fe189feaff7074937a1d8cb046e9595aebbcec32906f915f952e08b219 |