Source code for yardstick.dispatcher.file

##############################################################################
# Copyright (c) 2015 Huawei Technologies Co.,Ltd and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################

import logging
import json

from oslo_config import cfg

from yardstick.dispatcher.base import Base as DispatchBase

CONF = cfg.CONF
OPTS = [
    cfg.StrOpt('file_path',
               default='/tmp/yardstick.out',
               help='Name and the location of the file to record '
                    'data.'),
    cfg.IntOpt('max_bytes',
               default=0,
               help='The max size of the file.'),
    cfg.IntOpt('backup_count',
               default=0,
               help='The max number of the files to keep.'),
]
CONF.register_opts(OPTS, group="dispatcher_file")


class FileDispatcher(DispatchBase):
    """Dispatcher class for recording data to a file.
    """

    __dispatcher_type__ = "File"

    def __init__(self, conf):
        super(FileDispatcher, self).__init__(conf)
        self.log = None

        # if the directory and path are configured, then log to the file
        if CONF.dispatcher_file.file_path:
            dispatcher_logger = logging.Logger('dispatcher.file')
            dispatcher_logger.setLevel(logging.INFO)
            # create rotating file handler which logs result
            rfh = logging.handlers.RotatingFileHandler(
                self.conf.get('file_path', CONF.dispatcher_file.file_path),
                maxBytes=CONF.dispatcher_file.max_bytes,
                backupCount=CONF.dispatcher_file.backup_count,
                encoding='utf8')

            rfh.setLevel(logging.INFO)
            # Only wanted the data to be saved in the file, not the
            # project root logger.
            dispatcher_logger.propagate = False
            dispatcher_logger.addHandler(rfh)
            self.log = dispatcher_logger

    def record_result_data(self, data):
        if self.log:
            self.log.info(json.dumps(data))

    def flush_result_data(self):
        pass