From 773370901d2f8b4c43a7c8ac432782c3b6f5a342 Mon Sep 17 00:00:00 2001 From: Edwin Zhai Date: Wed, 8 Apr 2015 15:56:06 +0800 Subject: [PATCH] Replace 'metrics' with 'meters' in option and doc So that the openstack manuals are consistent and use the same (right) term, this replaces the term 'metrics' with 'meters' in the help for the config and develop docs. DocImpact Closes-bug: #1436371 Change-Id: Iadc81a936f75dbe619130b3434188f564b67efd5 --- ceilometer/alarm/service.py | 2 +- doc/source/measurements.rst | 2 +- doc/source/overview.rst | 6 +++--- doc/source/plugins.rst | 6 +++--- doc/source/webapi/v2.rst | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/ceilometer/alarm/service.py b/ceilometer/alarm/service.py index 5984f63d..41c5025b 100644 --- a/ceilometer/alarm/service.py +++ b/ceilometer/alarm/service.py @@ -40,7 +40,7 @@ OPTS = [ default=60, help='Period of evaluation cycle, should' ' be >= than configured pipeline interval for' - ' collection of underlying metrics.', + ' collection of underlying meters.', deprecated_opts=[cfg.DeprecatedOpt( 'threshold_evaluation_interval', group='alarm')]), ] diff --git a/doc/source/measurements.rst b/doc/source/measurements.rst index c3e270ee..c8e2fd55 100644 --- a/doc/source/measurements.rst +++ b/doc/source/measurements.rst @@ -22,7 +22,7 @@ Existing meters =============== -For the list of existing metrics see the tables under the +For the list of existing meters see the tables under the `Measurements page`_ of Ceilometer in the Cloud Administrator Guide. .. _Measurements page: http://docs.openstack.org/admin-guide-cloud/content/section_telemetry-measurements.html diff --git a/doc/source/overview.rst b/doc/source/overview.rst index 50cd40f0..971d16b6 100644 --- a/doc/source/overview.rst +++ b/doc/source/overview.rst @@ -12,14 +12,14 @@ single source to transform events into billable items which we label as "metering". As the project started to come to life, collecting an -`increasing number of metrics`_ across multiple projects, the OpenStack +`increasing number of meters`_ across multiple projects, the OpenStack community started to realize that a secondary goal could be added to -Ceilometer: become a standard way to collect metric, regardless of the +Ceilometer: become a standard way to collect meter, regardless of the purpose of the collection. For example, Ceilometer can now publish information for monitoring, debugging and graphing tools in addition or in parallel to the metering backend. We labelled this effort as "multi-publisher". -.. _increasing number of metrics: http://docs.openstack.org/developer/ceilometer/measurements.html +.. _increasing number of meters: http://docs.openstack.org/developer/ceilometer/measurements.html Most recently, as the Heat project started to come to life, it soon became clear that the OpenStack project needed a tool to watch diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst index 5d7a5cfd..a3c16ef5 100644 --- a/doc/source/plugins.rst +++ b/doc/source/plugins.rst @@ -30,8 +30,8 @@ Polling agent might be run either on central cloud management nodes or on the compute nodes (where direct hypervisor polling is quite logical). The agent running on each compute node polls for compute resources -usage. Each metric collected is tagged with the resource ID (such as -an instance) and the owner, including tenant and user IDs. The metrics +usage. Each meter collected is tagged with the resource ID (such as +an instance) and the owner, including tenant and user IDs. The meters are then reported to the collector via the message bus. More detailed information follows. @@ -136,7 +136,7 @@ generates the appropriate sample objects to be sent to the collector. Adding new plugins ------------------ -Although we have described a list of the metrics Ceilometer should +Although we have described a list of the meters Ceilometer should collect, we cannot predict all of the ways deployers will want to measure the resources their customers use. This means that Ceilometer needs to be easy to extend and configure so it can be tuned for each diff --git a/doc/source/webapi/v2.rst b/doc/source/webapi/v2.rst index 7d2d9ca2..484229f2 100644 --- a/doc/source/webapi/v2.rst +++ b/doc/source/webapi/v2.rst @@ -313,7 +313,7 @@ Functional examples +++++++++++++++++++ The examples below are meant to help you understand how to query the -Ceilometer API to build custom metrics report. The query parameters should +Ceilometer API to build custom meters report. The query parameters should be encoded using one of the above methods, e.g. as the URL parameters or as JSON encoded data passed to the GET request.