openstack/aodh
Code Issues Proposed changes

Merge "Improve help strings"

Browse Source
This commit is contained in:
Jenkins 2014-02-11 11:50:10 +00:00 committed by Gerrit Code Review
commit 0d8f2bc4c6
29 changed files with 110 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/ceilometer-test-event.py
View File

@ -41,7 +41,7 @@ cfg.CONF.register_cli_opts([
' defaults to stdin.'),
cfg.StrOpt('output-file',
short='o',
help='File to write results to. Defaults to stdout'),
help='File to write results to. Defaults to stdout.'),
])
TYPES = {1: 'text',

8
ceilometer/alarm/notifier/rest.py
View File

@ -33,16 +33,16 @@ LOG = log.getLogger(__name__)
REST_NOTIFIER_OPTS = [
cfg.StrOpt('rest_notifier_certificate_file',
default='',
help='SSL Client certificate for REST notifier'
help='SSL Client certificate for REST notifier.'
),
cfg.StrOpt('rest_notifier_certificate_key',
default='',
help='SSL Client private key for REST notifier'
help='SSL Client private key for REST notifier.'
),
cfg.BoolOpt('rest_notifier_ssl_verify',
default=True,
help='Verify the SSL Server certificate when \
calling alarm action'
help='Whether to verify the SSL Server certificate when '
'calling alarm action.'
),
]

4
ceilometer/alarm/rpc.py
View File

@ -28,11 +28,11 @@ OPTS = [
cfg.StrOpt('notifier_rpc_topic',
default='alarm_notifier',
help='The topic that ceilometer uses for alarm notifier '
'messages'),
'messages.'),
cfg.StrOpt('partition_rpc_topic',
default='alarm_partition_coordination',
help='The topic that ceilometer uses for alarm partition '
'coordination messages'),
'coordination messages.'),
]
cfg.CONF.register_opts(OPTS, group='alarm')

2
ceilometer/alarm/service.py
View File

@ -47,7 +47,7 @@ OPTS = [
'threshold_evaluation_interval', group='alarm')]),
cfg.StrOpt('evaluation_service',
default='ceilometer.alarm.service.SingletonAlarmService',
help='Class to launch as alarm evaluation service'),
help='Class to launch as alarm evaluation service.'),
]
cfg.CONF.register_opts(OPTS, group='alarm')

4
ceilometer/api/__init__.py
View File

@ -24,11 +24,11 @@ API_SERVICE_OPTS = [
default=8777,
deprecated_name='metering_api_port',
deprecated_group='DEFAULT',
help='The port for the ceilometer API server',
help='The port for the ceilometer API server.',
),
cfg.StrOpt('host',
default='0.0.0.0',
help='The listen IP for the ceilometer API server',
help='The listen IP for the ceilometer API server.',
),
]

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

@ -57,7 +57,7 @@ LOG = log.getLogger(__name__)
ALARM_API_OPTS = [
cfg.BoolOpt('record_history',
default=True,
help='Record alarm change events'
help='Record alarm change events.'
),
]

18
ceilometer/cli.py
View File

@ -37,38 +37,38 @@ def send_sample():
cfg.CONF.register_cli_opts([
cfg.StrOpt('sample-name',
short='n',
help='meter name',
help='Meter name.',
required=True),
cfg.StrOpt('sample-type',
short='y',
help='meter type (gauge, delta, cumulative)',
help='Meter type (gauge, delta, cumulative).',
default='gauge',
required=True),
cfg.StrOpt('sample-unit',
short='U',
help='meter unit',
help='Meter unit.',
default=None),
cfg.IntOpt('sample-volume',
short='l',
help='meter volume value',
help='Meter volume value.',
default=1),
cfg.StrOpt('sample-resource',
short='r',
help='meter resource id',
help='Meter resource id.',
required=True),
cfg.StrOpt('sample-user',
short='u',
help='meter user id'),
help='Meter user id.'),
cfg.StrOpt('sample-project',
short='p',
help='meter project id'),
help='Meter project id.'),
cfg.StrOpt('sample-timestamp',
short='i',
help='meter timestamp',
help='Meter timestamp.',
default=timeutils.utcnow().isoformat()),
cfg.StrOpt('sample-metadata',
short='m',
help='meter metadata'),
help='Meter metadata.'),
])
service.prepare_service()

2
ceilometer/collector.py
View File

@ -35,7 +35,7 @@ OPTS = [
'an empty string to disable.'),
cfg.IntOpt('udp_port',
default=4952,
help='Port to which the UDP socket is bound'),
help='Port to which the UDP socket is bound.'),
]
cfg.CONF.register_opts(OPTS, group="collector")

2
ceilometer/compute/notifications/__init__.py
View File

@ -24,7 +24,7 @@ from ceilometer import plugin
OPTS = [
cfg.StrOpt('nova_control_exchange',
default='nova',
help="Exchange name for Nova notifications"),
help="Exchange name for Nova notifications."),
]

4
ceilometer/compute/pollsters/util.py
View File

@ -38,10 +38,10 @@ INSTANCE_PROPERTIES = [
OPTS = [
cfg.ListOpt('reserved_metadata_namespace',
default=['metering.'],
help='List of metadata prefixes reserved for metering use'),
help='List of metadata prefixes reserved for metering use.'),
cfg.IntOpt('reserved_metadata_length',
default=256,
help='Limit on length of reserved metadata values'),
help='Limit on length of reserved metadata values.'),
]
cfg.CONF.register_opts(OPTS)

2
ceilometer/compute/virt/inspector.py
View File

@ -30,7 +30,7 @@ from ceilometer.openstack.common import log
OPTS = [
cfg.StrOpt('hypervisor_inspector',
default='libvirt',
help='Inspector to use for inspecting the hypervisor layer'),
help='Inspector to use for inspecting the hypervisor layer.'),
]
cfg.CONF.register_opts(OPTS)

4
ceilometer/compute/virt/libvirt/inspector.py
View File

@ -32,11 +32,11 @@ libvirt_opts = [
cfg.StrOpt('libvirt_type',
default='kvm',
help='Libvirt domain type (valid options are: '
'kvm, lxc, qemu, uml, xen)'),
'kvm, lxc, qemu, uml, xen).'),
cfg.StrOpt('libvirt_uri',
default='',
help='Override the default libvirt URI '
'(which is dependent on libvirt_type)'),
'(which is dependent on libvirt_type).'),
]
CONF = cfg.CONF

4
ceilometer/dispatcher/file.py
View File

@ -30,10 +30,10 @@ file_dispatcher_opts = [
'meters.'),
cfg.IntOpt('max_bytes',
default=0,
help='The max size of the file'),
help='The max size of the file.'),
cfg.IntOpt('backup_count',
default=0,
help='The max number of the files to keep'),
help='The max number of the files to keep.'),
]
cfg.CONF.register_opts(file_dispatcher_opts, group="dispatcher_file")

2
ceilometer/event/converter.py
View File

@ -31,7 +31,7 @@ from ceilometer.storage import models
OPTS = [
cfg.StrOpt('definitions_cfg_file',
default="event_definitions.yaml",
help="Configuration file for event definitions"
help="Configuration file for event definitions."
),
cfg.BoolOpt('drop_unmatched_notifications',
default=False,

2
ceilometer/image/notifications.py
View File

@ -27,7 +27,7 @@ from ceilometer import sample
OPTS = [
cfg.StrOpt('glance_control_exchange',
default='glance',
help="Exchange name for Glance notifications"),
help="Exchange name for Glance notifications."),
]

2
ceilometer/middleware.py
View File

@ -36,7 +36,7 @@ OPTS = [
cfg.CONF.glance_control_exchange,
cfg.CONF.neutron_control_exchange,
cfg.CONF.cinder_control_exchange],
help="Exchanges name to listen for notifications"),
help="Exchanges name to listen for notifications."),
]
cfg.CONF.register_opts(OPTS)

2
ceilometer/network/notifications.py
View File

@ -30,7 +30,7 @@ from ceilometer import sample
OPTS = [
cfg.StrOpt('neutron_control_exchange',
default='neutron',
help="Exchange name for Neutron notifications",
help="Exchange name for Neutron notifications.",
deprecated_name='quantum_control_exchange'),
]

4
ceilometer/notification.py
View File

@ -38,11 +38,11 @@ OPTS = [
cfg.BoolOpt('ack_on_event_error',
default=True,
deprecated_group='collector',
help='Acknowledge message when event persistence fails'),
help='Acknowledge message when event persistence fails.'),
cfg.BoolOpt('store_events',
deprecated_group='collector',
default=False,
help='Save event details'),
help='Save event details.'),
]
cfg.CONF.register_opts(OPTS, group="notification")

2
ceilometer/openstack/common/lockutils.py
View File

@ -37,7 +37,7 @@ LOG = logging.getLogger(__name__)
util_opts = [
cfg.BoolOpt('disable_process_locking', default=False,
help='Whether to disable inter-process locks'),
help='Whether to disable inter-process locks.'),
cfg.StrOpt('lock_path',
default=os.environ.get("CEILOMETER_LOCK_PATH"),
help=('Directory to use for lock files.'))

2
ceilometer/pipeline.py
View File

@ -32,7 +32,7 @@ from ceilometer import publisher
OPTS = [
cfg.StrOpt('pipeline_cfg_file',
default="pipeline.yaml",
help="Configuration file for pipeline definition"
help="Configuration file for pipeline definition."
),
]

2
ceilometer/publisher/rpc.py
View File

@ -37,7 +37,7 @@ LOG = log.getLogger(__name__)
METER_PUBLISH_OPTS = [
cfg.StrOpt('metering_topic',
default='metering',
help='The topic that ceilometer uses for metering messages',
help='The topic that ceilometer uses for metering messages.',
deprecated_group="DEFAULT",
),
]

2
ceilometer/publisher/utils.py
View File

@ -30,7 +30,7 @@ METER_PUBLISH_OPTS = [
cfg.StrOpt('metering_secret',
secret=True,
default='change this or be hacked',
help='Secret value for signing metering messages',
help='Secret value for signing metering messages.',
deprecated_opts=[cfg.DeprecatedOpt("metering_secret",
"DEFAULT"),
cfg.DeprecatedOpt("metering_secret",

2
ceilometer/sample.py
View File

@ -34,7 +34,7 @@ OPTS = [
cfg.StrOpt('sample_source',
default='openstack',
deprecated_name='counter_source',
help='Source for samples emitted on this instance'),
help='Source for samples emitted on this instance.'),
]
cfg.CONF.register_opts(OPTS)

16
ceilometer/service.py
View File

@ -40,7 +40,7 @@ OPTS = [
cfg.MultiStrOpt('dispatcher',
deprecated_group="collector",
default=['database'],
help='Dispatcher to process data'),
help='Dispatcher to process data.'),
]
cfg.CONF.register_opts(OPTS)
@ -48,32 +48,32 @@ CLI_OPTIONS = [
cfg.StrOpt('os-username',
deprecated_group="DEFAULT",
default=os.environ.get('OS_USERNAME', 'ceilometer'),
help='User name to use for OpenStack service access'),
help='User name to use for OpenStack service access.'),
cfg.StrOpt('os-password',
deprecated_group="DEFAULT",
secret=True,
default=os.environ.get('OS_PASSWORD', 'admin'),
help='Password to use for OpenStack service access'),
help='Password to use for OpenStack service access.'),
cfg.StrOpt('os-tenant-id',
deprecated_group="DEFAULT",
default=os.environ.get('OS_TENANT_ID', ''),
help='Tenant ID to use for OpenStack service access'),
help='Tenant ID to use for OpenStack service access.'),
cfg.StrOpt('os-tenant-name',
deprecated_group="DEFAULT",
default=os.environ.get('OS_TENANT_NAME', 'admin'),
help='Tenant name to use for OpenStack service access'),
help='Tenant name to use for OpenStack service access.'),
cfg.StrOpt('os-cacert',
default=os.environ.get('OS_CACERT', None),
help='Certificate chain for SSL validation'),
help='Certificate chain for SSL validation.'),
cfg.StrOpt('os-auth-url',
deprecated_group="DEFAULT",
default=os.environ.get('OS_AUTH_URL',
'http://localhost:5000/v2.0'),
help='Auth URL to use for OpenStack service access'),
help='Auth URL to use for OpenStack service access.'),
cfg.StrOpt('os-region-name',
deprecated_group="DEFAULT",
default=os.environ.get('OS_REGION_NAME', None),
help='Region name to use for OpenStack service endpoints'),
help='Region name to use for OpenStack service endpoints.'),
cfg.StrOpt('os-endpoint-type',
default=os.environ.get('OS_ENDPOINT_TYPE', 'publicURL'),
help='Type of endpoint in Identity service catalog to use for '

6
ceilometer/storage/__init__.py
View File

@ -38,7 +38,7 @@ OLD_STORAGE_OPTS = [
cfg.StrOpt('database_connection',
secret=True,
default=None,
help='DEPRECATED - Database connection string',
help='DEPRECATED - Database connection string.',
),
]
@ -48,8 +48,8 @@ cfg.CONF.register_opts(OLD_STORAGE_OPTS)
STORAGE_OPTS = [
cfg.IntOpt('time_to_live',
default=-1,
help="""number of seconds that samples are kept
in the database for (<= 0 means forever)"""),
help="Number of seconds that samples are kept "
"in the database for (<= 0 means forever)."),
]
cfg.CONF.register_opts(STORAGE_OPTS, group='database')

2
ceilometer/storage/sqlalchemy/models.py
View File

@ -38,7 +38,7 @@ from ceilometer import utils
sql_opts = [
cfg.StrOpt('mysql_engine',
default='InnoDB',
help='MySQL engine')
help='MySQL engine to use.')
]
cfg.CONF.register_opts(sql_opts)

2
ceilometer/volume/notifications.py
View File

@ -28,7 +28,7 @@ from ceilometer import sample
OPTS = [
cfg.StrOpt('cinder_control_exchange',
default='cinder',
help="Exchange name for Cinder notifications"),
help="Exchange name for Cinder notifications."),
]

92
etc/ceilometer/ceilometer.conf.sample
View File

@ -4,7 +4,7 @@
# Options defined in ceilometer.middleware
#
# Exchanges name to listen for notifications (multi valued)
# Exchanges name to listen for notifications. (multi valued)
#http_control_exchanges=nova
#http_control_exchanges=glance
#http_control_exchanges=neutron
@ -15,7 +15,7 @@
# Options defined in ceilometer.pipeline
#
# Configuration file for pipeline definition (string value)
# Configuration file for pipeline definition. (string value)
#pipeline_cfg_file=pipeline.yaml
@ -23,7 +23,7 @@
# Options defined in ceilometer.sample
#
# Source for samples emitted on this instance (string value)
# Source for samples emitted on this instance. (string value)
# Deprecated group/name - [DEFAULT]/counter_source
#sample_source=openstack
@ -37,7 +37,7 @@
# host name, FQDN, or IP address. (string value)
#host=ceilometer
# Dispatcher to process data (multi valued)
# Dispatcher to process data. (multi valued)
#dispatcher=database
@ -57,7 +57,7 @@
# Options defined in ceilometer.compute.notifications
#
# Exchange name for Nova notifications (string value)
# Exchange name for Nova notifications. (string value)
#nova_control_exchange=nova
@ -65,11 +65,11 @@
# Options defined in ceilometer.compute.pollsters.util
#
# List of metadata prefixes reserved for metering use (list
# List of metadata prefixes reserved for metering use. (list
# value)
#reserved_metadata_namespace=metering.
# Limit on length of reserved metadata values (integer value)
# Limit on length of reserved metadata values. (integer value)
#reserved_metadata_length=256
@ -77,8 +77,8 @@
# Options defined in ceilometer.compute.virt.inspector
#
# Inspector to use for inspecting the hypervisor layer (string
# value)
# Inspector to use for inspecting the hypervisor layer.
# (string value)
#hypervisor_inspector=libvirt
@ -87,11 +87,11 @@
#
# Libvirt domain type (valid options are: kvm, lxc, qemu, uml,
# xen) (string value)
# xen). (string value)
#libvirt_type=kvm
# Override the default libvirt URI (which is dependent on
# libvirt_type) (string value)
# libvirt_type). (string value)
#libvirt_uri=
@ -99,7 +99,7 @@
# Options defined in ceilometer.image.notifications
#
# Exchange name for Glance notifications (string value)
# Exchange name for Glance notifications. (string value)
#glance_control_exchange=glance
@ -107,7 +107,7 @@
# Options defined in ceilometer.network.notifications
#
# Exchange name for Neutron notifications (string value)
# Exchange name for Neutron notifications. (string value)
# Deprecated group/name - [DEFAULT]/quantum_control_exchange
#neutron_control_exchange=neutron
@ -151,7 +151,7 @@
# Options defined in ceilometer.openstack.common.lockutils
#
# Whether to disable inter-process locks (boolean value)
# Whether to disable inter-process locks. (boolean value)
#disable_process_locking=false
# Directory to use for lock files. (string value)
@ -490,7 +490,7 @@
# Options defined in ceilometer.storage
#
# DEPRECATED - Database connection string (string value)
# DEPRECATED - Database connection string. (string value)
#database_connection=<None>
@ -498,7 +498,7 @@
# Options defined in ceilometer.storage.sqlalchemy.models
#
# MySQL engine (string value)
# MySQL engine to use. (string value)
#mysql_engine=InnoDB
@ -506,7 +506,7 @@
# Options defined in ceilometer.volume.notifications
#
# Exchange name for Cinder notifications (string value)
# Exchange name for Cinder notifications. (string value)
#cinder_control_exchange=cinder
@ -516,14 +516,14 @@
# Options defined in ceilometer.alarm.notifier.rest
#
# SSL Client certificate for REST notifier (string value)
# SSL Client certificate for REST notifier. (string value)
#rest_notifier_certificate_file=
# SSL Client private key for REST notifier (string value)
# SSL Client private key for REST notifier. (string value)
#rest_notifier_certificate_key=
# Verify the SSL Server certificate when
# calling alarm action (boolean value)
# Whether to verify the SSL Server certificate when calling
# alarm action. (boolean value)
#rest_notifier_ssl_verify=true
@ -531,12 +531,12 @@
# Options defined in ceilometer.alarm.rpc
#
# The topic that ceilometer uses for alarm notifier messages
# The topic that ceilometer uses for alarm notifier messages.
# (string value)
#notifier_rpc_topic=alarm_notifier
# The topic that ceilometer uses for alarm partition
# coordination messages (string value)
# coordination messages. (string value)
#partition_rpc_topic=alarm_partition_coordination
@ -550,7 +550,7 @@
# Deprecated group/name - [alarm]/threshold_evaluation_interval
#evaluation_interval=60
# Class to launch as alarm evaluation service (string value)
# Class to launch as alarm evaluation service. (string value)
#evaluation_service=ceilometer.alarm.service.SingletonAlarmService
@ -558,7 +558,7 @@
# Options defined in ceilometer.api.controllers.v2
#
# Record alarm change events (boolean value)
# Record alarm change events. (boolean value)
#record_history=true
@ -568,11 +568,11 @@
# Options defined in ceilometer.api
#
# The port for the ceilometer API server (integer value)
# The port for the ceilometer API server. (integer value)
# Deprecated group/name - [DEFAULT]/metering_api_port
#port=8777
# The listen IP for the ceilometer API server (string value)
# The listen IP for the ceilometer API server. (string value)
#host=0.0.0.0
@ -586,7 +586,7 @@
# string to disable. (string value)
#udp_address=0.0.0.0
# Port to which the UDP socket is bound (integer value)
# Port to which the UDP socket is bound. (integer value)
#udp_port=4952
@ -673,8 +673,8 @@
# Options defined in ceilometer.storage
#
# number of seconds that samples are kept in the database for
# (<= 0 means forever) (integer value)
# Number of seconds that samples are kept in the database for
# (<= 0 means forever). (integer value)
#time_to_live=-1
@ -688,10 +688,10 @@
# value)
#file_path=<None>
# The max size of the file (integer value)
# The max size of the file. (integer value)
#max_bytes=0
# The max number of the files to keep (integer value)
# The max number of the files to keep. (integer value)
#backup_count=0
@ -701,7 +701,7 @@
# Options defined in ceilometer.event.converter
#
# Configuration file for event definitions (string value)
# Configuration file for event definitions. (string value)
#definitions_cfg_file=event_definitions.yaml
# Drop notifications if no event definition matches.
@ -874,11 +874,11 @@
# Options defined in ceilometer.notification
#
# Acknowledge message when event persistence fails (boolean
# Acknowledge message when event persistence fails. (boolean
# value)
#ack_on_event_error=true
# Save event details (boolean value)
# Save event details. (boolean value)
#store_events=false
@ -888,7 +888,7 @@
# Options defined in ceilometer.publisher.utils
#
# Secret value for signing metering messages (string value)
# Secret value for signing metering messages. (string value)
# Deprecated group/name - [DEFAULT]/metering_secret
# Deprecated group/name - [publisher_rpc]/metering_secret
#metering_secret=change this or be hacked
@ -900,8 +900,8 @@
# Options defined in ceilometer.publisher.rpc
#
# The topic that ceilometer uses for metering messages (string
# value)
# The topic that ceilometer uses for metering messages.
# (string value)
#metering_topic=metering
@ -921,26 +921,28 @@
# Options defined in ceilometer.service
#
# User name to use for OpenStack service access (string value)
# User name to use for OpenStack service access. (string
# value)
#os_username=ceilometer
# Password to use for OpenStack service access (string value)
# Password to use for OpenStack service access. (string value)
#os_password=admin
# Tenant ID to use for OpenStack service access (string value)
# Tenant ID to use for OpenStack service access. (string
# value)
#os_tenant_id=
# Tenant name to use for OpenStack service access (string
# Tenant name to use for OpenStack service access. (string
# value)
#os_tenant_name=admin
# Certificate chain for SSL validation (string value)
# Certificate chain for SSL validation. (string value)
#os_cacert=<None>
# Auth URL to use for OpenStack service access (string value)
# Auth URL to use for OpenStack service access. (string value)
#os_auth_url=http://localhost:5000/v2.0
# Region name to use for OpenStack service endpoints (string
# Region name to use for OpenStack service endpoints. (string
# value)
#os_region_name=<None>

20
tools/make_test_data.py
View File

@ -44,48 +44,48 @@ def main():
'--interval',
default=10,
type=int,
help='the period between events, in minutes',
help='The period between events, in minutes.',
)
parser.add_argument(
'--start',
default=31,
help='the number of days in the past to start timestamps',
help='The number of days in the past to start timestamps.',
)
parser.add_argument(
'--end',
default=2,
help='the number of days into the future to continue timestamps',
help='The number of days into the future to continue timestamps.',
)
parser.add_argument(
'--type',
choices=('gauge', 'cumulative'),
default='gauge',
help='counter type',
help='Counter type.',
)
parser.add_argument(
'--unit',
default=None,
help='counter unit',
help='Counter unit.',
)
parser.add_argument(
'--project',
help='project id of owner',
help='Project id of owner.',
)
parser.add_argument(
'--user',
help='user id of owner',
help='User id of owner.',
)
parser.add_argument(
'resource',
help='the resource id for the meter data',
help='The resource id for the meter data.',
)
parser.add_argument(
'counter',
help='the counter name for the meter data',
help='The counter name for the meter data.',
)
parser.add_argument(
'volume',
help='the amount to attach to the meter',
help='The amount to attach to the meter.',
type=int,
default=1,
)