Passed
Push — master ( 0a5ad3...adbf5d )
by
unknown
02:15 queued 13s
created

build.main.Main.bytes_count_per_flow()   A

Complexity

Conditions 1

Size

Total Lines 7
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 3
CRAP Score 1

Importance

Changes 0
Metric Value
eloc 6
dl 0
loc 7
rs 10
c 0
b 0
f 0
ccs 3
cts 3
cp 1
cc 1
nop 2
crap 1
1
"""Main module of amlight/flow_stats Kytos Network Application.
2
3
This NApp does operations with flows not covered by Kytos itself.
4
"""
5
# pylint: disable=too-many-return-statements,too-many-instance-attributes
6
# pylint: disable=too-many-arguments,too-many-branches,too-many-statements
7
8 1
from flask import jsonify, request
9 1
from kytos.core import KytosNApp, log, rest
10 1
from kytos.core.helpers import listen_to
11
12
13
# pylint: disable=too-many-public-methods
14 1
class Main(KytosNApp):
15
    """Main class of amlight/flow_stats NApp.
16
    This class is the entry point for this napp.
17
    """
18
19 1
    def setup(self):
20
        """Replace the '__init__' method for the KytosNApp subclass.
21
        The setup method is automatically called by the controller when your
22
        application is loaded.
23
        So, if you have any setup routine, insert it here.
24
        """
25 1
        log.info('Starting Kytos/Amlight flow manager')
26 1
        self.flows_stats_dict = {}
27
28 1
    def execute(self):
29
        """This method is executed right after the setup method execution.
30
        You can also use this method in loop mode if you add to the above setup
31
        method a line like the following example:
32
            self.execute_as_loop(30)  # 30-second interval.
33
        """
34
35 1
    def shutdown(self):
36
        """This method is executed when your napp is unloaded.
37
        If you have some cleanup procedure, insert it here.
38
        """
39
40 1
    def flow_from_id(self, flow_id):
41
        """Flow from given flow_id."""
42 1
        return self.flows_stats_dict.get(flow_id)
43
44 1
    def flow_stats_by_dpid_flow_id(self, dpids):
45
        """ Auxiliar funcion for v1/flow/stats endpoint implementation.
46
        """
47 1
        flow_stats_by_id = {}
48 1
        flows_stats_dict_copy = self.flows_stats_dict.copy()
49 1
        for flow_id, flow in flows_stats_dict_copy.items():
50
            dpid = flow.switch.dpid
51
            if dpid in dpids:
52
                if dpid not in flow_stats_by_id:
53
                    flow_stats_by_id[dpid] = {}
54
                info_flow_as_dict = flow.stats.as_dict()
55
                info_flow_as_dict.update({"cookie": flow.cookie})
56
                info_flow_as_dict.update({"priority": flow.priority})
57
                info_flow_as_dict.update({"match": flow.match.as_dict()})
58
                flow_stats_by_id[dpid].update({flow_id: info_flow_as_dict})
59 1
        return flow_stats_by_id
60
61 1
    @rest('v1/flow/stats')
62 1
    def flow_stats(self):
63
        """Return the flows stats by dpid.
64
        Return the stats of all flows if dpid is None
65
        """
66 1
        args = request.args
67 1
        dpids = args.getlist("dpid", type=str)
68 1
        if len(dpids) == 0:
69 1
            dpids = [sw.dpid for sw in self.controller.switches.values()]
70 1
        flow_stats_by_id = self.flow_stats_by_dpid_flow_id(dpids)
71 1
        return jsonify(flow_stats_by_id)
72
73 1
    @rest('v1/packet_count/<flow_id>')
74 1
    def packet_count(self, flow_id):
75
        """Packet count of an specific flow."""
76 1
        flow = self.flow_from_id(flow_id)
77 1
        if flow is None:
78 1
            return "Flow does not exist", 404
79 1
        packet_stats = {
80
            'flow_id': flow_id,
81
            'packet_counter': flow.stats.packet_count,
82
            'packet_per_second':
83
                flow.stats.packet_count / flow.stats.duration_sec
84
            }
85 1
        return jsonify(packet_stats)
86
87 1
    @rest('v1/bytes_count/<flow_id>')
88 1
    def bytes_count(self, flow_id):
89
        """Bytes count of an specific flow."""
90 1
        flow = self.flow_from_id(flow_id)
91 1
        if flow is None:
92 1
            return "Flow does not exist", 404
93 1
        bytes_stats = {
94
            'flow_id': flow_id,
95
            'bytes_counter': flow.stats.byte_count,
96
            'bits_per_second':
97
                flow.stats.byte_count * 8 / flow.stats.duration_sec
98
            }
99 1
        return jsonify(bytes_stats)
100
101 1
    @rest('v1/packet_count/per_flow/<dpid>')
102 1
    def packet_count_per_flow(self, dpid):
103
        """Per flow packet count."""
104 1
        return self.flows_counters('packet_count',
105
                                   dpid,
106
                                   counter='packet_counter',
107
                                   rate='packet_per_second')
108
109 1
    @rest('v1/bytes_count/per_flow/<dpid>')
110 1
    def bytes_count_per_flow(self, dpid):
111
        """Per flow bytes count."""
112 1
        return self.flows_counters('byte_count',
113
                                   dpid,
114
                                   counter='bytes_counter',
115
                                   rate='bits_per_second')
116
117 1
    def flows_counters(self, field, dpid, counter=None, rate=None,
118
                       total=False):
119
        """Calculate flows statistics.
120
        The returned statistics are both per flow and for the sum of flows
121
        """
122
123 1
        if total:
124
            count_flows = 0
125
        else:
126 1
            count_flows = []
127 1
            if not counter:
128 1
                counter = field
129 1
            if not rate:
130 1
                rate = field
131
132
        # We don't have statistics persistence yet, so for now this only works
133
        # for start and end equals to zero
134 1
        flows = self.flow_stats_by_dpid_flow_id([dpid])
135 1
        flows = flows.get(dpid)
136
137 1
        if flows is None:
138 1
            return jsonify(count_flows)
139 1
        for flow_id, stats in flows.items():
140 1
            count = stats[field]
141 1
            if total:
142
                count_flows += count
143
            else:
144 1
                per_second = count / stats['duration_sec']
145 1
                if rate.startswith('bits'):
146 1
                    per_second *= 8
147 1
                count_flows.append({'flow_id': flow_id,
148
                                    counter: count,
149
                                    rate: per_second})
150 1
        return jsonify(count_flows)
151
152 1
    @listen_to('kytos/of_core.flow_stats.received')
153 1
    def on_stats_received(self, event):
154
        """Capture flow stats messages for OpenFlow 1.3."""
155
        self.handle_stats_received(event)
156
157 1
    def handle_stats_received(self, event):
158
        """Handle flow stats messages for OpenFlow 1.3."""
159 1
        if 'replies_flows' in event.content:
160 1
            replies_flows = event.content['replies_flows']
161 1
            self.handle_stats_reply_received(replies_flows)
162
163 1
    def handle_stats_reply_received(self, replies_flows):
164
        """Update the set of flows stats"""
165
        self.flows_stats_dict.update({flow.id: flow for flow in replies_flows})
166