X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Ftools%2Fdash%2Fapp%2Fpal%2Ftrending%2Flayout.py;h=422488dd3bc7c934d07032692893e7684797d859;hp=69ce0c416dae4175a1b39c1819d43fb9909cce31;hb=808613a09844882f121b173c2b6fccde3388a0ce;hpb=b2cb835b34c7404b2aaee3ec30700c67537da66d diff --git a/resources/tools/dash/app/pal/trending/layout.py b/resources/tools/dash/app/pal/trending/layout.py index 69ce0c416d..422488dd3b 100644 --- a/resources/tools/dash/app/pal/trending/layout.py +++ b/resources/tools/dash/app/pal/trending/layout.py @@ -14,20 +14,30 @@ """Plotly Dash HTML layout override. """ -import logging +import pandas as pd from dash import dcc from dash import html -from dash import Input, Output, callback +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: """ """ - def __init__(self, app, html_layout_file, spec_file): + NO_GRAPH = {"data": [], "layout": {}, "frames": []} + + def __init__(self, app, html_layout_file, spec_file, graph_layout_file, + data_spec_file): """ """ @@ -35,26 +45,61 @@ class Layout: 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_test = None + self._spec_tbs = None + self._graph_layout = None try: - with open(self._html_layout_file, "r") as layout_file: - self._html_layout = layout_file.read() + with open(self._html_layout_file, "r") as file_read: + self._html_layout = file_read.read() except IOError as err: - logging.error(f"Not possible to open the file {layout_file}\n{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_test = load(file_read, Loader=FullLoader) + 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: - logging.error(f"Not possible to open the file {spec_file}\n{err}") + raise RuntimeError( + f"Not possible to open the file {self._graph_layout_file}\n" + f"{err}" + ) except YAMLError as err: - logging.error( + raise RuntimeError( f"An error occurred while parsing the specification file " - f"{spec_file}\n" + f"{self._graph_layout_file}\n" f"{err}" ) @@ -62,189 +107,320 @@ class Layout: if self._app is not None and hasattr(self, 'callbacks'): self.callbacks(self._app) - # User choice (one test): - self._test_selection = { - "phy": "", - "area": "", - "test": "", - "core": "", - "frame-size": "", - "test-type": "" - } - @property def html_layout(self): return self._html_layout @property - def spec_test(self): - return self._spec_test - - def _reset_test_selection(self): - self._test_selection = { - "phy": "", - "area": "", - "test": "", - "core": "", - "frame-size": "", - "test-type": "" - } + 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_test: + if self.html_layout and self.spec_tbs: return html.Div( id="div-main", children=[ - self._add_ctrl_div(), - self._add_plotting_div() + 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="An Error Occured." - ) + id="div-main-error", + children=[ + dbc.Alert( + [ + "An Error Occured", + ], + color="danger", + ), + ] + ) - def _add_ctrl_div(self): - """Add div with controls. It is placed on the left side. + def _add_navbar(self): + """Add nav element with navigation panel. It is placed on the top. """ - return html.Div( - id="div-controls", + return dbc.NavbarSimple( + id="navbarsimple-main", children=[ - html.Div( - id="div-controls-tabs", - children=[ - self._add_ctrl_select(), - self._add_ctrl_shown() - ] + dbc.NavItem( + dbc.NavLink( + "Continuous Performance Trending", + disabled=True, + external_link=True, + href="#" + ) ) ], - style={ - "display": "inline-block", - "width": "18%", - "padding": "5px" - } + brand="Dashboard", + brand_href="/", + brand_external_link=True, + class_name="p-2", + fluid=True, ) - def _add_plotting_div(self): - """Add div with plots and tables. It is placed on the right side. + def _add_ctrl_col(self) -> dbc.Col: + """Add column with controls. It is placed on the left side. """ - return html.Div( - id="div-plotting-area", + return dbc.Col( + id="col-controls", children=[ - # Only a visible note. - # TODO: Add content. - html.H3( - "Graphs and Tables", - style={ - "vertical-align": "middle", - "text-align": "center" - } - ) + self._add_ctrl_panel(), + self._add_ctrl_shown() ], - style={ - "vertical-align": "middle", - "display": "inline-block", - "width": "80%", - "padding": "5px" - } ) - def _add_ctrl_shown(self): - """ + def _add_plotting_col(self) -> dbc.Col: + """Add column with plots and tables. It is placed on the right side. """ - return html.Div( - id="div-ctrl-shown", - children="List of selected tests" + 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_select(self): + def _add_ctrl_panel(self) -> dbc.Row: """ """ - return html.Div( - id="div-ctrl-select", + return dbc.Row( + id="row-ctrl-panel", + class_name="g-0", children=[ - html.Br(), - html.Div( - children="Physical Test Bed Topology, NIC and Driver" - ), - dcc.Dropdown( + 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...", - multi=False, - clearable=False, options=[ - {"label": k, "value": k} for k in self._spec_test.keys() + {"label": k, "value": k} for k in self.spec_tbs.keys() ], + size="sm", ), - html.Br(), - html.Div( - children="Area" - ), - dcc.Dropdown( + dbc.Label("Area"), + dbc.Select( id="dd-ctrl-area", + className="p-2", placeholder="Select an Area...", disabled=True, - multi=False, - clearable=False, + size="sm", ), - html.Br(), - html.Div( - children="Test" - ), - dcc.Dropdown( + dbc.Label("Test"), + dbc.Select( id="dd-ctrl-test", + className="p-2", placeholder="Select a Test...", disabled=True, - multi=False, - clearable=False, - ), - - # Change to radio buttons: - html.Br(), - html.Div( - children="Number of Cores" + size="sm", ), - dcc.Dropdown( - id="dd-ctrl-core", - placeholder="Select a Number of Cores...", - disabled=True, - multi=False, - clearable=False, - ), - html.Br(), - html.Div( - children="Frame Size" + 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 + ) + ]) + ] ), - dcc.Dropdown( - id="dd-ctrl-framesize", - placeholder="Select a Frame Size...", - disabled=True, - multi=False, - clearable=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 + ) + ]) + ] ), - html.Br(), - html.Div( - children="Test Type" + 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 + ) + ]) + ] ), - dcc.Dropdown( - id="dd-ctrl-testtype", - placeholder="Select a Test Type...", - disabled=True, - multi=False, - clearable=False, + dbc.Row( + class_name="g-0", + children=[ + dbc.Button( + id="btn-ctrl-add", + children="Add", + ) + ] ), - html.Br(), - html.Button( - id="btn-ctrl-add", - children="Add", - disabled=True + 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 + ) + ] ), - html.Br(), - html.Div( - id="div-ctrl-info" + 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", + ), + ] ) ] ) @@ -265,85 +441,346 @@ class Layout: try: options = [ - {"label": self._spec_test[phy][v]["label"], "value": v} - for v in [v for v in self._spec_test[phy].keys()] + {"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, False + return options, disable @app.callback( Output("dd-ctrl-test", "options"), Output("dd-ctrl-test", "disabled"), - Input("dd-ctrl-phy", "value"), + State("dd-ctrl-phy", "value"), Input("dd-ctrl-area", "value"), ) def _update_dd_test(phy, area): """ """ - if not all((phy, area, )): + if not area: raise PreventUpdate try: options = [ {"label": v, "value": v} - for v in self._spec_test[phy][area]["test"] + for v in self.spec_tbs[phy][area]["test"] ] + disable = False except KeyError: options = list() + disable = True - return options, False + return options, disable @app.callback( - Output("btn-ctrl-add", "disabled"), - Input("dd-ctrl-phy", "value"), - Input("dd-ctrl-area", "value"), + 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 all((phy, area, test, )): - self._test_selection["phy"] = phy - self._test_selection["area"] = area - self._test_selection["test"] = test - return False + 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: - return True + 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("div-ctrl-info", "children"), + 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"), - Output("btn-ctrl-add", "n_clicks"), - Input("btn-ctrl-add", "n_clicks") + 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 _print_user_selection(n_clicks): + 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): """ """ - logging.info(f"\n\n{n_clicks}\n\n") + if not (btn_add or btn_display or btn_remove or btn_remove_all or \ + d_start or d_end): + raise PreventUpdate - if not n_clicks: + 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 - selected = ( - f"{self._test_selection['phy']} # " - f"{self._test_selection['area']} # " - f"{self._test_selection['test']} # " - f"{n_clicks}\n" - ) + 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("
", "\n") + elif trigger_id == "graph-latency": + title = "Latency" + txt = lat_data["points"][0]["text"].replace("
", "\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] + ) + ] + ) + ] - self._reset_test_selection() + return metadata, graph, True - return ( - selected, - None, - None, - None, - 0, - ) + @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")