Remove counter occurences from documentation
Change-Id: I8c3efc533f2e3b9786549fcc07d1f3725c765fb1 Blueprint: remove-counter
This commit is contained in:
parent
5d8a6e56e2
commit
849c8edf32
@ -37,7 +37,7 @@ cinder_control_exchange cinder Exchange
|
|||||||
neutron_control_exchange neutron Exchange name for Neutron notifications
|
neutron_control_exchange neutron Exchange name for Neutron notifications
|
||||||
metering_secret change this or be hacked Secret value for signing metering messages
|
metering_secret change this or be hacked Secret value for signing metering messages
|
||||||
metering_topic metering the topic ceilometer uses for metering messages
|
metering_topic metering the topic ceilometer uses for metering messages
|
||||||
counter_source openstack The source name of emited counters
|
sample_source openstack The source name of emited samples
|
||||||
control_exchange ceilometer AMQP exchange to connect to if using RabbitMQ or Qpid
|
control_exchange ceilometer AMQP exchange to connect to if using RabbitMQ or Qpid
|
||||||
database_connection mongodb://localhost:27017/ceilometer Database connection string
|
database_connection mongodb://localhost:27017/ceilometer Database connection string
|
||||||
metering_api_port 8777 The port for the ceilometer API server
|
metering_api_port 8777 The port for the ceilometer API server
|
||||||
|
@ -65,12 +65,12 @@ Compute plugins are defined as subclasses of the
|
|||||||
:class:`ceilometer.compute.plugin.ComputePollster` class as defined in
|
:class:`ceilometer.compute.plugin.ComputePollster` class as defined in
|
||||||
the ``ceilometer/compute/plugin.py`` file. Pollsters must implement one
|
the ``ceilometer/compute/plugin.py`` file. Pollsters must implement one
|
||||||
method: ``get_samples(self, manager, context)``, which returns a
|
method: ``get_samples(self, manager, context)``, which returns a
|
||||||
sequence of ``Counter`` objects as defined in the
|
sequence of ``Sample`` objects as defined in the
|
||||||
``ceilometer/counter.py`` file.
|
``ceilometer/sample.py`` file.
|
||||||
|
|
||||||
In the ``CPUPollster`` plugin, the ``get_samples`` method is implemented as a loop
|
In the ``CPUPollster`` plugin, the ``get_samples`` method is implemented as a loop
|
||||||
which, for each instances running on the local host, retrieves the cpu_time
|
which, for each instances running on the local host, retrieves the cpu_time
|
||||||
from the hypervisor and sends back two ``Counter`` objects. The first one, named
|
from the hypervisor and sends back two ``Sample`` objects. The first one, named
|
||||||
"cpu", is of type "cumulative", meaning that between two polls, its value is
|
"cpu", is of type "cumulative", meaning that between two polls, its value is
|
||||||
not reset, or in other word that the cpu value is always provided as a duration
|
not reset, or in other word that the cpu value is always provided as a duration
|
||||||
that continuously increases since the creation of the instance. The second one,
|
that continuously increases since the creation of the instance. The second one,
|
||||||
@ -89,7 +89,7 @@ the ``ceilometer/plugin.py`` file. Notifications must implement:
|
|||||||
|
|
||||||
``event_types`` which should be a sequence of strings defining the event types to be given to the plugin and
|
``event_types`` which should be a sequence of strings defining the event types to be given to the plugin and
|
||||||
|
|
||||||
``process_notification(self, message)`` which receives an event message from the list provided to event_types and returns a sequence of Counter objects as defined in the ``ceilometer/counter.py`` file.
|
``process_notification(self, message)`` which receives an event message from the list provided to event_types and returns a sequence of Sample objects as defined in the ``ceilometer/sample.py`` file.
|
||||||
|
|
||||||
In the ``InstanceNotifications`` plugin, it listens to three events:
|
In the ``InstanceNotifications`` plugin, it listens to three events:
|
||||||
|
|
||||||
@ -101,7 +101,7 @@ In the ``InstanceNotifications`` plugin, it listens to three events:
|
|||||||
|
|
||||||
using the ``get_event_type`` method and subsequently the method
|
using the ``get_event_type`` method and subsequently the method
|
||||||
``process_notification`` will be invoked each time such events are happening which
|
``process_notification`` will be invoked each time such events are happening which
|
||||||
generates the appropriate counter objects to be sent to the collector.
|
generates the appropriate sample objects to be sent to the collector.
|
||||||
|
|
||||||
Tests
|
Tests
|
||||||
=====
|
=====
|
||||||
|
@ -92,7 +92,7 @@
|
|||||||
|
|
||||||
source
|
source
|
||||||
The origin of metering data. This field is set to "openstack" by default.
|
The origin of metering data. This field is set to "openstack" by default.
|
||||||
It can be configured to a different value using the counter_source field
|
It can be configured to a different value using the sample_source field
|
||||||
in the ceilometer.conf file.
|
in the ceilometer.conf file.
|
||||||
|
|
||||||
user
|
user
|
||||||
|
@ -26,12 +26,12 @@ Installing the Collector
|
|||||||
.. index::
|
.. index::
|
||||||
double: installing; collector
|
double: installing; collector
|
||||||
|
|
||||||
1. If you want to be able to retrieve image counters, you need to instruct
|
1. If you want to be able to retrieve image samples, you need to instruct
|
||||||
Glance to send notifications to the bus by changing ``notifier_strategy``
|
Glance to send notifications to the bus by changing ``notifier_strategy``
|
||||||
to ``rabbit`` or ``qpid`` in ``glance-api.conf`` and restarting the
|
to ``rabbit`` or ``qpid`` in ``glance-api.conf`` and restarting the
|
||||||
service.
|
service.
|
||||||
|
|
||||||
2. If you want to be able to retrieve volume counters, you need to instruct
|
2. If you want to be able to retrieve volume samples, you need to instruct
|
||||||
Cinder to send notifications to the bus by changing ``notification_driver``
|
Cinder to send notifications to the bus by changing ``notification_driver``
|
||||||
to ``cinder.openstack.common.notifier.rabbit_notifier`` and
|
to ``cinder.openstack.common.notifier.rabbit_notifier`` and
|
||||||
``control_exchange`` to ``cinder``, before restarting the service.
|
``control_exchange`` to ``cinder``, before restarting the service.
|
||||||
|
@ -46,9 +46,9 @@ Units
|
|||||||
disk, routers, floating IPs, etc.).
|
disk, routers, floating IPs, etc.).
|
||||||
4. When creating a new meter, if another meter exists measuring
|
4. When creating a new meter, if another meter exists measuring
|
||||||
something similar, the same units and precision should be used.
|
something similar, the same units and precision should be used.
|
||||||
5. Samples (aka "meters" or "counters") should always document their
|
5. Meters and samples should always document their units in Ceilometer (API
|
||||||
units in Ceilometer (API and Documentation) and new sampling code
|
and Documentation) and new sampling code should not be merged without the
|
||||||
should not be merged without the appropriate documentation.
|
appropriate documentation.
|
||||||
|
|
||||||
============ ======== ============== =====
|
============ ======== ============== =====
|
||||||
Dimension Unit Abbreviations Note
|
Dimension Unit Abbreviations Note
|
||||||
|
Loading…
Reference in New Issue
Block a user