702d99937e
The variable for excluding modules should be a sequence of strings.
Turn the current value from a string to a tuple so documentation
for our source is generated.
The errors and warnings were fixed in the docstrings in the source code
otherwise the doc generation would fail.
The following files were excluded from the doc build because of
non-existing imports:
'ceilometer.compute.nova_notifier'
http://bit.ly/remove-nova-notifier-bp
'ceilometer.openstack.common.db.sqlalchemy.session'
https://review.openstack.org/#/c/97850/
'ceilometer.openstack.common.middleware.audit'
'ceilometer.openstack.common.middleware.notifier'
https://bugs.launchpad.net/ceilometer/+bug/1327084
'ceilometer.openstack.common.log_handler'
https://bugs.launchpad.net/ceilometer/+bug/1327076
These failed imports are registered in one blueprint and two bug reports.
Change-Id: If0bc1c8fc96ba513bbeb90d5257e40b7621a8473
99 lines
3.6 KiB
Python
99 lines
3.6 KiB
Python
#
|
|
# Copyright 2013 IBM Corp
|
|
#
|
|
# Author: Tong Li <litong01@us.ibm.com>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import logging
|
|
import logging.handlers
|
|
import six.moves.urllib.parse as urlparse
|
|
|
|
from ceilometer.openstack.common.gettextutils import _
|
|
from ceilometer.openstack.common import log
|
|
from ceilometer import publisher
|
|
|
|
LOG = log.getLogger(__name__)
|
|
|
|
|
|
class FilePublisher(publisher.PublisherBase):
|
|
"""Publisher metering data to file.
|
|
|
|
The publisher which records metering data into a file. The file name and
|
|
location should be configured in ceilometer pipeline configuration file.
|
|
If a file name and location is not specified, this File Publisher will not
|
|
log any meters other than log a warning in Ceilometer log file.
|
|
|
|
To enable this publisher, add the following section to the
|
|
/etc/ceilometer/publisher.yaml file or simply add it to an existing
|
|
pipeline::
|
|
|
|
-
|
|
name: meter_file
|
|
interval: 600
|
|
counters:
|
|
- "*"
|
|
transformers:
|
|
publishers:
|
|
- file:///var/test?max_bytes=10000000&backup_count=5
|
|
|
|
File path is required for this publisher to work properly. If max_bytes
|
|
or backup_count is missing, FileHandler will be used to save the metering
|
|
data. If max_bytes and backup_count are present, RotatingFileHandler will
|
|
be used to save the metering data.
|
|
"""
|
|
|
|
def __init__(self, parsed_url):
|
|
super(FilePublisher, self).__init__(parsed_url)
|
|
|
|
self.publisher_logger = None
|
|
path = parsed_url.path
|
|
if not path or path.lower() == 'file':
|
|
LOG.error(_('The path for the file publisher is required'))
|
|
return
|
|
|
|
rfh = None
|
|
max_bytes = 0
|
|
backup_count = 0
|
|
# Handling other configuration options in the query string
|
|
if parsed_url.query:
|
|
params = urlparse.parse_qs(parsed_url.query)
|
|
if params.get('max_bytes') and params.get('backup_count'):
|
|
try:
|
|
max_bytes = int(params.get('max_bytes')[0])
|
|
backup_count = int(params.get('backup_count')[0])
|
|
except ValueError:
|
|
LOG.error(_('max_bytes and backup_count should be '
|
|
'numbers.'))
|
|
return
|
|
# create rotating file handler
|
|
rfh = logging.handlers.RotatingFileHandler(
|
|
path, encoding='utf8', maxBytes=max_bytes,
|
|
backupCount=backup_count)
|
|
|
|
self.publisher_logger = logging.Logger('publisher.file')
|
|
self.publisher_logger.propagate = False
|
|
self.publisher_logger.setLevel(logging.INFO)
|
|
rfh.setLevel(logging.INFO)
|
|
self.publisher_logger.addHandler(rfh)
|
|
|
|
def publish_samples(self, context, samples):
|
|
"""Send a metering message for publishing
|
|
|
|
:param context: Execution context from the service or RPC call
|
|
:param samples: Samples from pipeline after transformation
|
|
"""
|
|
if self.publisher_logger:
|
|
for sample in samples:
|
|
self.publisher_logger.info(sample.as_dict())
|