openstack/aodh
Code Issues Proposed changes

Fix some flaws in ceilometer docstrings

Browse Source 
Change-Id: Iaed56b46cefff10f9a88fa5096390b19a297d237
This commit is contained in:
liu-sheng 2014-02-13 17:59:51 +08:00
parent feb0b6f18f
commit 30cfabfa9a
4 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ceilometer/api/controllers/v2.py
View File

@ -646,7 +646,7 @@ class Statistics(_Base):
# "invalid." # "invalid."
# #
# If the timestamps are invalid, return None as a # If the timestamps are invalid, return None as a
# sentinal indicating that there is something "funny" # sentinel indicating that there is something "funny"
# about the range. # about the range.
if (self.duration_start and if (self.duration_start and
self.duration_end and self.duration_end and

2
ceilometer/compute/nova_notifier.py
View File

@ -96,7 +96,7 @@ class Instance(object):
The pollsters all expect an instance that looks like what the The pollsters all expect an instance that looks like what the
novaclient gives them, but the conductor API gives us a novaclient gives them, but the conductor API gives us a
dictionary. This class makes an object from the dictonary so we dictionary. This class makes an object from the dictionary so we
can pass it to the pollsters. can pass it to the pollsters.
""" """
def __init__(self, context, info): def __init__(self, context, info):

10
ceilometer/pipeline.py
View File

@ -75,7 +75,7 @@ class Pipeline(object):
"""Sample handling pipeline """Sample handling pipeline
Pipeline describes a chain of handlers. The chain starts with Pipeline describes a chain of handlers. The chain starts with
tranformer and ends with one or more publishers. transformer and ends with one or more publishers.
The first transformer in the chain gets sample from data collector, i.e. The first transformer in the chain gets sample from data collector, i.e.
pollster or notification handler, takes some action like dropping, pollster or notification handler, takes some action like dropping,
@ -313,13 +313,13 @@ class PipelineManager(object):
The top of the cfg is a list of pipeline definitions. The top of the cfg is a list of pipeline definitions.
Pipeline definition is an dictionary specifying the target samples, Pipeline definition is an dictionary specifying the target samples,
the tranformers involved, and the target publishers: the transformers involved, and the target publishers:
{ {
"name": pipeline_name "name": pipeline_name
"interval": interval_time "interval": interval_time
"meters" : ["meter_1", "meter_2"], "meters" : ["meter_1", "meter_2"],
"resources": ["resource_uri1", "resource_uri2"], "resources": ["resource_uri1", "resource_uri2"],
"tranformers":[ "transformers":[
{"name": "Transformer_1", {"name": "Transformer_1",
"parameters": {"p1": "value"}}, "parameters": {"p1": "value"}},
@ -348,9 +348,9 @@ class PipelineManager(object):
the meters should be polled. It's optional and it's up to the the meters should be polled. It's optional and it's up to the
specific pollster to decide how to use it. specific pollster to decide how to use it.
Transformer's name is plugin name in setup.py. Transformer's name is plugin name in setup.cfg.
Publisher's name is plugin name in setup.py Publisher's name is plugin name in setup.cfg
""" """
self.pipelines = [Pipeline(pipedef, transformer_manager) self.pipelines = [Pipeline(pipedef, transformer_manager)

4
ceilometer/storage/impl_sqlalchemy.py
View File

@ -130,7 +130,9 @@ def apply_metaquery_filter(session, query, metaquery):
def make_query_from_filter(session, query, sample_filter, require_meter=True): def make_query_from_filter(session, query, sample_filter, require_meter=True):
"""Return a query dictionary based on the settings in the filter. """Return a query dictionary based on the settings in the filter.
:param filter: SampleFilter instance :param session: session used for original query
:param query: Query instance
:param sample_filter: SampleFilter instance
:param require_meter: If true and the filter does not have a meter, :param require_meter: If true and the filter does not have a meter,
raise an error. raise an error.
""" """