# Copyright (c) 2023 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:
#
# 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.
"""Implementation of graphs for trending data.
"""
import plotly.graph_objects as go
import pandas as pd
import hdrh.histogram
import hdrh.codec
from ..utils.constants import Constants as C
from ..utils.utils import classify_anomalies, get_color
def _get_hdrh_latencies(row: pd.Series, name: str) -> dict:
"""Get the HDRH latencies from the test data.
:param row: A row fron the data frame with test data.
:param name: The test name to be displayed as the graph title.
:type row: pandas.Series
:type name: str
:returns: Dictionary with HDRH latencies.
:rtype: dict
"""
latencies = {"name": name}
for key in C.LAT_HDRH:
try:
latencies[key] = row[key]
except KeyError:
return None
return latencies
def select_trending_data(data: pd.DataFrame, itm: dict) -> pd.DataFrame:
"""Select the data for graphs from the provided data frame.
:param data: Data frame with data for graphs.
:param itm: Item (in this case job name) which data will be selected from
the input data frame.
:type data: pandas.DataFrame
:type itm: dict
:returns: A data frame with selected data.
:rtype: pandas.DataFrame
"""
phy = itm["phy"].split("-")
if len(phy) == 4:
topo, arch, nic, drv = phy
if drv == "dpdk":
drv = ""
else:
drv += "-"
drv = drv.replace("_", "-")
else:
return None
if itm["testtype"] in ("ndr", "pdr"):
test_type = "ndrpdr"
elif itm["testtype"] == "mrr":
test_type = "mrr"
elif itm["area"] == "hoststack":
test_type = "hoststack"
df = data.loc[(
(data["test_type"] == test_type) &
(data["passed"] == True)
)]
df = df[df.job.str.endswith(f"{topo}-{arch}")]
core = str() if itm["dut"] == "trex" else f"{itm['core']}"
ttype = "ndrpdr" if itm["testtype"] in ("ndr", "pdr") else itm["testtype"]
df = df[df.test_id.str.contains(
f"^.*[.|-]{nic}.*{itm['framesize']}-{core}-{drv}{itm['test']}-{ttype}$",
regex=True
)].sort_values(by="start_time", ignore_index=True)
return df
def graph_trending(
data: pd.DataFrame,
sel: dict,
layout: dict,
normalize: bool
) -> tuple:
"""Generate the trending graph(s) - MRR, NDR, PDR and for PDR also Latences
(result_latency_forward_pdr_50_avg).
:param data: Data frame with test results.
:param sel: Selected tests.
:param layout: Layout of plot.ly graph.
:param normalize: If True, the data is normalized to CPU frquency
Constants.NORM_FREQUENCY.
:type data: pandas.DataFrame
:type sel: dict
:type layout: dict
:type normalize: bool
:returns: Trending graph(s)
:rtype: tuple(plotly.graph_objects.Figure, plotly.graph_objects.Figure)
"""
if not sel:
return None, None
def _generate_trending_traces(
ttype: str,
name: str,
df: pd.DataFrame,
color: str,
norm_factor: float
) -> list:
"""Generate the trending traces for the trending graph.
:param ttype: Test type (MRR, NDR, PDR).
:param name: The test name to be displayed as the graph title.
:param df: Data frame with test data.
:param color: The color of the trace (samples and trend line).
:param norm_factor: The factor used for normalization of the results to
CPU frequency set to Constants.NORM_FREQUENCY.
:type ttype: str
:type name: str
:type df: pandas.DataFrame
:type color: str
:type norm_factor: float
:returns: Traces (samples, trending line, anomalies)
:rtype: list
"""
df = df.dropna(subset=[C.VALUE[ttype], ])
if df.empty:
return list(), list()
x_axis = df["start_time"].tolist()
if ttype == "pdr-lat":
y_data = [(v / norm_factor) for v in df[C.VALUE[ttype]].tolist()]
else:
y_data = [(v * norm_factor) for v in df[C.VALUE[ttype]].tolist()]
units = df[C.UNIT[ttype]].unique().tolist()
anomalies, trend_avg, trend_stdev = classify_anomalies(
{k: v for k, v in zip(x_axis, y_data)}
)
hover = list()
customdata = list()
customdata_samples = list()
for idx, (_, row) in enumerate(df.iterrows()):
d_type = "trex" if row["dut_type"] == "none" else row["dut_type"]
hover_itm = (
f"date: {row['start_time'].strftime('%Y-%m-%d %H:%M:%S')}
"
f" [{row[C.UNIT[ttype]]}]: {y_data[idx]:,.0f}
"
f""
f""
f"{d_type}-ref: {row['dut_version']}
"
f"csit-ref: {row['job']}/{row['build']}
"
f"hosts: {', '.join(row['hosts'])}"
)
if ttype == "mrr":
stdev = (
f"stdev [{row['result_receive_rate_rate_unit']}]: "
f"{row['result_receive_rate_rate_stdev']:,.0f}
"
)
else:
stdev = str()
if ttype in ("hoststack-cps", "hoststack-rps"):
add_info = (
f"bandwidth [{row[C.UNIT['hoststack-bps']]}]: "
f"{row[C.VALUE['hoststack-bps']]:,.0f}
"
f"latency [{row[C.UNIT['hoststack-lat']]}]: "
f"{row[C.VALUE['hoststack-lat']]:,.0f}
"
)
else:
add_info = str()
hover_itm = hover_itm.replace(
"", "latency" if ttype == "pdr-lat" else "average"
).replace("", stdev).replace("", add_info)
hover.append(hover_itm)
if ttype == "pdr-lat":
customdata_samples.append(_get_hdrh_latencies(row, name))
customdata.append({"name": name})
else:
customdata_samples.append(
{"name": name, "show_telemetry": True}
)
customdata.append({"name": name})
hover_trend = list()
for avg, stdev, (_, row) in zip(trend_avg, trend_stdev, df.iterrows()):
d_type = "trex" if row["dut_type"] == "none" else row["dut_type"]
hover_itm = (
f"date: {row['start_time'].strftime('%Y-%m-%d %H:%M:%S')}
"
f"trend [{row[C.UNIT[ttype]]}]: {avg:,.0f}
"
f"stdev [{row[C.UNIT[ttype]]}]: {stdev:,.0f}
"
f"{d_type}-ref: {row['dut_version']}
"
f"csit-ref: {row['job']}/{row['build']}
"
f"hosts: {', '.join(row['hosts'])}"
)
if ttype == "pdr-lat":
hover_itm = hover_itm.replace("[pps]", "[us]")
hover_trend.append(hover_itm)
traces = [
go.Scatter( # Samples
x=x_axis,
y=y_data,
name=name,
mode="markers",
marker={
"size": 5,
"color": color,
"symbol": "circle",
},
text=hover,
hoverinfo="text+name",
showlegend=True,
legendgroup=name,
customdata=customdata_samples
),
go.Scatter( # Trend line
x=x_axis,
y=trend_avg,
name=name,
mode="lines",
line={
"shape": "linear",
"width": 1,
"color": color,
},
text=hover_trend,
hoverinfo="text+name",
showlegend=False,
legendgroup=name,
customdata=customdata
)
]
if anomalies:
anomaly_x = list()
anomaly_y = list()
anomaly_color = list()
hover = list()
for idx, anomaly in enumerate(anomalies):
if anomaly in ("regression", "progression"):
anomaly_x.append(x_axis[idx])
anomaly_y.append(trend_avg[idx])
anomaly_color.append(C.ANOMALY_COLOR[anomaly])
hover_itm = (
f"date: {x_axis[idx].strftime('%Y-%m-%d %H:%M:%S')}
"
f"trend [pps]: {trend_avg[idx]:,.0f}
"
f"classification: {anomaly}"
)
if ttype == "pdr-lat":
hover_itm = hover_itm.replace("[pps]", "[us]")
hover.append(hover_itm)
anomaly_color.extend([0.0, 0.5, 1.0])
traces.append(
go.Scatter(
x=anomaly_x,
y=anomaly_y,
mode="markers",
text=hover,
hoverinfo="text+name",
showlegend=False,
legendgroup=name,
name=name,
customdata=customdata,
marker={
"size": 15,
"symbol": "circle-open",
"color": anomaly_color,
"colorscale": C.COLORSCALE_LAT \
if ttype == "pdr-lat" else C.COLORSCALE_TPUT,
"showscale": True,
"line": {
"width": 2
},
"colorbar": {
"y": 0.5,
"len": 0.8,
"title": "Circles Marking Data Classification",
"titleside": "right",
"tickmode": "array",
"tickvals": [0.167, 0.500, 0.833],
"ticktext": C.TICK_TEXT_LAT \
if ttype == "pdr-lat" else C.TICK_TEXT_TPUT,
"ticks": "",
"ticklen": 0,
"tickangle": -90,
"thickness": 10
}
}
)
)
return traces, units
fig_tput = None
fig_lat = None
y_units = set()
for idx, itm in enumerate(sel):
df = select_trending_data(data, itm)
if df is None or df.empty:
continue
if normalize:
phy = itm["phy"].split("-")
topo_arch = f"{phy[0]}-{phy[1]}" if len(phy) == 4 else str()
norm_factor = (C.NORM_FREQUENCY / C.FREQUENCY[topo_arch]) \
if topo_arch else 1.0
else:
norm_factor = 1.0
if itm["area"] == "hoststack":
ttype = f"hoststack-{itm['testtype']}"
else:
ttype = itm["testtype"]
traces, units = _generate_trending_traces(
ttype,
itm["id"],
df,
get_color(idx),
norm_factor
)
if traces:
if not fig_tput:
fig_tput = go.Figure()
fig_tput.add_traces(traces)
if itm["testtype"] == "pdr":
traces, _ = _generate_trending_traces(
"pdr-lat",
itm["id"],
df,
get_color(idx),
norm_factor
)
if traces:
if not fig_lat:
fig_lat = go.Figure()
fig_lat.add_traces(traces)
y_units.update(units)
if fig_tput:
fig_layout = layout.get("plot-trending-tput", dict())
fig_layout["yaxis"]["title"] = \
f"Throughput [{'|'.join(sorted(y_units))}]"
fig_tput.update_layout(fig_layout)
if fig_lat:
fig_lat.update_layout(layout.get("plot-trending-lat", dict()))
return fig_tput, fig_lat
def graph_hdrh_latency(data: dict, layout: dict) -> go.Figure:
"""Generate HDR Latency histogram graphs.
:param data: HDRH data.
:param layout: Layout of plot.ly graph.
:type data: dict
:type layout: dict
:returns: HDR latency Histogram.
:rtype: plotly.graph_objects.Figure
"""
fig = None
traces = list()
for idx, (lat_name, lat_hdrh) in enumerate(data.items()):
try:
decoded = hdrh.histogram.HdrHistogram.decode(lat_hdrh)
except (hdrh.codec.HdrLengthException, TypeError):
continue
previous_x = 0.0
prev_perc = 0.0
xaxis = list()
yaxis = list()
hovertext = list()
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, C.PERCENTILE_MAX)
xaxis.append(previous_x)
yaxis.append(item.value_iterated_to)
hovertext.append(
f"{C.GRAPH_LAT_HDRH_DESC[lat_name]}
"
f"Direction: {('W-E', 'E-W')[idx % 2]}
"
f"Percentile: {prev_perc:.5f}-{percentile:.5f}%
"
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"{C.GRAPH_LAT_HDRH_DESC[lat_name]}
"
f"Direction: {('W-E', 'E-W')[idx % 2]}
"
f"Percentile: {prev_perc:.5f}-{percentile:.5f}%
"
f"Latency: {item.value_iterated_to}uSec"
)
previous_x = next_x
prev_perc = percentile
traces.append(
go.Scatter(
x=xaxis,
y=yaxis,
name=C.GRAPH_LAT_HDRH_DESC[lat_name],
mode="lines",
legendgroup=C.GRAPH_LAT_HDRH_DESC[lat_name],
showlegend=bool(idx % 2),
line=dict(
color=get_color(int(idx/2)),
dash="solid",
width=1 if idx % 2 else 2
),
hovertext=hovertext,
hoverinfo="text"
)
)
if traces:
fig = go.Figure()
fig.add_traces(traces)
layout_hdrh = layout.get("plot-hdrh-latency", None)
if lat_hdrh:
fig.update_layout(layout_hdrh)
return fig
def graph_tm_trending(data: pd.DataFrame, layout: dict) -> list:
"""Generates one trending graph per test, each graph includes all selected
metrics.
:param data: Data frame with telemetry data.
:param layout: Layout of plot.ly graph.
:type data: pandas.DataFrame
:type layout: dict
:returns: List of generated graphs together with test names.
list(tuple(plotly.graph_objects.Figure(), str()), tuple(...), ...)
:rtype: list
"""
def _generate_graph(
data: pd.DataFrame,
test: str,
layout: dict
) -> go.Figure:
"""Generates a trending graph for given test with all metrics.
:param data: Data frame with telemetry data for the given test.
:param test: The name of the test.
:param layout: Layout of plot.ly graph.
:type data: pandas.DataFrame
:type test: str
:type layout: dict
:returns: A trending graph.
:rtype: plotly.graph_objects.Figure
"""
graph = None
traces = list()
for idx, metric in enumerate(data.tm_metric.unique()):
if "-pdr" in test and "='pdr'" not in metric:
continue
if "-ndr" in test and "='ndr'" not in metric:
continue
df = data.loc[(data["tm_metric"] == metric)]
x_axis = df["start_time"].tolist()
y_data = [float(itm) for itm in df["tm_value"].tolist()]
hover = list()
for i, (_, row) in enumerate(df.iterrows()):
if row["test_type"] == "mrr":
rate = (
f"mrr avg [{row[C.UNIT['mrr']]}]: "
f"{row[C.VALUE['mrr']]:,.0f}
"
f"mrr stdev [{row[C.UNIT['mrr']]}]: "
f"{row['result_receive_rate_rate_stdev']:,.0f}
"
)
elif row["test_type"] == "ndrpdr":
if "-pdr" in test:
rate = (
f"pdr [{row[C.UNIT['pdr']]}]: "
f"{row[C.VALUE['pdr']]:,.0f}
"
)
elif "-ndr" in test:
rate = (
f"ndr [{row[C.UNIT['ndr']]}]: "
f"{row[C.VALUE['ndr']]:,.0f}
"
)
else:
rate = str()
else:
rate = str()
hover.append(
f"date: "
f"{row['start_time'].strftime('%Y-%m-%d %H:%M:%S')}
"
f"value: {y_data[i]:,.0f}
"
f"{rate}"
f"{row['dut_type']}-ref: {row['dut_version']}
"
f"csit-ref: {row['job']}/{row['build']}
"
)
if any(y_data):
anomalies, trend_avg, trend_stdev = classify_anomalies(
{k: v for k, v in zip(x_axis, y_data)}
)
hover_trend = list()
for avg, stdev, (_, row) in \
zip(trend_avg, trend_stdev, df.iterrows()):
hover_trend.append(
f"date: "
f"{row['start_time'].strftime('%Y-%m-%d %H:%M:%S')}
"
f"trend: {avg:,.0f}
"
f"stdev: {stdev:,.0f}
"
f"{row['dut_type']}-ref: {row['dut_version']}
"
f"csit-ref: {row['job']}/{row['build']}"
)
else:
anomalies = None
color = get_color(idx)
traces.append(
go.Scatter( # Samples
x=x_axis,
y=y_data,
name=metric,
mode="markers",
marker={
"size": 5,
"color": color,
"symbol": "circle",
},
text=hover,
hoverinfo="text+name",
showlegend=True,
legendgroup=metric
)
)
if anomalies:
traces.append(
go.Scatter( # Trend line
x=x_axis,
y=trend_avg,
name=metric,
mode="lines",
line={
"shape": "linear",
"width": 1,
"color": color,
},
text=hover_trend,
hoverinfo="text+name",
showlegend=False,
legendgroup=metric
)
)
anomaly_x = list()
anomaly_y = list()
anomaly_color = list()
hover = list()
for idx, anomaly in enumerate(anomalies):
if anomaly in ("regression", "progression"):
anomaly_x.append(x_axis[idx])
anomaly_y.append(trend_avg[idx])
anomaly_color.append(C.ANOMALY_COLOR[anomaly])
hover_itm = (
f"date: {x_axis[idx].strftime('%Y-%m-%d %H:%M:%S')}"
f"
trend: {trend_avg[idx]:,.0f}"
f"
classification: {anomaly}"
)
hover.append(hover_itm)
anomaly_color.extend([0.0, 0.5, 1.0])
traces.append(
go.Scatter(
x=anomaly_x,
y=anomaly_y,
mode="markers",
text=hover,
hoverinfo="text+name",
showlegend=False,
legendgroup=metric,
name=metric,
marker={
"size": 15,
"symbol": "circle-open",
"color": anomaly_color,
"colorscale": C.COLORSCALE_TPUT,
"showscale": True,
"line": {
"width": 2
},
"colorbar": {
"y": 0.5,
"len": 0.8,
"title": "Circles Marking Data Classification",
"titleside": "right",
"tickmode": "array",
"tickvals": [0.167, 0.500, 0.833],
"ticktext": C.TICK_TEXT_TPUT,
"ticks": "",
"ticklen": 0,
"tickangle": -90,
"thickness": 10
}
}
)
)
if traces:
graph = go.Figure()
graph.add_traces(traces)
graph.update_layout(layout.get("plot-trending-telemetry", dict()))
return graph
tm_trending_graphs = list()
if data.empty:
return tm_trending_graphs
for test in data.test_name.unique():
df = data.loc[(data["test_name"] == test)]
graph = _generate_graph(df, test, layout)
if graph:
tm_trending_graphs.append((graph, test, ))
return tm_trending_graphs