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         "hoststack": "Hoststack"
 131     }
 132
 133     # URL style.
 134     URL_STYLE = {
 135         "background-color": "#d2ebf5",
 136         "border-color": "#bce1f1",
 137         "color": "#135d7c"
 138     }
 139
 140     ############################################################################
 141     # General, normalization constants.
 142
 143     NORM_FREQUENCY = 2.0  # [GHz]
 144     FREQUENCY = {  # [GHz]
 145         "2n-aws": 1.000,
 146         "2n-dnv": 2.000,
 147         "2n-clx": 2.300,
 148         "2n-icx": 2.600,
 149         "2n-skx": 2.500,
 150         "2n-tx2": 2.500,
 151         "2n-zn2": 2.900,
 152         "3n-alt": 3.000,
 153         "3n-aws": 1.000,
 154         "3n-dnv": 2.000,
 155         "3n-icx": 2.600,
 156         "3n-skx": 2.500,
 157         "3n-tsh": 2.200,
 158         "3n-snr": 2.200
 159     }
 160
 161     ############################################################################
 162     # General, plots constants.
 163
 164     PLOT_COLORS = (
 165         "#1A1110", "#DA2647", "#214FC6", "#01786F", "#BD8260", "#FFD12A",
 166         "#A6E7FF", "#738276", "#C95A49", "#FC5A8D", "#CEC8EF", "#391285",
 167         "#6F2DA8", "#FF878D", "#45A27D", "#FFD0B9", "#FD5240", "#DB91EF",
 168         "#44D7A8", "#4F86F7", "#84DE02", "#FFCFF1", "#614051"
 169     )
 170
 171     # Trending, anomalies.
 172     ANOMALY_COLOR = {
 173         "regression": 0.0,
 174         "normal": 0.5,
 175         "progression": 1.0
 176     }
 177
 178     COLORSCALE_TPUT = [
 179         [0.00, "red"],
 180         [0.33, "red"],
 181         [0.33, "white"],
 182         [0.66, "white"],
 183         [0.66, "green"],
 184         [1.00, "green"]
 185     ]
 186
 187     TICK_TEXT_TPUT = ["Regression", "Normal", "Progression"]
 188
 189     COLORSCALE_LAT = [
 190         [0.00, "green"],
 191         [0.33, "green"],
 192         [0.33, "white"],
 193         [0.66, "white"],
 194         [0.66, "red"],
 195         [1.00, "red"]
 196     ]
 197
 198     TICK_TEXT_LAT = ["Progression", "Normal", "Regression"]
 199
 200     # Access to the results.
 201     VALUE = {
 202         "mrr": "result_receive_rate_rate_avg",
 203         "ndr": "result_ndr_lower_rate_value",
 204         "pdr": "result_pdr_lower_rate_value",
 205         "pdr-lat": "result_latency_forward_pdr_50_avg",
 206         "cps": "result_bandwidth_value",
 207         "rps": "result_bandwidth_value",
 208         "bps": "result_bandwidth_value"
 209     }
 210
 211     VALUE_ITER = {
 212         "mrr": "result_receive_rate_rate_values",
 213         "ndr": "result_ndr_lower_rate_value",
 214         "pdr": "result_pdr_lower_rate_value",
 215         "pdr-lat": "result_latency_forward_pdr_50_avg",
 216         "cps": "result_bandwidth_value",
 217         "rps": "result_bandwidth_value",
 218         "bps": "result_bandwidth_value"
 219     }
 220
 221     UNIT = {
 222         "mrr": "result_receive_rate_rate_unit",
 223         "ndr": "result_ndr_lower_rate_unit",
 224         "pdr": "result_pdr_lower_rate_unit",
 225         "pdr-lat": "result_latency_forward_pdr_50_unit",
 226         "cps": "result_bandwidth_unit",
 227         "rps": "result_bandwidth_unit",
 228         "bps": "result_bandwidth_unit"
 229     }
 230
 231     # Latencies.
 232     LAT_HDRH = (  # Do not change the order
 233         "result_latency_forward_pdr_0_hdrh",
 234         "result_latency_reverse_pdr_0_hdrh",
 235         "result_latency_forward_pdr_10_hdrh",
 236         "result_latency_reverse_pdr_10_hdrh",
 237         "result_latency_forward_pdr_50_hdrh",
 238         "result_latency_reverse_pdr_50_hdrh",
 239         "result_latency_forward_pdr_90_hdrh",
 240         "result_latency_reverse_pdr_90_hdrh",
 241     )
 242
 243     # This value depends on latency stream rate (9001 pps) and duration (5s).
 244     # Keep it slightly higher to ensure rounding errors to not remove tick mark.
 245     PERCENTILE_MAX = 99.999501
 246
 247     GRAPH_LAT_HDRH_DESC = {
 248         "result_latency_forward_pdr_0_hdrh": "No-load.",
 249         "result_latency_reverse_pdr_0_hdrh": "No-load.",
 250         "result_latency_forward_pdr_10_hdrh": "Low-load, 10% PDR.",
 251         "result_latency_reverse_pdr_10_hdrh": "Low-load, 10% PDR.",
 252         "result_latency_forward_pdr_50_hdrh": "Mid-load, 50% PDR.",
 253         "result_latency_reverse_pdr_50_hdrh": "Mid-load, 50% PDR.",
 254         "result_latency_forward_pdr_90_hdrh": "High-load, 90% PDR.",
 255         "result_latency_reverse_pdr_90_hdrh": "High-load, 90% PDR."
 256     }
 257
 258     ############################################################################
 259     # News.
 260
 261     # The title.
 262     NEWS_TITLE = "Failures and Anomalies"
 263
 264     # The pathname prefix for the application.
 265     NEWS_ROUTES_PATHNAME_PREFIX = "/news/"
 266
 267     # Time period for regressions and progressions.
 268     NEWS_TIME_PERIOD = TIME_PERIOD  # [days]
 269
 270     # Time periods for summary tables.
 271     NEWS_LAST = 1  # [days]
 272     NEWS_SHORT = 7  # [days]
 273     NEWS_LONG = NEWS_TIME_PERIOD  # [days]
 274
 275     ############################################################################
 276     # Report.
 277
 278     # The title.
 279     REPORT_TITLE = "Per Release Performance"
 280
 281     # The pathname prefix for the application.
 282     REPORT_ROUTES_PATHNAME_PREFIX = "/report/"
 283
 284     # Layout of plot.ly graphs.
 285     REPORT_GRAPH_LAYOUT_FILE = "cdash/report/layout.yaml"
 286
 287     # Default name of downloaded file with selected data.
 288     REPORT_DOWNLOAD_FILE_NAME = "iterative_data.csv"
 289
 290     ############################################################################
 291     # Statistics.
 292
 293     # The title.
 294     STATS_TITLE = "Test Job Statistics"
 295
 296     # The pathname prefix for the application.
 297     STATS_ROUTES_PATHNAME_PREFIX = "/stats/"
 298
 299     # Layout of plot.ly graphs.
 300     STATS_GRAPH_LAYOUT_FILE = "cdash/stats/layout.yaml"
 301
 302     # The default job displayed when the page is loaded first time.
 303     STATS_DEFAULT_JOB = "csit-vpp-perf-mrr-daily-master-2n-icx"
 304
 305     # Default name of downloaded file with selected data.
 306     STATS_DOWNLOAD_FILE_NAME = "stats.csv"
 307
 308     ############################################################################
 309     # Trending.
 310
 311     # The title.
 312     TREND_TITLE = "Performance Trending"
 313
 314     # The pathname prefix for the application.
 315     TREND_ROUTES_PATHNAME_PREFIX = "/trending/"
 316
 317     # Layout of plot.ly graphs.
 318     TREND_GRAPH_LAYOUT_FILE = "cdash/trending/layout.yaml"
 319
 320     # Default name of downloaded file with selected data.
 321     TREND_DOWNLOAD_FILE_NAME = "trending_data.csv"