Report: Set range of x-axis for latency graphs, add data
[csit.git] / resources / tools / presentation / generator_plots.py
index cae334a..7298bab 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Cisco and/or its affiliates.
+# Copyright (c) 2021 Cisco and/or its affiliates.
 # 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:
 import re
 import logging
 
-from collections import OrderedDict
-from copy import deepcopy
-
 import hdrh.histogram
 import hdrh.codec
 import pandas as pd
 import plotly.offline as ploff
 import plotly.graph_objs as plgo
 
+from collections import OrderedDict
+from copy import deepcopy
+from math import log
+
 from plotly.exceptions import PlotlyError
 
 from pal_utils import mean, stdev
@@ -60,6 +61,9 @@ COLORS = (
 
 REGEX_NIC = re.compile(r'(\d*ge\dp\d\D*\d*[a-z]*)-')
 
+# This value depends on latency stream rate (9001 pps) and duration (5s).
+PERCENTILE_MAX = 99.9995
+
 
 def generate_plots(spec, data):
     """Generate all plots specified in the specification file.
@@ -76,7 +80,8 @@ def generate_plots(spec, data):
         u"plot_tsa_name": plot_tsa_name,
         u"plot_http_server_perf_box": plot_http_server_perf_box,
         u"plot_nf_heatmap": plot_nf_heatmap,
-        u"plot_hdrh_lat_by_percentile": plot_hdrh_lat_by_percentile
+        u"plot_hdrh_lat_by_percentile": plot_hdrh_lat_by_percentile,
+        u"plot_hdrh_lat_by_percentile_x_log": plot_hdrh_lat_by_percentile_x_log
     }
 
     logging.info(u"Generating the plots ...")
@@ -171,14 +176,10 @@ def plot_hdrh_lat_by_percentile(plot, input_data):
 
             for color, graph in enumerate(graphs):
                 for idx, direction in enumerate((u"direction1", u"direction2")):
-                    xaxis = [0.0, ]
-                    yaxis = [0.0, ]
-                    hovertext = [
-                        f"<b>{desc[graph]}</b><br>"
-                        f"Direction: {(u'W-E', u'E-W')[idx % 2]}<br>"
-                        f"Percentile: 0.0%<br>"
-                        f"Latency: 0.0uSec"
-                    ]
+                    previous_x = 0.0
+                    xaxis = list()
+                    yaxis = list()
+                    hovertext = list()
                     try:
                         decoded = hdrh.histogram.HdrHistogram.decode(
                             test[u"latency"][graph][direction][u"hdrh"]
@@ -191,16 +192,23 @@ def plot_hdrh_lat_by_percentile(plot, input_data):
 
                     for item in decoded.get_recorded_iterator():
                         percentile = item.percentile_level_iterated_to
-                        if percentile > 99.9:
-                            continue
+                        xaxis.append(previous_x)
+                        yaxis.append(item.value_iterated_to)
+                        hovertext.append(
+                            f"<b>{desc[graph]}</b><br>"
+                            f"Direction: {(u'W-E', u'E-W')[idx % 2]}<br>"
+                            f"Percentile: {previous_x:.5f}-{percentile:.5f}%<br>"
+                            f"Latency: {item.value_iterated_to}uSec"
+                        )
                         xaxis.append(percentile)
                         yaxis.append(item.value_iterated_to)
                         hovertext.append(
                             f"<b>{desc[graph]}</b><br>"
                             f"Direction: {(u'W-E', u'E-W')[idx % 2]}<br>"
-                            f"Percentile: {percentile:.5f}%<br>"
+                            f"Percentile: {previous_x:.5f}-{percentile:.5f}%<br>"
                             f"Latency: {item.value_iterated_to}uSec"
                         )
+                        previous_x = percentile
                     fig.add_trace(
                         plgo.Scatter(
                             x=xaxis,
@@ -211,7 +219,8 @@ def plot_hdrh_lat_by_percentile(plot, input_data):
                             showlegend=bool(idx),
                             line=dict(
                                 color=COLORS[color],
-                                dash=u"dash" if idx % 2 else u"solid"
+                                dash=u"solid",
+                                width=1 if idx % 2 else 2
                             ),
                             hovertext=hovertext,
                             hoverinfo=u"text"
@@ -253,6 +262,177 @@ def plot_hdrh_lat_by_percentile(plot, input_data):
             continue
 
 
+def plot_hdrh_lat_by_percentile_x_log(plot, input_data):
+    """Generate the plot(s) with algorithm: plot_hdrh_lat_by_percentile_x_log
+    specified in the specification file.
+
+    :param plot: Plot to generate.
+    :param input_data: Data to process.
+    :type plot: pandas.Series
+    :type input_data: InputData
+    """
+
+    # Transform the data
+    logging.info(
+        f"    Creating the data set for the {plot.get(u'type', u'')} "
+        f"{plot.get(u'title', u'')}."
+    )
+    if plot.get(u"include", None):
+        data = input_data.filter_tests_by_name(
+            plot,
+            params=[u"name", u"latency", u"parent", u"tags", u"type"]
+        )[0][0]
+    elif plot.get(u"filter", None):
+        data = input_data.filter_data(
+            plot,
+            params=[u"name", u"latency", u"parent", u"tags", u"type"],
+            continue_on_error=True
+        )[0][0]
+    else:
+        job = list(plot[u"data"].keys())[0]
+        build = str(plot[u"data"][job][0])
+        data = input_data.tests(job, build)
+
+    if data is None or len(data) == 0:
+        logging.error(u"No data.")
+        return
+
+    desc = {
+        u"LAT0": u"No-load.",
+        u"PDR10": u"Low-load, 10% PDR.",
+        u"PDR50": u"Mid-load, 50% PDR.",
+        u"PDR90": u"High-load, 90% PDR.",
+        u"PDR": u"Full-load, 100% PDR.",
+        u"NDR10": u"Low-load, 10% NDR.",
+        u"NDR50": u"Mid-load, 50% NDR.",
+        u"NDR90": u"High-load, 90% NDR.",
+        u"NDR": u"Full-load, 100% NDR."
+    }
+
+    graphs = [
+        u"LAT0",
+        u"PDR10",
+        u"PDR50",
+        u"PDR90"
+    ]
+
+    file_links = plot.get(u"output-file-links", None)
+    target_links = plot.get(u"target-links", None)
+
+    for test in data:
+        try:
+            if test[u"type"] not in (u"NDRPDR",):
+                logging.warning(f"Invalid test type: {test[u'type']}")
+                continue
+            name = re.sub(REGEX_NIC, u"", test[u"parent"].
+                          replace(u'-ndrpdr', u'').replace(u'2n1l-', u''))
+            try:
+                nic = re.search(REGEX_NIC, test[u"parent"]).group(1)
+            except (IndexError, AttributeError, KeyError, ValueError):
+                nic = u""
+            name_link = f"{nic}-{test[u'name']}".replace(u'-ndrpdr', u'')
+
+            logging.info(f"    Generating the graph: {name_link}")
+
+            fig = plgo.Figure()
+            layout = deepcopy(plot[u"layout"])
+
+            for color, graph in enumerate(graphs):
+                for idx, direction in enumerate((u"direction1", u"direction2")):
+                    previous_x = 0.0
+                    prev_perc = 0.0
+                    xaxis = list()
+                    yaxis = list()
+                    hovertext = list()
+                    try:
+                        decoded = hdrh.histogram.HdrHistogram.decode(
+                            test[u"latency"][graph][direction][u"hdrh"]
+                        )
+                    except hdrh.codec.HdrLengthException:
+                        logging.warning(
+                            f"No data for direction {(u'W-E', u'E-W')[idx % 2]}"
+                        )
+                        continue
+
+                    for item in decoded.get_recorded_iterator():
+                        # The real value is "percentile".
+                        # For 100%, we cut that down to "x_perc" to avoid
+                        # infinity.
+                        percentile = item.percentile_level_iterated_to
+                        x_perc = min(percentile, PERCENTILE_MAX)
+                        xaxis.append(previous_x)
+                        yaxis.append(item.value_iterated_to)
+                        hovertext.append(
+                            f"<b>{desc[graph]}</b><br>"
+                            f"Direction: {(u'W-E', u'E-W')[idx % 2]}<br>"
+                            f"Percentile: {prev_perc:.5f}-{percentile:.5f}%<br>"
+                            f"Latency: {item.value_iterated_to}uSec"
+                        )
+                        next_x = 100.0 / (100.0 - x_perc)
+                        xaxis.append(next_x)
+                        yaxis.append(item.value_iterated_to)
+                        hovertext.append(
+                            f"<b>{desc[graph]}</b><br>"
+                            f"Direction: {(u'W-E', u'E-W')[idx % 2]}<br>"
+                            f"Percentile: {prev_perc:.5f}-{percentile:.5f}%<br>"
+                            f"Latency: {item.value_iterated_to}uSec"
+                        )
+                        previous_x = next_x
+                        prev_perc = percentile
+                    fig.add_trace(
+                        plgo.Scatter(
+                            x=xaxis,
+                            y=yaxis,
+                            name=desc[graph],
+                            mode=u"lines",
+                            legendgroup=desc[graph],
+                            showlegend=not(bool(idx)),
+                            line=dict(
+                                color=COLORS[color],
+                                dash=u"solid",
+                                width=1 if idx % 2 else 2
+                            ),
+                            hovertext=hovertext,
+                            hoverinfo=u"text"
+                        )
+                    )
+
+            layout[u"title"][u"text"] = f"<b>Latency:</b> {name}"
+            layout[u"xaxis"][u"range"] = [0, 5.302]
+            fig.update_layout(layout)
+
+            # Create plot
+            file_name = f"{plot[u'output-file']}-{name_link}.html"
+            logging.info(f"    Writing file {file_name}")
+
+            try:
+                # Export Plot
+                ploff.plot(fig, show_link=False, auto_open=False,
+                           filename=file_name)
+                # Add link to the file:
+                if file_links and target_links:
+                    with open(file_links, u"a") as file_handler:
+                        file_handler.write(
+                            f"- `{name_link} "
+                            f"<{target_links}/{file_name.split(u'/')[-1]}>`_\n"
+                        )
+            except FileNotFoundError as err:
+                logging.error(
+                    f"Not possible to write the link to the file "
+                    f"{file_links}\n{err}"
+                )
+            except PlotlyError as err:
+                logging.error(f"   Finished with error: {repr(err)}")
+
+        except hdrh.codec.HdrLengthException as err:
+            logging.warning(repr(err))
+            continue
+
+        except (ValueError, KeyError) as err:
+            logging.warning(repr(err))
+            continue
+
+
 def plot_nf_reconf_box_name(plot, input_data):
     """Generate the plot(s) with algorithm: plot_nf_reconf_box_name
     specified in the specification file.
@@ -306,19 +486,21 @@ def plot_nf_reconf_box_name(plot, input_data):
     df_y = pd.DataFrame(y_vals)
     df_y.head()
     for i, col in enumerate(df_y.columns):
+
         tst_name = re.sub(REGEX_NIC, u"",
-                          col.lower().replace(u'-ndrpdr', u'').
-                          replace(u'2n1l-', u''))
+                          col.lower().replace(u'-reconf', u'').
+                          replace(u'2n1l-', u'').replace(u'2n-', u'').
+                          replace(u'-testpmd', u''))
 
         traces.append(plgo.Box(
             x=[str(i + 1) + u'.'] * len(df_y[col]),
-            y=[y if y else None for y in df_y[col]],
+            y=df_y[col],
             name=(
                 f"{i + 1}. "
                 f"({nr_of_samples[i]:02d} "
                 f"run{u's' if nr_of_samples[i] > 1 else u''}, "
                 f"packets lost average: {mean(loss[col]):.1f}) "
-                f"{u'-'.join(tst_name.split(u'-')[3:-2])}"
+                f"{u'-'.join(tst_name.split(u'-')[2:])}"
             ),
             hoverinfo=u"y+name"
         ))
@@ -380,54 +562,66 @@ def plot_perf_box_name(plot, input_data):
         multiplier = 1.0
     y_vals = OrderedDict()
     test_type = u""
-    for job in data:
-        for build in job:
-            for test in build:
-                if y_vals.get(test[u"parent"], None) is None:
-                    y_vals[test[u"parent"]] = list()
-                try:
-                    if test[u"type"] in (u"NDRPDR", ):
-                        test_type = u"NDRPDR"
-
-                        if u"-pdr" in plot_title:
-                            ttype = u"PDR"
-                        elif u"-ndr" in plot_title:
-                            ttype = u"NDR"
-                        else:
-                            raise RuntimeError(
-                                u"Wrong title. No information about test type. "
-                                u"Add '-ndr' or '-pdr' to the test title."
-                            )
 
-                        y_vals[test[u"parent"]].append(
-                            test[value][ttype][u"LOWER"] * multiplier
-                        )
-
-                    elif test[u"type"] in (u"SOAK", ):
-                        y_vals[test[u"parent"]].\
-                            append(test[u"throughput"][u"LOWER"])
-                        test_type = u"SOAK"
+    for item in plot.get(u"include", tuple()):
+        reg_ex = re.compile(str(item).lower())
+        for job in data:
+            for build in job:
+                for test_id, test in build.iteritems():
+                    if not re.match(reg_ex, str(test_id).lower()):
+                        continue
+                    if y_vals.get(test[u"parent"], None) is None:
+                        y_vals[test[u"parent"]] = list()
+                    try:
+                        if test[u"type"] in (u"NDRPDR", u"CPS"):
+                            test_type = test[u"type"]
+
+                            if u"-pdr" in plot_title:
+                                ttype = u"PDR"
+                            elif u"-ndr" in plot_title:
+                                ttype = u"NDR"
+                            else:
+                                raise RuntimeError(
+                                    u"Wrong title. No information about test "
+                                    u"type. Add '-ndr' or '-pdr' to the test "
+                                    u"title."
+                                )
 
-                    elif test[u"type"] in (u"HOSTSTACK", ):
-                        if u"LDPRELOAD" in test[u"tags"]:
-                            y_vals[test[u"parent"]].append(
-                                float(test[u"result"][u"bits_per_second"]) / 1e3
-                            )
-                        elif u"VPPECHO" in test[u"tags"]:
                             y_vals[test[u"parent"]].append(
-                                (float(test[u"result"][u"client"][u"tx_data"])
-                                 * 8 / 1e3) /
-                                ((float(test[u"result"][u"client"][u"time"]) +
-                                  float(test[u"result"][u"server"][u"time"])) /
-                                 2)
+                                test[value][ttype][u"LOWER"] * multiplier
                             )
-                        test_type = u"HOSTSTACK"
 
-                    else:
-                        continue
+                        elif test[u"type"] in (u"SOAK",):
+                            y_vals[test[u"parent"]]. \
+                                append(test[u"throughput"][u"LOWER"])
+                            test_type = u"SOAK"
+
+                        elif test[u"type"] in (u"HOSTSTACK",):
+                            if u"LDPRELOAD" in test[u"tags"]:
+                                y_vals[test[u"parent"]].append(
+                                    float(
+                                        test[u"result"][u"bits_per_second"]
+                                    ) / 1e3
+                                )
+                            elif u"VPPECHO" in test[u"tags"]:
+                                y_vals[test[u"parent"]].append(
+                                    (float(
+                                        test[u"result"][u"client"][u"tx_data"]
+                                    ) * 8 / 1e3) /
+                                    ((float(
+                                        test[u"result"][u"client"][u"time"]
+                                    ) +
+                                      float(
+                                          test[u"result"][u"server"][u"time"])
+                                      ) / 2)
+                                )
+                            test_type = u"HOSTSTACK"
 
-                except (KeyError, TypeError):
-                    y_vals[test[u"parent"]].append(None)
+                        else:
+                            continue
+
+                    except (KeyError, TypeError):
+                        y_vals[test[u"parent"]].append(None)
 
     # Add None to the lists with missing data
     max_len = 0
@@ -479,6 +673,8 @@ def plot_perf_box_name(plot, input_data):
         if layout.get(u"title", None):
             if test_type in (u"HOSTSTACK", ):
                 layout[u"title"] = f"<b>Bandwidth:</b> {layout[u'title']}"
+            elif test_type in (u"CPS", ):
+                layout[u"title"] = f"<b>CPS:</b> {layout[u'title']}"
             else:
                 layout[u"title"] = f"<b>Throughput:</b> {layout[u'title']}"
         if y_max:
@@ -536,37 +732,43 @@ def plot_tsa_name(plot, input_data):
         multiplier = 1.0
 
     y_vals = OrderedDict()
-    for job in data:
-        for build in job:
-            for test in build:
-                if y_vals.get(test[u"parent"], None) is None:
-                    y_vals[test[u"parent"]] = {
-                        u"1": list(),
-                        u"2": list(),
-                        u"4": list()
-                    }
-                try:
-                    if test[u"type"] not in (u"NDRPDR",):
-                        continue
-
-                    if u"-pdr" in plot_title:
-                        ttype = u"PDR"
-                    elif u"-ndr" in plot_title:
-                        ttype = u"NDR"
-                    else:
-                        continue
-
-                    if u"1C" in test[u"tags"]:
-                        y_vals[test[u"parent"]][u"1"]. \
-                            append(test[value][ttype][u"LOWER"] * multiplier)
-                    elif u"2C" in test[u"tags"]:
-                        y_vals[test[u"parent"]][u"2"]. \
-                            append(test[value][ttype][u"LOWER"] * multiplier)
-                    elif u"4C" in test[u"tags"]:
-                        y_vals[test[u"parent"]][u"4"]. \
-                            append(test[value][ttype][u"LOWER"] * multiplier)
-                except (KeyError, TypeError):
-                    pass
+    for item in plot.get(u"include", tuple()):
+        reg_ex = re.compile(str(item).lower())
+        for job in data:
+            for build in job:
+                for test_id, test in build.iteritems():
+                    if re.match(reg_ex, str(test_id).lower()):
+                        if y_vals.get(test[u"parent"], None) is None:
+                            y_vals[test[u"parent"]] = {
+                                u"1": list(),
+                                u"2": list(),
+                                u"4": list()
+                            }
+                        try:
+                            if test[u"type"] not in (u"NDRPDR", u"CPS"):
+                                continue
+
+                            if u"-pdr" in plot_title:
+                                ttype = u"PDR"
+                            elif u"-ndr" in plot_title:
+                                ttype = u"NDR"
+                            else:
+                                continue
+
+                            if u"1C" in test[u"tags"]:
+                                y_vals[test[u"parent"]][u"1"].append(
+                                    test[value][ttype][u"LOWER"] * multiplier
+                                )
+                            elif u"2C" in test[u"tags"]:
+                                y_vals[test[u"parent"]][u"2"].append(
+                                    test[value][ttype][u"LOWER"] * multiplier
+                                )
+                            elif u"4C" in test[u"tags"]:
+                                y_vals[test[u"parent"]][u"4"].append(
+                                    test[value][ttype][u"LOWER"] * multiplier
+                                )
+                        except (KeyError, TypeError):
+                            pass
 
     if not y_vals:
         logging.warning(f"No data for the plot {plot.get(u'title', u'')}")
@@ -682,7 +884,7 @@ def plot_tsa_name(plot, input_data):
     x_vals = [1, 2, 4]
 
     # Limits:
-    if u"-gbps" not in plot_title:
+    if u"-gbps" not in plot_title and u"-cps-" not in plot_title:
         nic_limit /= 1e6
         lnk_limit /= 1e6
         pci_limit /= 1e6