1 ##############################################################################
2 # Copyright (c) 2015 Huawei Technologies Co.,Ltd and others.
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 ##############################################################################
16 from oslo_config import cfg
18 from yardstick.dispatcher.base import Base as DispatchBase
19 from yardstick.dispatcher.influxdb_line_protocol import make_lines
21 LOG = logging.getLogger(__name__)
24 influx_dispatcher_opts = [
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'),
32 help='The database name to store test results.'),
33 cfg.StrOpt('username',
35 help='The user name to access database.'),
36 cfg.StrOpt('password',
38 help='The user password to access database.'),
41 help='The max time in seconds to wait for a request to '
45 CONF.register_opts(influx_dispatcher_opts, group="dispatcher_influxdb")
48 class InfluxdbDispatcher(DispatchBase):
49 """Dispatcher class for posting data into an influxdb target.
52 __dispatcher_type__ = "Influxdb"
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)
66 self.runners_info = {}
68 "pod_name": os.environ.get('NODE_NAME', 'unknown'),
69 "installer": os.environ.get('INSTALLER_TYPE', 'unknown'),
70 "version": os.environ.get('YARDSTICK_VERSION', 'unknown')
73 def _dict_key_flatten(self, data):
76 if not [v for v in data.values()
77 if type(v) == dict or type(v) == list]:
80 for k, v in data.iteritems():
82 for n_k, n_v in v.iteritems():
83 next_data["%s.%s" % (k, n_k)] = n_v
85 for index, item in enumerate(v):
86 next_data["%s%d" % (k, index)] = item
90 return self._dict_key_flatten(next_data)
92 def _get_nano_timestamp(self, results):
94 timestamp = results["benchmark"]["timestamp"]
96 timestamp = time.time()
98 return str(int(float(timestamp) * 1000000000))
100 def _get_extended_tags(self, data):
101 runner_info = self.runners_info[data["runner_id"]]
103 "runner_id": data["runner_id"],
104 "task_id": self.task_id,
105 "scenarios": runner_info["scenarios"]
107 if "host" in runner_info:
108 tags["host"] = runner_info["host"]
109 if "target" in runner_info:
110 tags["target"] = runner_info["target"]
114 def _data_to_line_protocol(self, data):
117 point["measurement"] = self.tc
118 point["fields"] = self._dict_key_flatten(data["benchmark"]["data"])
119 point["time"] = self._get_nano_timestamp(data)
120 point["tags"] = self._get_extended_tags(data)
121 msg["points"] = [point]
122 msg["tags"] = self.static_tags
124 return make_lines(msg).encode('utf-8')
126 def record_result_data(self, data):
127 LOG.debug('Test result : %s' % json.dumps(data))
128 self.raw_result.append(data)
129 if self.target == '':
130 # if the target was not set, do not do anything
131 LOG.error('Dispatcher target was not set, no data will'
135 if isinstance(data, dict) and "scenario_cfg" in data:
136 self.tc = data["scenario_cfg"]["tc"]
137 self.task_id = data["scenario_cfg"]["task_id"]
138 scenario_cfg = data["scenario_cfg"]
139 runner_id = data["runner_id"]
140 self.runners_info[runner_id] = {"scenarios": scenario_cfg["type"]}
141 if "host" in scenario_cfg:
142 self.runners_info[runner_id]["host"] = scenario_cfg["host"]
143 if "target" in scenario_cfg:
144 self.runners_info[runner_id]["target"] = scenario_cfg["target"]
148 LOG.error('Test result : %s' % json.dumps(data))
149 LOG.error('The case_name cannot be found, no data will be posted.')
153 line = self._data_to_line_protocol(data)
154 LOG.debug('Test result line format : %s' % line)
155 res = requests.post(self.influxdb_url,
157 auth=(self.username, self.password),
158 timeout=self.timeout)
159 if res.status_code != 204:
160 LOG.error('Test result posting finished with status code'
161 ' %d.' % res.status_code)
162 except Exception as err:
163 LOG.exception('Failed to record result data: %s',
168 def flush_result_data(self):
169 LOG.debug('Test result all : %s' % json.dumps(self.raw_result))