"""Gauge watcher implementations."""
# Copyright (C) 2013 Nippon Telegraph and Telephone Corporation.
# Copyright (C) 2015 Brad Cowie, Christopher Lorier and Joe Stringer.
# Copyright (C) 2015 Research and Education Advanced Network New Zealand Ltd.
# Copyright (C) 2015--2017 The Contributors
#
# 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 json
import time
import gzip
from faucet.valve_util import dpid_log
from faucet.gauge_influx import GaugePortStateInfluxDBLogger, GaugePortStatsInfluxDBLogger, GaugeFlowTableInfluxDBLogger
from faucet.gauge_pollers import GaugePortStatePoller, GaugePortStatsPoller, GaugeFlowTablePoller
from faucet.gauge_prom import GaugePortStatsPrometheusPoller, GaugePortStatePrometheusPoller, GaugeFlowTablePrometheusPoller
[docs]def watcher_factory(conf):
"""Return a Gauge object based on type.
Args:
conf (GaugeConf): object with the configuration for this valve.
"""
WATCHER_TYPES = {
'port_state': {
'text': GaugePortStateLogger,
'influx': GaugePortStateInfluxDBLogger,
'prometheus': GaugePortStatePrometheusPoller,
},
'port_stats': {
'text': GaugePortStatsLogger,
'influx': GaugePortStatsInfluxDBLogger,
'prometheus': GaugePortStatsPrometheusPoller,
},
'flow_table': {
'text': GaugeFlowTableLogger,
'influx': GaugeFlowTableInfluxDBLogger,
'prometheus': GaugeFlowTablePrometheusPoller,
},
}
w_type = conf.type
db_type = conf.db_type
if w_type in WATCHER_TYPES and db_type in WATCHER_TYPES[w_type]:
return WATCHER_TYPES[w_type][db_type]
return None
def _rcv_time(rcv_time):
return time.strftime('%b %d %H:%M:%S', time.localtime(rcv_time))
[docs]class GaugePortStateLogger(GaugePortStatePoller):
"""Abstraction for port state logger."""
[docs] def update(self, rcv_time, dp_id, msg):
rcv_time_str = _rcv_time(rcv_time)
reason = msg.reason
port_no = msg.desc.port_no
ofp = msg.datapath.ofproto
log_msg = 'port %s unknown state %s' % (port_no, reason)
if reason == ofp.OFPPR_ADD:
log_msg = 'port %s added' % port_no
elif reason == ofp.OFPPR_DELETE:
log_msg = 'port %s deleted' % port_no
elif reason == ofp.OFPPR_MODIFY:
link_down = (msg.desc.state & ofp.OFPPS_LINK_DOWN)
if link_down:
log_msg = 'port %s down' % port_no
else:
log_msg = 'port %s up' % port_no
log_msg = '%s %s' % (dpid_log(dp_id), log_msg)
self.logger.info(log_msg)
if self.conf.file:
with open(self.conf.file, 'a') as logfile:
logfile.write('\t'.join((rcv_time_str, log_msg)) + '\n')
[docs] @staticmethod
def send_req():
"""Send a stats request to a datapath."""
raise NotImplementedError
[docs] @staticmethod
def no_response():
"""Called when a polling cycle passes without receiving a response."""
raise NotImplementedError
[docs]class GaugePortStatsLogger(GaugePortStatsPoller):
"""Abstraction for port statistics logger."""
@staticmethod
def _update_line(rcv_time_str, stat_name, stat_val):
return '\t'.join((rcv_time_str, stat_name, str(stat_val))) + '\n'
[docs] def update(self, rcv_time, dp_id, msg):
super(GaugePortStatsLogger, self).update(rcv_time, dp_id, msg)
rcv_time_str = _rcv_time(rcv_time)
for stat in msg.body:
port_name = self._stat_port_name(msg, stat, dp_id)
with open(self.conf.file, 'a') as logfile:
log_lines = []
for stat_name, stat_val in self._format_port_stats('-', stat):
dp_port_name = '-'.join((
self.dp.name, port_name, stat_name))
log_lines.append(
self._update_line(
rcv_time_str, dp_port_name, stat_val))
logfile.writelines(log_lines)
[docs]class GaugeFlowTableLogger(GaugeFlowTablePoller):
"""Periodically dumps the current datapath flow table as a yaml object.
Includes a timestamp and a reference ($DATAPATHNAME-flowtables). The
flow table is dumped as an OFFlowStatsReply message (in yaml format) that
matches all flows.
optionally the output can be compressed by setting compressed: true in the
config for this watcher
"""
[docs] def update(self, rcv_time, dp_id, msg):
super(GaugeFlowTableLogger, self).update(rcv_time, dp_id, msg)
#TODO: it might be good to aggregate all OFFlowStatsReplies somehow
rcv_time_str = _rcv_time(rcv_time)
jsondict = {}
jsondict['time'] = rcv_time_str
jsondict['ref'] = '-'.join((self.dp.name, 'flowtables'))
jsondict['msg'] = msg.to_jsondict()
filename = self.conf.file
outstr = '---\n{}\n'.format(json.dumps(jsondict))
if self.conf.compress:
with gzip.open(filename, 'at') as outfile:
outfile.write(outstr)
else:
with open(filename, 'a') as outfile:
outfile.write(outstr)