csit.infra.dash/app/cdash/utils/constants.py

   1 # Copyright (c) 2023 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Constants used in CDash.
  15
  16 "Constant" means a value that keeps its value since initialization. The value
  17 does not need to be hard coded here, but can be read from environment variables.
  18 """
  19
  20 import logging
  21
  22 from dash import html
  23
  24
  25 class Constants:
  26     """Constants used in CDash.
  27     """
  28
  29     ############################################################################
  30     # General, application wide constants.
  31
  32     # Logging settings.
  33     LOG_LEVEL = logging.INFO
  34     LOG_FORMAT = "%(asctime)s: %(levelname)s: %(message)s"
  35     LOG_DATE_FORMAT = "%Y/%m/%d %H:%M:%S"
  36
  37     # The application title.
  38     TITLE = "FD.io CSIT"
  39     BRAND = "CSIT-Dash"
  40
  41     # The application description.
  42     DESCRIPTION = "Performance Dashboard"
  43
  44     # External stylesheets.
  45     EXTERNAL_STYLESHEETS = ["/static/dist/css/bootstrap.css", ]
  46
  47     # Path and name of the file specifying the HTML layout of the dash
  48     # application.
  49     MAIN_HTML_LAYOUT_FILE = "base_layout.jinja2"
  50
  51     # Path and name of the file specifying the HTML layout of the dash
  52     # application.
  53     HTML_LAYOUT_FILE = "cdash/templates/dash_layout.jinja2"
  54
  55     # Application root.
  56     APPLICATIN_ROOT = "/"
  57
  58     # Data to be downloaded from the parquets specification file.
  59     DATA_SPEC_FILE = "cdash/data/data.yaml"
  60
  61     # The file with tooltips.
  62     TOOLTIP_FILE = "cdash/utils/tooltips.yaml"
  63
  64     # Maximal value of TIME_PERIOD for data read from the parquets in days.
  65     # Do not change without a good reason.
  66     MAX_TIME_PERIOD = 130
  67
  68     # It defines the time period for data read from the parquets in days from
  69     # now back to the past.
  70     # TIME_PERIOD = None - means all data (max MAX_TIME_PERIOD days) is read.
  71     # TIME_PERIOD = MAX_TIME_PERIOD - is the default value
  72     TIME_PERIOD = MAX_TIME_PERIOD  # [days]
  73
  74     ############################################################################
  75     # General, application wide, layout affecting constants.
  76
  77     # Add a time delay (in ms) to the spinner being shown
  78     SPINNER_DELAY = 500
  79
  80     # If True, clear all inputs in control panel when button "ADD SELECTED" is
  81     # pressed.
  82     CLEAR_ALL_INPUTS = False
  83
  84     # The element is disabled.
  85     STYLE_DISABLED = {"display": "none"}
  86
  87     # The element is enabled and visible.
  88     STYLE_ENABLED = {"display": "inherit"}
  89
  90     # Checklist "All" is disabled.
  91     CL_ALL_DISABLED = [
  92         {
  93             "label": "All",
  94             "value": "all",
  95             "disabled": True
  96         }
  97     ]
  98
  99     # Checklist "All" is enabled, visible and unchecked.
 100     CL_ALL_ENABLED = [
 101         {
 102             "label": "All",
 103             "value": "all",
 104             "disabled": False
 105         }
 106     ]
 107
 108     # Placeholder for any element in the layout.
 109     PLACEHOLDER = html.Nobr("")
 110
 111     # List of drivers used in CSIT.
 112     DRIVERS = ("avf", "af-xdp", "rdma", "dpdk", "mlx5")
 113
 114     # Labels for input elements (dropdowns, ...).
 115     LABELS = {
 116         "dpdk": "DPDK",
 117         "container_memif": "LXC/DRC Container Memif",
 118         "crypto": "IPSec IPv4 Routing",
 119         "ip4": "IPv4 Routing",
 120         "ip6": "IPv6 Routing",
 121         "ip4_tunnels": "IPv4 Tunnels",
 122         "l2": "L2 Ethernet Switching",
 123         "srv6": "SRv6 Routing",
 124         "vm_vhost": "VMs vhost-user",
 125         "nfv_density-dcr_memif-chain_ipsec": "CNF Service Chains Routing IPSec",
 126         "nfv_density-vm_vhost-chain_dot1qip4vxlan":"VNF Service Chains Tunnels",
 127         "nfv_density-vm_vhost-chain": "VNF Service Chains Routing",
 128         "nfv_density-dcr_memif-pipeline": "CNF Service Pipelines Routing",
 129         "nfv_density-dcr_memif-chain": "CNF Service Chains Routing",
 130     }
 131
 132     # URL style.
 133     URL_STYLE = {
 134         "background-color": "#d2ebf5",
 135         "border-color": "#bce1f1",
 136         "color": "#135d7c"
 137     }
 138
 139     ############################################################################
 140     # General, normalization constants.
 141
 142     NORM_FREQUENCY = 2.0  # [GHz]
 143     FREQUENCY = {  # [GHz]
 144         "2n-aws": 1.000,
 145         "2n-dnv": 2.000,
 146         "2n-clx": 2.300,
 147         "2n-icx": 2.600,
 148         "2n-skx": 2.500,
 149         "2n-tx2": 2.500,
 150         "2n-zn2": 2.900,
 151         "3n-alt": 3.000,
 152         "3n-aws": 1.000,
 153         "3n-dnv": 2.000,
 154         "3n-icx": 2.600,
 155         "3n-skx": 2.500,
 156         "3n-tsh": 2.200,
 157         "3n-snr": 2.200
 158     }
 159
 160     ############################################################################
 161     # General, plots constants.
 162
 163     PLOT_COLORS = (
 164         "#1A1110", "#DA2647", "#214FC6", "#01786F", "#BD8260", "#FFD12A",
 165         "#A6E7FF", "#738276", "#C95A49", "#FC5A8D", "#CEC8EF", "#391285",
 166         "#6F2DA8", "#FF878D", "#45A27D", "#FFD0B9", "#FD5240", "#DB91EF",
 167         "#44D7A8", "#4F86F7", "#84DE02", "#FFCFF1", "#614051"
 168     )
 169
 170     # Trending, anomalies.
 171     ANOMALY_COLOR = {
 172         "regression": 0.0,
 173         "normal": 0.5,
 174         "progression": 1.0
 175     }
 176
 177     COLORSCALE_TPUT = [
 178         [0.00, "red"],
 179         [0.33, "red"],
 180         [0.33, "white"],
 181         [0.66, "white"],
 182         [0.66, "green"],
 183         [1.00, "green"]
 184     ]
 185
 186     TICK_TEXT_TPUT = ["Regression", "Normal", "Progression"]
 187
 188     COLORSCALE_LAT = [
 189         [0.00, "green"],
 190         [0.33, "green"],
 191         [0.33, "white"],
 192         [0.66, "white"],
 193         [0.66, "red"],
 194         [1.00, "red"]
 195     ]
 196
 197     TICK_TEXT_LAT = ["Progression", "Normal", "Regression"]
 198
 199     # Access to the results.
 200     VALUE = {
 201         "mrr": "result_receive_rate_rate_avg",
 202         "ndr": "result_ndr_lower_rate_value",
 203         "pdr": "result_pdr_lower_rate_value",
 204         "pdr-lat": "result_latency_forward_pdr_50_avg"
 205     }
 206
 207     VALUE_ITER = {
 208         "mrr": "result_receive_rate_rate_values",
 209         "ndr": "result_ndr_lower_rate_value",
 210         "pdr": "result_pdr_lower_rate_value",
 211         "pdr-lat": "result_latency_forward_pdr_50_avg"
 212     }
 213
 214     UNIT = {
 215         "mrr": "result_receive_rate_rate_unit",
 216         "ndr": "result_ndr_lower_rate_unit",
 217         "pdr": "result_pdr_lower_rate_unit",
 218         "pdr-lat": "result_latency_forward_pdr_50_unit"
 219     }
 220
 221     # Latencies.
 222     LAT_HDRH = (  # Do not change the order
 223         "result_latency_forward_pdr_0_hdrh",
 224         "result_latency_reverse_pdr_0_hdrh",
 225         "result_latency_forward_pdr_10_hdrh",
 226         "result_latency_reverse_pdr_10_hdrh",
 227         "result_latency_forward_pdr_50_hdrh",
 228         "result_latency_reverse_pdr_50_hdrh",
 229         "result_latency_forward_pdr_90_hdrh",
 230         "result_latency_reverse_pdr_90_hdrh",
 231     )
 232
 233     # This value depends on latency stream rate (9001 pps) and duration (5s).
 234     # Keep it slightly higher to ensure rounding errors to not remove tick mark.
 235     PERCENTILE_MAX = 99.999501
 236
 237     GRAPH_LAT_HDRH_DESC = {
 238         "result_latency_forward_pdr_0_hdrh": "No-load.",
 239         "result_latency_reverse_pdr_0_hdrh": "No-load.",
 240         "result_latency_forward_pdr_10_hdrh": "Low-load, 10% PDR.",
 241         "result_latency_reverse_pdr_10_hdrh": "Low-load, 10% PDR.",
 242         "result_latency_forward_pdr_50_hdrh": "Mid-load, 50% PDR.",
 243         "result_latency_reverse_pdr_50_hdrh": "Mid-load, 50% PDR.",
 244         "result_latency_forward_pdr_90_hdrh": "High-load, 90% PDR.",
 245         "result_latency_reverse_pdr_90_hdrh": "High-load, 90% PDR."
 246     }
 247
 248     ############################################################################
 249     # News.
 250
 251     # The title.
 252     NEWS_TITLE = "Failures and Anomalies"
 253
 254     # The pathname prefix for the application.
 255     NEWS_ROUTES_PATHNAME_PREFIX = "/news/"
 256
 257     # Time period for regressions and progressions.
 258     NEWS_TIME_PERIOD = TIME_PERIOD  # [days]
 259
 260     # Time periods for summary tables.
 261     NEWS_LAST = 1  # [days]
 262     NEWS_SHORT = 7  # [days]
 263     NEWS_LONG = NEWS_TIME_PERIOD  # [days]
 264
 265     ############################################################################
 266     # Report.
 267
 268     # The title.
 269     REPORT_TITLE = "Per Release Performance"
 270
 271     # The pathname prefix for the application.
 272     REPORT_ROUTES_PATHNAME_PREFIX = "/report/"
 273
 274     # Layout of plot.ly graphs.
 275     REPORT_GRAPH_LAYOUT_FILE = "cdash/report/layout.yaml"
 276
 277     # Default name of downloaded file with selected data.
 278     REPORT_DOWNLOAD_FILE_NAME = "iterative_data.csv"
 279
 280     ############################################################################
 281     # Statistics.
 282
 283     # The title.
 284     STATS_TITLE = "Test Job Statistics"
 285
 286     # The pathname prefix for the application.
 287     STATS_ROUTES_PATHNAME_PREFIX = "/stats/"
 288
 289     # Layout of plot.ly graphs.
 290     STATS_GRAPH_LAYOUT_FILE = "cdash/stats/layout.yaml"
 291
 292     # The default job displayed when the page is loaded first time.
 293     STATS_DEFAULT_JOB = "csit-vpp-perf-mrr-daily-master-2n-icx"
 294
 295     # Default name of downloaded file with selected data.
 296     STATS_DOWNLOAD_FILE_NAME = "stats.csv"
 297
 298     ############################################################################
 299     # Trending.
 300
 301     # The title.
 302     TREND_TITLE = "Performance Trending"
 303
 304     # The pathname prefix for the application.
 305     TREND_ROUTES_PATHNAME_PREFIX = "/trending/"
 306
 307     # Layout of plot.ly graphs.
 308     TREND_GRAPH_LAYOUT_FILE = "cdash/trending/layout.yaml"
 309
 310     # Default name of downloaded file with selected data.
 311     TREND_DOWNLOAD_FILE_NAME = "trending_data.csv"