# See the License for the specific language governing permissions and
# limitations under the License.
-"""Plotly Dash HTML layout override."""
-
-html_layout = """
-<!DOCTYPE html>
- <html>
- <head>
- {%metas%}
- <title>{%title%}</title>
- {%favicon%}
- {%css%}
- </head>
- <body class="dash-template">
- <header>
- <div class="nav-wrapper">
- <a href="/">
- <h1>Continuous Performance Trending</h1>
- </a>
- <nav>
- </nav>
- </div>
- </header>
- {%app_entry%}
- <footer>
- {%config%}
- {%scripts%}
- {%renderer%}
- </footer>
- </body>
- </html>
+"""Plotly Dash HTML layout override.
"""
+
+import pandas as pd
+
+from dash import dcc
+from dash import html
+from dash import callback_context, no_update
+from dash import Input, Output, State
+from dash.exceptions import PreventUpdate
+import dash_bootstrap_components as dbc
+from yaml import load, FullLoader, YAMLError
+from datetime import datetime, timedelta
+
+from ..data.data import Data
+from .graphs import graph_trending, graph_hdrh_latency, \
+ select_trending_data
+
+
+class Layout:
+ """
+ """
+
+ NO_GRAPH = {"data": [], "layout": {}, "frames": []}
+
+ def __init__(self, app, html_layout_file, spec_file, graph_layout_file,
+ data_spec_file):
+ """
+ """
+
+ # Inputs
+ self._app = app
+ self._html_layout_file = html_layout_file
+ self._spec_file = spec_file
+ self._graph_layout_file = graph_layout_file
+ self._data_spec_file = data_spec_file
+
+ # Read the data:
+ data_mrr = Data(
+ data_spec_file=self._data_spec_file,
+ debug=True
+ ).read_trending_mrr(days=5)
+
+ data_ndrpdr = Data(
+ data_spec_file=self._data_spec_file,
+ debug=True
+ ).read_trending_ndrpdr(days=14)
+
+ self._data = pd.concat([data_mrr, data_ndrpdr], ignore_index=True)
+
+ # Read from files:
+ self._html_layout = ""
+ self._spec_tbs = None
+ self._graph_layout = None
+
+ try:
+ with open(self._html_layout_file, "r") as file_read:
+ self._html_layout = file_read.read()
+ except IOError as err:
+ raise RuntimeError(
+ f"Not possible to open the file {self._html_layout_file}\n{err}"
+ )
+
+ try:
+ with open(self._spec_file, "r") as file_read:
+ self._spec_tbs = load(file_read, Loader=FullLoader)
+ except IOError as err:
+ raise RuntimeError(
+ f"Not possible to open the file {self._spec_file,}\n{err}"
+ )
+ except YAMLError as err:
+ raise RuntimeError(
+ f"An error occurred while parsing the specification file "
+ f"{self._spec_file,}\n"
+ f"{err}"
+ )
+
+ try:
+ with open(self._graph_layout_file, "r") as file_read:
+ self._graph_layout = load(file_read, Loader=FullLoader)
+ except IOError as err:
+ raise RuntimeError(
+ f"Not possible to open the file {self._graph_layout_file}\n"
+ f"{err}"
+ )
+ except YAMLError as err:
+ raise RuntimeError(
+ f"An error occurred while parsing the specification file "
+ f"{self._graph_layout_file}\n"
+ f"{err}"
+ )
+
+ # Callbacks:
+ if self._app is not None and hasattr(self, 'callbacks'):
+ self.callbacks(self._app)
+
+ @property
+ def html_layout(self):
+ return self._html_layout
+
+ @property
+ def spec_tbs(self):
+ return self._spec_tbs
+
+ @property
+ def data(self):
+ return self._data
+
+ @property
+ def layout(self):
+ return self._graph_layout
+
+ def add_content(self):
+ """
+ """
+ if self.html_layout and self.spec_tbs:
+ return html.Div(
+ id="div-main",
+ children=[
+ dbc.Row(
+ id="row-navbar",
+ class_name="g-0",
+ children=[
+ self._add_navbar(),
+ ]
+ ),
+ dcc.Loading(
+ dbc.Offcanvas(
+ id="offcanvas-metadata",
+ title="Throughput And Latency",
+ placement="end",
+ is_open=False,
+ children=[
+ dbc.Row(id="metadata-tput-lat"),
+ dbc.Row(id="metadata-hdrh-graph"),
+ ]
+ )
+ ),
+ dbc.Row(
+ id="row-main",
+ class_name="g-0 p-2",
+ children=[
+ dcc.Store(
+ id="selected-tests"
+ ),
+ self._add_ctrl_col(),
+ self._add_plotting_col(),
+ ]
+ )
+ ]
+ )
+ else:
+ return html.Div(
+ id="div-main-error",
+ children=[
+ dbc.Alert(
+ [
+ "An Error Occured",
+ ],
+ color="danger",
+ ),
+ ]
+ )
+
+ def _add_navbar(self):
+ """Add nav element with navigation panel. It is placed on the top.
+ """
+ return dbc.NavbarSimple(
+ id="navbarsimple-main",
+ children=[
+ dbc.NavItem(
+ dbc.NavLink(
+ "Continuous Performance Trending",
+ disabled=True,
+ external_link=True,
+ href="#"
+ )
+ )
+ ],
+ brand="Dashboard",
+ brand_href="/",
+ brand_external_link=True,
+ class_name="p-2",
+ fluid=True,
+ )
+
+ def _add_ctrl_col(self) -> dbc.Col:
+ """Add column with controls. It is placed on the left side.
+ """
+ return dbc.Col(
+ id="col-controls",
+ children=[
+ self._add_ctrl_panel(),
+ self._add_ctrl_shown()
+ ],
+ )
+
+ def _add_plotting_col(self) -> dbc.Col:
+ """Add column with plots and tables. It is placed on the right side.
+ """
+ return dbc.Col(
+ id="col-plotting-area",
+ children=[
+ dbc.Row( # Throughput
+ id="row-graph-tput",
+ class_name="g-0 p-2",
+ children=[
+ dcc.Loading(
+ dcc.Graph(id="graph-tput")
+ )
+ ]
+ ),
+ dbc.Row( # Latency
+ id="row-graph-lat",
+ class_name="g-0 p-2",
+ children=[
+ dcc.Loading(
+ dcc.Graph(id="graph-latency")
+ )
+ ]
+ ),
+ dbc.Row( # Download
+ id="div-download",
+ class_name="g-0",
+ children=[
+ dcc.Loading(children=[
+ dbc.Button(
+ id="btn-download-data",
+ children=["Download Data"]
+ ),
+ dcc.Download(id="download-data")
+ ])
+ ]
+ )
+ ],
+ width=9,
+ )
+
+ def _add_ctrl_panel(self) -> dbc.Row:
+ """
+ """
+ return dbc.Row(
+ id="row-ctrl-panel",
+ class_name="g-0",
+ children=[
+ dbc.Label("Physical Test Bed Topology, NIC and Driver"),
+ dbc.Select(
+ id="dd-ctrl-phy",
+ className="p-2",
+ placeholder="Select a Physical Test Bed Topology...",
+ options=[
+ {"label": k, "value": k} for k in self.spec_tbs.keys()
+ ],
+ size="sm",
+ ),
+ dbc.Label("Area"),
+ dbc.Select(
+ id="dd-ctrl-area",
+ className="p-2",
+ placeholder="Select an Area...",
+ disabled=True,
+ size="sm",
+ ),
+ dbc.Label("Test"),
+ dbc.Select(
+ id="dd-ctrl-test",
+ className="p-2",
+ placeholder="Select a Test...",
+ disabled=True,
+ size="sm",
+ ),
+ dbc.Row(
+ id="row-ctrl-core",
+ class_name="g-0",
+ children=[
+ dbc.Label("Number of Cores"),
+ dbc.Col([
+ dbc.Checklist(
+ id="cl-ctrl-core-all",
+ options=[{"label": "All", "value": "all"}, ],
+ inline=False,
+ switch=False
+ ),
+ ], width=3),
+ dbc.Col([
+ dbc.Checklist(
+ id="cl-ctrl-core",
+ inline=True,
+ switch=False
+ )
+ ])
+ ]
+ ),
+ dbc.Row(
+ id="row-ctrl-framesize",
+ class_name="g-0",
+ children=[
+ dbc.Label("Frame Size"),
+ dbc.Col([
+ dbc.Checklist(
+ id="cl-ctrl-framesize-all",
+ options=[{"label": "All", "value": "all"}, ],
+ inline=True,
+ switch=False
+ ),
+ ], width=3),
+ dbc.Col([
+ dbc.Checklist(
+ id="cl-ctrl-framesize",
+ inline=True,
+ switch=False
+ )
+ ])
+ ]
+ ),
+ dbc.Row(
+ id="row-ctrl-testtype",
+ class_name="g-0",
+ children=[
+ dbc.Label("Test Type"),
+ dbc.Col([
+ dbc.Checklist(
+ id="cl-ctrl-testtype-all",
+ options=[{"label": "All", "value": "all"}, ],
+ inline=True,
+ switch=False
+ ),
+ ], width=3),
+ dbc.Col([
+ dbc.Checklist(
+ id="cl-ctrl-testtype",
+ inline=True,
+ switch=False
+ )
+ ])
+ ]
+ ),
+ dbc.Row(
+ class_name="g-0",
+ children=[
+ dbc.Button(
+ id="btn-ctrl-add",
+ children="Add",
+ )
+ ]
+ ),
+ dbc.Row(
+ class_name="g-0",
+ children=[
+ dcc.DatePickerRange(
+ id="dpr-period",
+ min_date_allowed=\
+ datetime.utcnow()-timedelta(days=180),
+ max_date_allowed=datetime.utcnow(),
+ initial_visible_month=datetime.utcnow(),
+ start_date=datetime.utcnow() - timedelta(days=180),
+ end_date=datetime.utcnow(),
+ display_format="D MMMM YY"
+ )
+ ]
+ )
+ ]
+ )
+
+ def _add_ctrl_shown(self) -> dbc.Row:
+ """
+ """
+ return dbc.Row(
+ id="div-ctrl-shown",
+ class_name="g-0",
+ children=[
+ dbc.Row(
+ class_name="g-0",
+ children=[
+ dbc.Label("Selected tests"),
+ dbc.Checklist(
+ id="cl-selected",
+ options=[],
+ inline=False
+ )
+ ]
+ ),
+ dbc.Row(
+ class_name="g-0",
+ children=[
+ dbc.ButtonGroup(
+ [
+ dbc.Button(
+ id="btn-sel-remove-all",
+ children="Remove All",
+ color="secondary",
+ disabled=False
+ ),
+ dbc.Button(
+ id="btn-sel-remove",
+ children="Remove Selected",
+ color="secondary",
+ disabled=False
+ ),
+ dbc.Button(
+ id="btn-sel-display",
+ children="Display",
+ color="secondary",
+ disabled=False
+ )
+ ],
+ size="md",
+ class_name="me-1",
+ ),
+ ]
+ )
+ ]
+ )
+
+ def callbacks(self, app):
+
+ @app.callback(
+ Output("dd-ctrl-area", "options"),
+ Output("dd-ctrl-area", "disabled"),
+ Input("dd-ctrl-phy", "value"),
+ )
+ def _update_dd_area(phy):
+ """
+ """
+
+ if phy is None:
+ raise PreventUpdate
+
+ try:
+ options = [
+ {"label": self.spec_tbs[phy][v]["label"], "value": v}
+ for v in [v for v in self.spec_tbs[phy].keys()]
+ ]
+ disable = False
+ except KeyError:
+ options = list()
+ disable = True
+
+ return options, disable
+
+ @app.callback(
+ Output("dd-ctrl-test", "options"),
+ Output("dd-ctrl-test", "disabled"),
+ State("dd-ctrl-phy", "value"),
+ Input("dd-ctrl-area", "value"),
+ )
+ def _update_dd_test(phy, area):
+ """
+ """
+
+ if not area:
+ raise PreventUpdate
+
+ try:
+ options = [
+ {"label": v, "value": v}
+ for v in self.spec_tbs[phy][area]["test"]
+ ]
+ disable = False
+ except KeyError:
+ options = list()
+ disable = True
+
+ return options, disable
+
+ @app.callback(
+ Output("cl-ctrl-core", "options"),
+ Output("cl-ctrl-framesize", "options"),
+ Output("cl-ctrl-testtype", "options"),
+ State("dd-ctrl-phy", "value"),
+ State("dd-ctrl-area", "value"),
+ Input("dd-ctrl-test", "value"),
+ )
+ def _update_btn_add(phy, area, test):
+ """
+ """
+
+ if test is None:
+ raise PreventUpdate
+
+ core_opts = []
+ framesize_opts = []
+ testtype_opts = []
+ if phy and area and test:
+ core_opts = [
+ {"label": v, "value": v}
+ for v in self.spec_tbs[phy][area]["core"]
+ ]
+ framesize_opts = [
+ {"label": v, "value": v}
+ for v in self.spec_tbs[phy][area]["frame-size"]
+ ]
+ testtype_opts = [
+ {"label": v, "value": v}
+ for v in self.spec_tbs[phy][area]["test-type"]
+ ]
+
+ return (
+ core_opts,
+ framesize_opts,
+ testtype_opts,
+ )
+
+ def _sync_checklists(opt, sel, all, id):
+ """
+ """
+ options = {v["value"] for v in opt}
+ input_id = callback_context.triggered[0]["prop_id"].split(".")[0]
+ if input_id == id:
+ all = ["all"] if set(sel) == options else list()
+ else:
+ sel = list(options) if all else list()
+ return sel, all
+
+ @app.callback(
+ Output("cl-ctrl-core", "value"),
+ Output("cl-ctrl-core-all", "value"),
+ State("cl-ctrl-core", "options"),
+ Input("cl-ctrl-core", "value"),
+ Input("cl-ctrl-core-all", "value"),
+ prevent_initial_call=True
+ )
+ def _sync_cl_core(opt, sel, all):
+ return _sync_checklists(opt, sel, all, "cl-ctrl-core")
+
+ @app.callback(
+ Output("cl-ctrl-framesize", "value"),
+ Output("cl-ctrl-framesize-all", "value"),
+ State("cl-ctrl-framesize", "options"),
+ Input("cl-ctrl-framesize", "value"),
+ Input("cl-ctrl-framesize-all", "value"),
+ prevent_initial_call=True
+ )
+ def _sync_cl_framesize(opt, sel, all):
+ return _sync_checklists(opt, sel, all, "cl-ctrl-framesize")
+
+ @app.callback(
+ Output("cl-ctrl-testtype", "value"),
+ Output("cl-ctrl-testtype-all", "value"),
+ State("cl-ctrl-testtype", "options"),
+ Input("cl-ctrl-testtype", "value"),
+ Input("cl-ctrl-testtype-all", "value"),
+ prevent_initial_call=True
+ )
+ def _sync_cl_testtype(opt, sel, all):
+ return _sync_checklists(opt, sel, all, "cl-ctrl-testtype")
+
+ @app.callback(
+ Output("graph-tput", "figure"),
+ Output("graph-latency", "figure"),
+ Output("selected-tests", "data"), # Store
+ Output("cl-selected", "options"), # User selection
+ Output("dd-ctrl-phy", "value"),
+ Output("dd-ctrl-area", "value"),
+ Output("dd-ctrl-test", "value"),
+ State("selected-tests", "data"), # Store
+ State("cl-selected", "value"),
+ State("dd-ctrl-phy", "value"),
+ State("dd-ctrl-area", "value"),
+ State("dd-ctrl-test", "value"),
+ State("cl-ctrl-core", "value"),
+ State("cl-ctrl-framesize", "value"),
+ State("cl-ctrl-testtype", "value"),
+ Input("btn-ctrl-add", "n_clicks"),
+ Input("btn-sel-display", "n_clicks"),
+ Input("btn-sel-remove", "n_clicks"),
+ Input("btn-sel-remove-all", "n_clicks"),
+ Input("dpr-period", "start_date"),
+ Input("dpr-period", "end_date"),
+ prevent_initial_call=True
+ )
+ def _process_list(store_sel, list_sel, phy, area, test, cores,
+ framesizes, testtypes, btn_add, btn_display, btn_remove,
+ btn_remove_all, d_start, d_end):
+ """
+ """
+
+ if not (btn_add or btn_display or btn_remove or btn_remove_all or \
+ d_start or d_end):
+ raise PreventUpdate
+
+ def _list_tests():
+ # Display selected tests with checkboxes:
+ if store_sel:
+ return [
+ {"label": v["id"], "value": v["id"]} for v in store_sel
+ ]
+ else:
+ return list()
+
+ class RetunValue:
+ def __init__(self) -> None:
+ self._output = {
+ "graph-tput-figure": no_update,
+ "graph-lat-figure": no_update,
+ "selected-tests-data": no_update,
+ "cl-selected-options": no_update,
+ "dd-ctrl-phy-value": no_update,
+ "dd-ctrl-area-value": no_update,
+ "dd-ctrl-test-value": no_update,
+ }
+
+ def value(self):
+ return tuple(self._output.values())
+
+ def set_values(self, kwargs: dict) -> None:
+ for key, val in kwargs.items():
+ if key in self._output:
+ self._output[key] = val
+ else:
+ raise KeyError(f"The key {key} is not defined.")
+
+
+ trigger_id = callback_context.triggered[0]["prop_id"].split(".")[0]
+
+ d_start = datetime(int(d_start[0:4]), int(d_start[5:7]),
+ int(d_start[8:10]))
+ d_end = datetime(int(d_end[0:4]), int(d_end[5:7]), int(d_end[8:10]))
+
+ output = RetunValue()
+
+ if trigger_id == "btn-ctrl-add":
+ # Add selected test to the list of tests in store:
+ if phy and area and test and cores and framesizes and testtypes:
+ if store_sel is None:
+ store_sel = list()
+ for core in cores:
+ for framesize in framesizes:
+ for ttype in testtypes:
+ tid = (
+ f"{phy.replace('af_xdp', 'af-xdp')}-"
+ f"{area}-"
+ f"{framesize.lower()}-"
+ f"{core.lower()}-"
+ f"{test}-"
+ f"{ttype.lower()}"
+ )
+ if tid not in [itm["id"] for itm in store_sel]:
+ store_sel.append({
+ "id": tid,
+ "phy": phy,
+ "area": area,
+ "test": test,
+ "framesize": framesize.lower(),
+ "core": core.lower(),
+ "testtype": ttype.lower()
+ })
+ output.set_values({
+ "selected-tests-data": store_sel,
+ "cl-selected-options": _list_tests(),
+ "dd-ctrl-phy-value": None,
+ "dd-ctrl-area-value": None,
+ "dd-ctrl-test-value": None,
+ })
+
+ elif trigger_id in ("btn-sel-display", "dpr-period"):
+ fig_tput, fig_lat = graph_trending(
+ self.data, store_sel, self.layout, d_start, d_end
+ )
+ output.set_values({
+ "graph-tput-figure": \
+ fig_tput if fig_tput else self.NO_GRAPH,
+ "graph-lat-figure": \
+ fig_lat if fig_lat else self.NO_GRAPH,
+ })
+ elif trigger_id == "btn-sel-remove-all":
+ output.set_values({
+ "graph-tput-figure": self.NO_GRAPH,
+ "graph-lat-figure": self.NO_GRAPH,
+ "selected-tests-data": list(),
+ "cl-selected-options": list()
+ })
+ elif trigger_id == "btn-sel-remove":
+ if list_sel:
+ new_store_sel = list()
+ for item in store_sel:
+ if item["id"] not in list_sel:
+ new_store_sel.append(item)
+ store_sel = new_store_sel
+ if store_sel:
+ fig_tput, fig_lat = graph_trending(
+ self.data, store_sel, self.layout, d_start, d_end
+ )
+ output.set_values({
+ "graph-tput-figure": \
+ fig_tput if fig_tput else self.NO_GRAPH,
+ "graph-lat-figure": \
+ fig_lat if fig_lat else self.NO_GRAPH,
+ "selected-tests-data": store_sel,
+ "cl-selected-options": _list_tests()
+ })
+ else:
+ output.set_values({
+ "graph-tput-figure": self.NO_GRAPH,
+ "graph-lat-figure": self.NO_GRAPH,
+ "selected-tests-data": store_sel,
+ "cl-selected-options": _list_tests()
+ })
+
+ return output.value()
+
+ @app.callback(
+ Output("metadata-tput-lat", "children"),
+ Output("metadata-hdrh-graph", "children"),
+ Output("offcanvas-metadata", "is_open"),
+ Input("graph-tput", "clickData"),
+ Input("graph-latency", "clickData")
+ )
+ def _show_tput_metadata(tput_data, lat_data) -> dbc.Card:
+ """
+ """
+ if not (tput_data or lat_data):
+ raise PreventUpdate
+
+ metadata = no_update
+ graph = list()
+
+ trigger_id = callback_context.triggered[0]["prop_id"].split(".")[0]
+ if trigger_id == "graph-tput":
+ title = "Throughput"
+ txt = tput_data["points"][0]["text"].replace("<br>", "\n")
+ elif trigger_id == "graph-latency":
+ title = "Latency"
+ txt = lat_data["points"][0]["text"].replace("<br>", "\n")
+ hdrh_data = lat_data["points"][0].get("customdata", None)
+ if hdrh_data:
+ graph = [dcc.Graph(
+ id="hdrh-latency-graph",
+ figure=graph_hdrh_latency(hdrh_data, self.layout)
+ ), ]
+
+ metadata = [
+ dbc.Card(
+ children=[
+ dbc.CardHeader(children=[
+ dcc.Clipboard(
+ target_id="tput-lat-metadata",
+ title="Copy",
+ style={"display": "inline-block"}
+ ),
+ title
+ ]),
+ dbc.CardBody(
+ id="tput-lat-metadata",
+ children=[txt]
+ )
+ ]
+ )
+ ]
+
+ return metadata, graph, True
+
+ @app.callback(
+ Output("download-data", "data"),
+ State("selected-tests", "data"),
+ Input("btn-download-data", "n_clicks"),
+ prevent_initial_call=True
+ )
+ def _download_data(store_sel, n_clicks):
+ """
+ """
+
+ if not n_clicks:
+ raise PreventUpdate
+
+ df = pd.DataFrame()
+ for itm in store_sel:
+ sel_data = select_trending_data(self.data, itm)
+ if sel_data is None:
+ continue
+ df = pd.concat([df, sel_data], ignore_index=True)
+
+ return dcc.send_data_frame(df.to_csv, "trending_data.csv")
Code Review / csit.git / blobdiff