yardstick/dispatcher/influxdb.py

   1 ##############################################################################
   2 # Copyright (c) 2015 Huawei Technologies Co.,Ltd and others.
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9
  10 import os
  11 import json
  12 import logging
  13 import requests
  14 import time
  15
  16 from oslo_config import cfg
  17
  18 from yardstick.dispatcher.base import Base as DispatchBase
  19 from yardstick.dispatcher.influxdb_line_protocol import make_lines
  20
  21 LOG = logging.getLogger(__name__)
  22
  23 CONF = cfg.CONF
  24 influx_dispatcher_opts = [
  25     cfg.StrOpt('target',
  26                default='http://127.0.0.1:8086',
  27                help='The target where the http request will be sent. '
  28                     'If this is not set, no data will be posted. For '
  29                     'example: target = http://hostname:1234/path'),
  30     cfg.StrOpt('db_name',
  31                default='yardstick',
  32                help='The database name to store test results.'),
  33     cfg.StrOpt('username',
  34                default='root',
  35                help='The user name to access database.'),
  36     cfg.StrOpt('password',
  37                default='root',
  38                help='The user password to access database.'),
  39     cfg.IntOpt('timeout',
  40                default=5,
  41                help='The max time in seconds to wait for a request to '
  42                     'timeout.'),
  43 ]
  44
  45 CONF.register_opts(influx_dispatcher_opts, group="dispatcher_influxdb")
  46
  47
  48 class InfluxdbDispatcher(DispatchBase):
  49     """Dispatcher class for posting data into an influxdb target.
  50     """
  51
  52     __dispatcher_type__ = "Influxdb"
  53
  54     def __init__(self, conf):
  55         super(InfluxdbDispatcher, self).__init__(conf)
  56         self.timeout = CONF.dispatcher_influxdb.timeout
  57         self.target = CONF.dispatcher_influxdb.target
  58         self.db_name = CONF.dispatcher_influxdb.db_name
  59         self.username = CONF.dispatcher_influxdb.username
  60         self.password = CONF.dispatcher_influxdb.password
  61         self.influxdb_url = "%s/write?db=%s" % (self.target, self.db_name)
  62         self.raw_result = []
  63         self.case_name = ""
  64         self.tc = ""
  65         self.task_id = -1
  66         self.runners_info = {}
  67         self.static_tags = {
  68             "pod_name": os.environ.get('NODE_NAME', 'unknown'),
  69             "installer": os.environ.get('INSTALLER_TYPE', 'unknown'),
  70             "deploy_scenario": os.environ.get('DEPLOY_SCENARIO', 'unknown'),
  71             "version": os.environ.get('YARDSTICK_VERSION', 'unknown')
  72         }
  73
  74     def _dict_key_flatten(self, data):
  75         next_data = {}
  76
  77         if not [v for v in data.values()
  78                 if type(v) == dict or type(v) == list]:
  79             return data
  80
  81         for k, v in data.iteritems():
  82             if type(v) == dict:
  83                 for n_k, n_v in v.iteritems():
  84                     next_data["%s.%s" % (k, n_k)] = n_v
  85             elif type(v) == list:
  86                 for index, item in enumerate(v):
  87                     next_data["%s%d" % (k, index)] = item
  88             else:
  89                 next_data[k] = v
  90
  91         return self._dict_key_flatten(next_data)
  92
  93     def _get_nano_timestamp(self, results):
  94         try:
  95             timestamp = results["benchmark"]["timestamp"]
  96         except Exception:
  97             timestamp = time.time()
  98
  99         return str(int(float(timestamp) * 1000000000))
 100
 101     def _get_extended_tags(self, data):
 102         runner_info = self.runners_info[data["runner_id"]]
 103         tags = {
 104             "runner_id": data["runner_id"],
 105             "task_id": self.task_id,
 106             "scenarios": runner_info["scenarios"]
 107         }
 108         if "host" in runner_info:
 109             tags["host"] = runner_info["host"]
 110         if "target" in runner_info:
 111             tags["target"] = runner_info["target"]
 112
 113         return tags
 114
 115     def _data_to_line_protocol(self, data):
 116         msg = {}
 117         point = {}
 118         point["measurement"] = self.tc
 119         point["fields"] = self._dict_key_flatten(data["benchmark"]["data"])
 120         point["time"] = self._get_nano_timestamp(data)
 121         point["tags"] = self._get_extended_tags(data)
 122         msg["points"] = [point]
 123         msg["tags"] = self.static_tags
 124
 125         return make_lines(msg).encode('utf-8')
 126
 127     def record_result_data(self, data):
 128         LOG.debug('Test result : %s' % json.dumps(data))
 129         self.raw_result.append(data)
 130         if self.target == '':
 131             # if the target was not set, do not do anything
 132             LOG.error('Dispatcher target was not set, no data will'
 133                       'be posted.')
 134             return -1
 135
 136         if isinstance(data, dict) and "scenario_cfg" in data:
 137             self.tc = data["scenario_cfg"]["tc"]
 138             self.task_id = data["scenario_cfg"]["task_id"]
 139             scenario_cfg = data["scenario_cfg"]
 140             runner_id = data["runner_id"]
 141             self.runners_info[runner_id] = {"scenarios": scenario_cfg["type"]}
 142             if "host" in scenario_cfg:
 143                 self.runners_info[runner_id]["host"] = scenario_cfg["host"]
 144             if "target" in scenario_cfg:
 145                 self.runners_info[runner_id]["target"] = scenario_cfg["target"]
 146             return 0
 147
 148         if self.tc == "":
 149             LOG.error('Test result : %s' % json.dumps(data))
 150             LOG.error('The case_name cannot be found, no data will be posted.')
 151             return -1
 152
 153         try:
 154             line = self._data_to_line_protocol(data)
 155             LOG.debug('Test result line format : %s' % line)
 156             res = requests.post(self.influxdb_url,
 157                                 data=line,
 158                                 auth=(self.username, self.password),
 159                                 timeout=self.timeout)
 160             if res.status_code != 204:
 161                 LOG.error('Test result posting finished with status code'
 162                           ' %d.' % res.status_code)
 163                 LOG.error(res.text)
 164
 165         except Exception as err:
 166             LOG.exception('Failed to record result data: %s',
 167                           err)
 168             return -1
 169         return 0
 170
 171     def flush_result_data(self):
 172         LOG.debug('Test result all : %s' % json.dumps(self.raw_result))
 173         return 0