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         "ip4_tunnels": "IPv4 Tunnels",
 121         "ip6": "IPv6 Routing",
 122         "ip6_tunnels": "IPv6 Tunnels",
 123         "l2": "L2 Ethernet Switching",
 124         "lb": "Load Balancer",
 125         "srv6": "SRv6 Routing",
 126         "vm_vhost": "VMs vhost-user",
 127         "nfv_density.dcr_memif.chain_ipsec": "CNF Service Chains Routing IPSec",
 128         "nfv_density.vm_vhost.chain_dot1qip4vxlan":"VNF Service Chains Tunnels",
 129         "nfv_density.vm_vhost.chain": "VNF Service Chains Routing",
 130         "nfv_density.dcr_memif.pipeline": "CNF Service Pipelines Routing",
 131         "nfv_density.dcr_memif.chain": "CNF Service Chains Routing",
 132         "hoststack": "Hoststack",
 133         "flow": "Flow",
 134         "l2bd": "L2 Bridge Domain",
 135         "crypto.ethip4": "IPSec IPv4 Routing",
 136         "crypto.ethip6": "IPSec IPv6 Routing",
 137         "interfaces": "Interfaces",
 138         "ip4_tunnels.lisp": "IPv4 Tunnels LISP",
 139         "ip6_tunnels.lisp": "IPv6 Tunnels LISP",
 140         "l2patch": "L2 Patch",
 141         "l2xc": "L2 Cross Connect",
 142         "vm_vhost.ethip4": "VMs vhost-user IPv4 Routing",
 143         "vm_vhost.ethip6": "VMs vhost-user IPv6 Routing"
 144     }
 145
 146     # URL style.
 147     URL_STYLE = {
 148         "background-color": "#d2ebf5",
 149         "border-color": "#bce1f1",
 150         "color": "#135d7c"
 151     }
 152
 153     ############################################################################
 154     # General, normalization constants.
 155
 156     NORM_FREQUENCY = 2.0  # [GHz]
 157     FREQUENCY = {  # [GHz]
 158         "1n-aws": 1.000,
 159         "2n-aws": 1.000,
 160         "2n-dnv": 2.000,
 161         "2n-clx": 2.300,
 162         "2n-icx": 2.600,
 163         "2n-skx": 2.500,
 164         "2n-spr": 2.800,
 165         "2n-tx2": 2.500,
 166         "2n-zn2": 2.900,
 167         "3n-alt": 3.000,
 168         "3n-aws": 1.000,
 169         "3n-dnv": 2.000,
 170         "3n-icx": 2.600,
 171         "3n-skx": 2.500,
 172         "3n-tsh": 2.200,
 173         "3n-snr": 2.200
 174     }
 175
 176     ############################################################################
 177     # General, plots constants.
 178
 179     PLOT_COLORS = (
 180         "#1A1110", "#DA2647", "#214FC6", "#01786F", "#BD8260", "#FFD12A",
 181         "#A6E7FF", "#738276", "#C95A49", "#FC5A8D", "#CEC8EF", "#391285",
 182         "#6F2DA8", "#FF878D", "#45A27D", "#FFD0B9", "#FD5240", "#DB91EF",
 183         "#44D7A8", "#4F86F7", "#84DE02", "#FFCFF1", "#614051"
 184     )
 185
 186     # Trending, anomalies.
 187     ANOMALY_COLOR = {
 188         "regression": 0.0,
 189         "normal": 0.5,
 190         "progression": 1.0
 191     }
 192
 193     COLORSCALE_TPUT = [
 194         [0.00, "red"],
 195         [0.33, "red"],
 196         [0.33, "white"],
 197         [0.66, "white"],
 198         [0.66, "green"],
 199         [1.00, "green"]
 200     ]
 201
 202     TICK_TEXT_TPUT = ["Regression", "Normal", "Progression"]
 203
 204     COLORSCALE_LAT = [
 205         [0.00, "green"],
 206         [0.33, "green"],
 207         [0.33, "white"],
 208         [0.66, "white"],
 209         [0.66, "red"],
 210         [1.00, "red"]
 211     ]
 212
 213     TICK_TEXT_LAT = ["Progression", "Normal", "Regression"]
 214
 215     # Access to the results.
 216     VALUE = {
 217         "mrr": "result_receive_rate_rate_avg",
 218         "ndr": "result_ndr_lower_rate_value",
 219         "pdr": "result_pdr_lower_rate_value",
 220         "latency": "result_latency_forward_pdr_50_avg",
 221         "hoststack-cps": "result_rate_value",
 222         "hoststack-rps": "result_rate_value",
 223         "hoststack-bps": "result_bandwidth_value",
 224         "hoststack-latency": "result_latency_value"
 225     }
 226
 227     VALUE_ITER = {
 228         "mrr": "result_receive_rate_rate_values",
 229         "ndr": "result_ndr_lower_rate_value",
 230         "pdr": "result_pdr_lower_rate_value",
 231         "latency": "result_latency_forward_pdr_50_avg",
 232         "hoststack-cps": "result_rate_value",
 233         "hoststack-rps": "result_rate_value",
 234         "hoststack-bps": "result_bandwidth_value",
 235         "hoststack-latency": "result_latency_value"
 236     }
 237
 238     UNIT = {
 239         "mrr": "result_receive_rate_rate_unit",
 240         "ndr": "result_ndr_lower_rate_unit",
 241         "pdr": "result_pdr_lower_rate_unit",
 242         "latency": "result_latency_forward_pdr_50_unit",
 243         "hoststack-cps": "result_rate_unit",
 244         "hoststack-rps": "result_rate_unit",
 245         "hoststack-bps": "result_bandwidth_unit",
 246         "hoststack-latency": "result_latency_unit"
 247     }
 248
 249     # Latencies.
 250     LAT_HDRH = (  # Do not change the order
 251         "result_latency_forward_pdr_0_hdrh",
 252         "result_latency_reverse_pdr_0_hdrh",
 253         "result_latency_forward_pdr_10_hdrh",
 254         "result_latency_reverse_pdr_10_hdrh",
 255         "result_latency_forward_pdr_50_hdrh",
 256         "result_latency_reverse_pdr_50_hdrh",
 257         "result_latency_forward_pdr_90_hdrh",
 258         "result_latency_reverse_pdr_90_hdrh",
 259     )
 260
 261     # This value depends on latency stream rate (9001 pps) and duration (5s).
 262     # Keep it slightly higher to ensure rounding errors to not remove tick mark.
 263     PERCENTILE_MAX = 99.999501
 264
 265     GRAPH_LAT_HDRH_DESC = {
 266         "result_latency_forward_pdr_0_hdrh": "No-load.",
 267         "result_latency_reverse_pdr_0_hdrh": "No-load.",
 268         "result_latency_forward_pdr_10_hdrh": "Low-load, 10% PDR.",
 269         "result_latency_reverse_pdr_10_hdrh": "Low-load, 10% PDR.",
 270         "result_latency_forward_pdr_50_hdrh": "Mid-load, 50% PDR.",
 271         "result_latency_reverse_pdr_50_hdrh": "Mid-load, 50% PDR.",
 272         "result_latency_forward_pdr_90_hdrh": "High-load, 90% PDR.",
 273         "result_latency_reverse_pdr_90_hdrh": "High-load, 90% PDR."
 274     }
 275
 276     ############################################################################
 277     # News.
 278
 279     # The title.
 280     NEWS_TITLE = "Failures and Anomalies"
 281
 282     # The pathname prefix for the application.
 283     NEWS_ROUTES_PATHNAME_PREFIX = "/news/"
 284
 285     # Time period for regressions and progressions.
 286     NEWS_TIME_PERIOD = TIME_PERIOD  # [days]
 287
 288     # Time periods for summary tables.
 289     NEWS_LAST = 1  # [days]
 290     NEWS_SHORT = 7  # [days]
 291     NEWS_LONG = NEWS_TIME_PERIOD  # [days]
 292
 293     ############################################################################
 294     # Report.
 295
 296     # The title.
 297     REPORT_TITLE = "Per Release Performance"
 298
 299     # The pathname prefix for the application.
 300     REPORT_ROUTES_PATHNAME_PREFIX = "/report/"
 301
 302     # Layout of plot.ly graphs.
 303     REPORT_GRAPH_LAYOUT_FILE = "cdash/report/layout.yaml"
 304
 305     # Default name of downloaded file with selected data.
 306     REPORT_DOWNLOAD_FILE_NAME = "iterative_data.csv"
 307
 308     ############################################################################
 309     # Comparisons.
 310
 311     # The title.
 312     COMP_TITLE = "Per Release Performance Comparisons"
 313
 314     # The pathname prefix for the application.
 315     COMP_ROUTES_PATHNAME_PREFIX = "/comparisons/"
 316
 317     # Default name of downloaded file with selected data.
 318     COMP_DOWNLOAD_FILE_NAME = "comparison_data.csv"
 319
 320     ############################################################################
 321     # Statistics.
 322
 323     # The title.
 324     STATS_TITLE = "Test Job Statistics"
 325
 326     # The pathname prefix for the application.
 327     STATS_ROUTES_PATHNAME_PREFIX = "/stats/"
 328
 329     # Layout of plot.ly graphs.
 330     STATS_GRAPH_LAYOUT_FILE = "cdash/stats/layout.yaml"
 331
 332     # The default job displayed when the page is loaded first time.
 333     STATS_DEFAULT_JOB = "csit-vpp-perf-mrr-daily-master-2n-icx"
 334
 335     # Default name of downloaded file with selected data.
 336     STATS_DOWNLOAD_FILE_NAME = "stats.csv"
 337
 338     ############################################################################
 339     # Trending.
 340
 341     # The title.
 342     TREND_TITLE = "Performance Trending"
 343
 344     # The pathname prefix for the application.
 345     TREND_ROUTES_PATHNAME_PREFIX = "/trending/"
 346
 347     # Layout of plot.ly graphs.
 348     TREND_GRAPH_LAYOUT_FILE = "cdash/trending/layout.yaml"
 349
 350     # Default name of downloaded file with selected data.
 351     TREND_DOWNLOAD_FILE_NAME = "trending_data.csv"
 352
 353     ############################################################################
 354     # Coverage data.
 355
 356     # The title.
 357     COVERAGE_TITLE = "Per Release Coverage Data"
 358
 359     # The pathname prefix for the application.
 360     COVERAGE_ROUTES_PATHNAME_PREFIX = "/coverage/"
 361
 362     # Default name of downloaded file with selected data.
 363     COVERAGE_DOWNLOAD_FILE_NAME = "coverage_data.csv"
 364
 365     ############################################################################