diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/telemetry-data-collection.rst | 9 | ||||
| -rw-r--r-- | doc/source/admin/telemetry-dynamic-pollster.rst | 5 | ||||
| -rw-r--r-- | doc/source/admin/telemetry-measurements.rst | 110 | ||||
| -rw-r--r-- | doc/source/conf.py | 22 | ||||
| -rw-r--r-- | doc/source/contributor/architecture.rst | 2 |
5 files changed, 20 insertions, 128 deletions
diff --git a/doc/source/admin/telemetry-data-collection.rst b/doc/source/admin/telemetry-data-collection.rst index 618c8f1f..559d0396 100644 --- a/doc/source/admin/telemetry-data-collection.rst +++ b/doc/source/admin/telemetry-data-collection.rst @@ -19,9 +19,8 @@ Notifications messages from the configured message queue system. Polling - Retrieve information directly from the hypervisor or from the host - machine using SNMP, or by using the APIs of other OpenStack - services. + Retrieve information directly from the hypervisor or by using the APIs of + other OpenStack services. Notifications ============= @@ -281,15 +280,13 @@ Central agent ~~~~~~~~~~~~~ This agent is responsible for polling public REST APIs to retrieve additional -information on OpenStack resources not already surfaced via notifications, -and also for polling hardware resources over SNMP. +information on OpenStack resources not already surfaced via notifications. Some of the services polled with this agent are: - OpenStack Networking - OpenStack Object Storage - OpenStack Block Storage -- Hardware resources via SNMP To install and configure this service use the :ref:`install_rdo` section in the Installation Tutorials and Guides. diff --git a/doc/source/admin/telemetry-dynamic-pollster.rst b/doc/source/admin/telemetry-dynamic-pollster.rst index f9118792..25758d8f 100644 --- a/doc/source/admin/telemetry-dynamic-pollster.rst +++ b/doc/source/admin/telemetry-dynamic-pollster.rst @@ -198,6 +198,11 @@ attributes to define a dynamic pollster: executed serially, one after the other. Therefore, if the request hangs, all pollsters (including the non-dynamic ones) will stop executing. +* ``namespaces``: optional parameter. Defines the namespaces (running + ceilometer instances) where the pollster will be instantiated. This + parameter accepts a single string value or a list of strings. The + default value is `central`. + The complete YAML configuration to gather data from Magnum (that has been used as an example) is the following: diff --git a/doc/source/admin/telemetry-measurements.rst b/doc/source/admin/telemetry-measurements.rst index 346fcc7e..faa7c98a 100644 --- a/doc/source/admin/telemetry-measurements.rst +++ b/doc/source/admin/telemetry-measurements.rst @@ -398,116 +398,6 @@ meters are recorded from capable platform: | | | | | | the system | +---------------------+-------+------+----------+----------+------------------+ -SNMP based meters -~~~~~~~~~~~~~~~~~ - -Telemetry supports gathering SNMP based generic host meters. In order to -be able to collect this data you need to run snmpd on each target host. - -The following meters are available about the host machines by using -SNMP: - -+---------------------+-------+------+----------+----------+------------------+ -| Name | Type | Unit | Resource | Origin | Note | -+=====================+=======+======+==========+==========+==================+ -| **Meters added in the Mitaka release or earlier** | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.load.\ | Gauge | proc\| host ID | Pollster | CPU load in the | -| 1min | | ess | | | past 1 minute | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.load.\ | Gauge | proc\| host ID | Pollster | CPU load in the | -| 5min | | ess | | | past 5 minutes | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.load.\ | Gauge | proc\| host ID | Pollster | CPU load in the | -| 15min | | ess | | | past 15 minutes | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.disk.size\ | Gauge | KB | disk ID | Pollster | Total disk size | -| .total | | | | | | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.disk.size\ | Gauge | KB | disk ID | Pollster | Used disk size | -| .used | | | | | | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.memory.to\ | Gauge | KB | host ID | Pollster | Total physical | -| tal | | | | | memory size | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.memory.us\ | Gauge | KB | host ID | Pollster | Used physical m\ | -| ed | | | | | emory size | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.memory.bu\ | Gauge | KB | host ID | Pollster | Physical memory | -| ffer | | | | | buffer size | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.memory.ca\ | Gauge | KB | host ID | Pollster | Cached physical | -| ched | | | | | memory size | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.memory.sw\ | Gauge | KB | host ID | Pollster | Total swap space | -| ap.total | | | | | size | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.memory.sw\ | Gauge | KB | host ID | Pollster | Available swap | -| ap.avail | | | | | space size | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.network.i\ | Cumul\| B | interface| Pollster | Bytes received | -| ncoming.bytes | ative | | ID | | by network inte\ | -| | | | | | rface | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.network.o\ | Cumul\| B | interface| Pollster | Bytes sent by n\ | -| utgoing.bytes | ative | | ID | | etwork interface | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.network.o\ | Cumul\| pack\| interface| Pollster | Sending error o\ | -| utgoing.errors | ative | et | ID | | f network inter\ | -| | | | | | face | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.network.i\ | Cumul\| data\| host ID | Pollster | Number of recei\ | -| p.incoming.datagra\ | ative | grams| | | ved datagrams | -| ms | | | | | | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.network.i\ | Cumul\| data\| host ID | Pollster | Number of sent | -| p.outgoing.datagra\ | ative | grams| | | datagrams | -| ms | | | | | | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.system_st\ | Cumul\| bloc\| host ID | Pollster | Aggregated numb\ | -| ats.io.incoming.bl\ | ative | ks | | | er of blocks re\ | -| ocks | | | | | ceived to block | -| | | | | | device | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.system_st\ | Cumul\| bloc\| host ID | Pollster | Aggregated numb\ | -| ats.io.outgoing.bl\ | ative | ks | | | er of blocks se\ | -| ocks | | | | | nt to block dev\ | -| | | | | | ice | -+---------------------+-------+------+----------+----------+------------------+ -| **Meters added in the Queens release** | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.disk.read.\| Gauge | B | disk ID | Pollster | Bytes read from | -| bytes | | | | | device since boot| -+---------------------+-------+------+----------+----------+------------------+ -| hardware.disk.write\| Gauge | B | disk ID | Pollster | Bytes written to | -| .bytes | | | | | device since boot| -+---------------------+-------+------+----------+----------+------------------+ -| hardware.disk.read.\| Gauge | requ\| disk ID | Pollster | Read requests to | -| requests | | ests | | | device since boot| -+---------------------+-------+------+----------+----------+------------------+ -| hardware.disk.write\| Gauge | requ\| disk ID | Pollster | Write requests to| -| .requests | | ests | | | device since boot| -+---------------------+-------+------+----------+----------+------------------+ -| **Meters added in the Stein release** | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.user | Gauge | tick | host ID | Pollster | CPU user in tick | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.system | Gauge | tick | host ID | Pollster | CPU system in t\ | -| | | | | | ick | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.nice | Gauge | tick | host ID | Pollster | CPU nice in tick | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.idle | Gauge | tick | host ID | Pollster | CPU idle in tick | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.wait | Gauge | tick | host ID | Pollster | CPU wait in tick | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.kernel | Gauge | tick | host ID | Pollster | CPU kernel in t\ | -| | | | | | ick | -+---------------------+-------+------+----------+----------+------------------+ -| hardware.cpu.inter\ | Gauge | tick | host ID | Pollster | CPU interrupt i\ | -| rupt | | | | | n tick | -+---------------------+-------+------+----------+----------+------------------+ - OpenStack Image service ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/conf.py b/doc/source/conf.py index d04763b4..d8fa0d6d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -60,8 +60,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Ceilometer' -copyright = u'2012-2015, OpenStack Foundation' +project = 'Ceilometer' +copyright = '2012-2015, OpenStack Foundation' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -203,8 +203,8 @@ smartquotes_excludes = {'builders': ['latex']} # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ - ('index', 'doc-ceilometer.tex', u'Ceilometer Documentation', - u'OpenStack Foundation', 'manual'), + ('index', 'doc-ceilometer.tex', 'Ceilometer Documentation', + 'OpenStack Foundation', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -233,8 +233,8 @@ latex_documents = [ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'ceilometer', u'Ceilometer Documentation', - [u'OpenStack'], 1) + ('index', 'ceilometer', 'Ceilometer Documentation', + ['OpenStack'], 1) ] # If true, show URL addresses after external links. @@ -247,7 +247,7 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'Ceilometer', u'Ceilometer Documentation', u'OpenStack', + ('index', 'Ceilometer', 'Ceilometer Documentation', 'OpenStack', 'Ceilometer', 'One line description of project.', 'Miscellaneous'), ] @@ -264,10 +264,10 @@ texinfo_documents = [ # -- Options for Epub output -------------------------------------------------- # Bibliographic Dublin Core info. -epub_title = u'Ceilometer' -epub_author = u'OpenStack' -epub_publisher = u'OpenStack' -epub_copyright = u'2012-2015, OpenStack' +epub_title = 'Ceilometer' +epub_author = 'OpenStack' +epub_publisher = 'OpenStack' +epub_copyright = '2012-2015, OpenStack' # The language of the text. It defaults to the language option # or en if the language is not set. diff --git a/doc/source/contributor/architecture.rst b/doc/source/contributor/architecture.rst index 896e517d..736b03fa 100644 --- a/doc/source/contributor/architecture.rst +++ b/doc/source/contributor/architecture.rst @@ -69,7 +69,7 @@ The Ceilometer project created 2 methods to collect data: The first method is supported by the ceilometer-notification agent, which monitors the message queues for notifications. Polling agents can be configured either to poll the local hypervisor or remote APIs (public REST APIs exposed by -services and host-level SNMP/IPMI daemons). +services and host-level IPMI daemons). Notification Agent: Listening for data --------------------------------------- |