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     # URL to Jenkins
  48     URL_JENKINS = "https://jenkins.fd.io/job/"
  49
  50     # URL to the documentation
  51     URL_DOC_TRENDING = "https://csit.fd.io/cdocs/methodology/trending/analysis/"
  52     URL_DOC_REL_NOTES = "https://csit.fd.io/cdocs/release_notes/current/"
  53
  54     # Path and name of the file specifying the HTML layout of the dash
  55     # application.
  56     MAIN_HTML_LAYOUT_FILE = "base_layout.jinja2"
  57
  58     # Path and name of the file specifying the HTML layout of the dash
  59     # application.
  60     HTML_LAYOUT_FILE = "cdash/templates/dash_layout.jinja2"
  61
  62     # Application root.
  63     APPLICATIN_ROOT = "/"
  64
  65     # Data to be downloaded from the parquets specification file.
  66     DATA_SPEC_FILE = "cdash/data/data.yaml"
  67
  68     # Path to schemas to use when reading data from the parquet.
  69     PATH_TO_SCHEMAS = "cdash/data/_metadata/"
  70
  71     # The file with tooltips.
  72     TOOLTIP_FILE = "cdash/utils/tooltips.yaml"
  73
  74     # Maximal value of TIME_PERIOD for data read from the parquets in days.
  75     # Do not change without a good reason.
  76     MAX_TIME_PERIOD = 130
  77
  78     # It defines the time period for data read from the parquets in days from
  79     # now back to the past.
  80     # TIME_PERIOD = None - means all data (max MAX_TIME_PERIOD days) is read.
  81     # TIME_PERIOD = MAX_TIME_PERIOD - is the default value
  82     TIME_PERIOD = MAX_TIME_PERIOD  # [days]
  83
  84     ############################################################################
  85     # General, application wide, layout affecting constants.
  86
  87     # Add a time delay (in ms) to the spinner being shown
  88     SPINNER_DELAY = 500
  89
  90     # If True, clear all inputs in control panel when button "ADD SELECTED" is
  91     # pressed.
  92     CLEAR_ALL_INPUTS = False
  93
  94     # The element is disabled.
  95     STYLE_DISABLED = {"visibility": "hidden"}
  96
  97     # The element is enabled and visible.
  98     STYLE_ENABLED = {"visibility": "visible"}
  99
 100     # Checklist "All" is disabled.
 101     CL_ALL_DISABLED = [
 102         {
 103             "label": "All",
 104             "value": "all",
 105             "disabled": True
 106         }
 107     ]
 108
 109     # Checklist "All" is enabled, visible and unchecked.
 110     CL_ALL_ENABLED = [
 111         {
 112             "label": "All",
 113             "value": "all",
 114             "disabled": False
 115         }
 116     ]
 117
 118     # Placeholder for any element in the layout.
 119     PLACEHOLDER = html.Nobr("")
 120
 121     # List of drivers used in CSIT.
 122     DRIVERS = ("avf", "af-xdp", "rdma", "dpdk", "mlx5")
 123
 124     # Labels for input elements (dropdowns, ...).
 125     LABELS = {
 126         "dpdk": "DPDK",
 127         "container_memif": "LXC/DRC Container Memif",
 128         "crypto": "IPSec IPv4 Routing",
 129         "ip4": "IPv4 Routing",
 130         "ip4_tunnels": "IPv4 Tunnels",
 131         "ip6": "IPv6 Routing",
 132         "ip6_tunnels": "IPv6 Tunnels",
 133         "l2": "L2 Ethernet Switching",
 134         "lb": "Load Balancer",
 135         "srv6": "SRv6 Routing",
 136         "vm_vhost": "VMs vhost-user",
 137         "nfv_density.dcr_memif.chain_ipsec": "CNF Service Chains Routing IPSec",
 138         "nfv_density.vm_vhost.chain_dot1qip4vxlan":"VNF Service Chains Tunnels",
 139         "nfv_density.vm_vhost.chain": "VNF Service Chains Routing",
 140         "nfv_density.dcr_memif.pipeline": "CNF Service Pipelines Routing",
 141         "nfv_density.dcr_memif.chain": "CNF Service Chains Routing",
 142         "hoststack": "Hoststack",
 143         "flow": "Flow",
 144         "l2bd": "L2 Bridge Domain",
 145         "crypto.ethip4": "IPSec IPv4 Routing",
 146         "crypto.ethip6": "IPSec IPv6 Routing",
 147         "interfaces": "Interfaces",
 148         "ip4_tunnels.lisp": "IPv4 Tunnels LISP",
 149         "ip6_tunnels.lisp": "IPv6 Tunnels LISP",
 150         "l2patch": "L2 Patch",
 151         "l2xc": "L2 Cross Connect",
 152         "vm_vhost.ethip4": "VMs vhost-user IPv4 Routing",
 153         "vm_vhost.ethip6": "VMs vhost-user IPv6 Routing"
 154     }
 155
 156     # URL style.
 157     URL_STYLE = {
 158         "background-color": "#d2ebf5",
 159         "border-color": "#bce1f1",
 160         "color": "#135d7c"
 161     }
 162
 163     ############################################################################
 164     # General, normalization constants.
 165
 166     NORM_FREQUENCY = 2.0  # [GHz]
 167     FREQUENCY = {  # [GHz]
 168         "1n-aws": 1.000,
 169         "2n-aws": 1.000,
 170         "2n-dnv": 2.000,
 171         "2n-clx": 2.300,
 172         "2n-icx": 2.600,
 173         "2n-skx": 2.500,
 174         "2n-spr": 2.800,
 175         "2n-tx2": 2.500,
 176         "2n-zn2": 2.900,
 177         "3n-alt": 3.000,
 178         "3n-aws": 1.000,
 179         "3n-dnv": 2.000,
 180         "3n-icx": 2.600,
 181         "3n-skx": 2.500,
 182         "3n-tsh": 2.200,
 183         "3n-snr": 2.200,
 184         "3na-spr": 2.800,
 185         "3nb-spr": 2.800
 186     }
 187
 188     ############################################################################
 189     # General, plots and tables constants.
 190
 191     PLOT_COLORS = (
 192         "#1A1110", "#DA2647", "#214FC6", "#01786F", "#BD8260", "#FFD12A",
 193         "#A6E7FF", "#738276", "#C95A49", "#FC5A8D", "#CEC8EF", "#391285",
 194         "#6F2DA8", "#FF878D", "#45A27D", "#FFD0B9", "#FD5240", "#DB91EF",
 195         "#44D7A8", "#4F86F7", "#84DE02", "#FFCFF1", "#614051"
 196     )
 197
 198     # Trending, anomalies.
 199     ANOMALY_COLOR = {
 200         "regression": 0.0,
 201         "normal": 0.5,
 202         "progression": 1.0
 203     }
 204
 205     COLORSCALE_TPUT = [
 206         [0.00, "red"],
 207         [0.33, "red"],
 208         [0.33, "white"],
 209         [0.66, "white"],
 210         [0.66, "green"],
 211         [1.00, "green"]
 212     ]
 213
 214     TICK_TEXT_TPUT = ["Regression", "Normal", "Progression"]
 215
 216     COLORSCALE_LAT = [
 217         [0.00, "green"],
 218         [0.33, "green"],
 219         [0.33, "white"],
 220         [0.66, "white"],
 221         [0.66, "red"],
 222         [1.00, "red"]
 223     ]
 224
 225     TICK_TEXT_LAT = ["Progression", "Normal", "Regression"]
 226
 227     # Access to the results.
 228     VALUE = {
 229         "mrr": "result_receive_rate_rate_avg",
 230         "ndr": "result_ndr_lower_rate_value",
 231         "pdr": "result_pdr_lower_rate_value",
 232         "mrr-bandwidth": "result_receive_rate_bandwidth_avg",
 233         "ndr-bandwidth": "result_ndr_lower_bandwidth_value",
 234         "pdr-bandwidth": "result_pdr_lower_bandwidth_value",
 235         "latency": "result_latency_forward_pdr_50_avg",
 236         "hoststack-cps": "result_rate_value",
 237         "hoststack-rps": "result_rate_value",
 238         "hoststack-cps-bandwidth": "result_bandwidth_value",
 239         "hoststack-rps-bandwidth": "result_bandwidth_value",
 240         "hoststack-bps": "result_bandwidth_value",
 241         "hoststack-latency": "result_latency_value"
 242     }
 243
 244     VALUE_ITER = {
 245         "mrr": "result_receive_rate_rate_values",
 246         "ndr": "result_ndr_lower_rate_value",
 247         "pdr": "result_pdr_lower_rate_value",
 248         "latency": "result_latency_forward_pdr_50_avg",
 249         "hoststack-cps": "result_rate_value",
 250         "hoststack-rps": "result_rate_value",
 251         "hoststack-bps": "result_bandwidth_value",
 252         "hoststack-latency": "result_latency_value"
 253     }
 254
 255     UNIT = {
 256         "mrr": "result_receive_rate_rate_unit",
 257         "ndr": "result_ndr_lower_rate_unit",
 258         "pdr": "result_pdr_lower_rate_unit",
 259         "mrr-bandwidth": "result_receive_rate_bandwidth_unit",
 260         "ndr-bandwidth": "result_ndr_lower_bandwidth_unit",
 261         "pdr-bandwidth": "result_pdr_lower_bandwidth_unit",
 262         "latency": "result_latency_forward_pdr_50_unit",
 263         "hoststack-cps": "result_rate_unit",
 264         "hoststack-rps": "result_rate_unit",
 265         "hoststack-cps-bandwidth": "result_bandwidth_unit",
 266         "hoststack-rps-bandwidth": "result_bandwidth_unit",
 267         "hoststack-bps": "result_bandwidth_unit",
 268         "hoststack-latency": "result_latency_unit"
 269     }
 270
 271     # Latencies.
 272     LAT_HDRH = (  # Do not change the order
 273         "result_latency_forward_pdr_0_hdrh",
 274         "result_latency_reverse_pdr_0_hdrh",
 275         "result_latency_forward_pdr_10_hdrh",
 276         "result_latency_reverse_pdr_10_hdrh",
 277         "result_latency_forward_pdr_50_hdrh",
 278         "result_latency_reverse_pdr_50_hdrh",
 279         "result_latency_forward_pdr_90_hdrh",
 280         "result_latency_reverse_pdr_90_hdrh",
 281     )
 282
 283     # This value depends on latency stream rate (9001 pps) and duration (5s).
 284     # Keep it slightly higher to ensure rounding errors to not remove tick mark.
 285     PERCENTILE_MAX = 99.999501
 286
 287     GRAPH_LAT_HDRH_DESC = {
 288         "result_latency_forward_pdr_0_hdrh": "No-load.",
 289         "result_latency_reverse_pdr_0_hdrh": "No-load.",
 290         "result_latency_forward_pdr_10_hdrh": "Low-load, 10% PDR.",
 291         "result_latency_reverse_pdr_10_hdrh": "Low-load, 10% PDR.",
 292         "result_latency_forward_pdr_50_hdrh": "Mid-load, 50% PDR.",
 293         "result_latency_reverse_pdr_50_hdrh": "Mid-load, 50% PDR.",
 294         "result_latency_forward_pdr_90_hdrh": "High-load, 90% PDR.",
 295         "result_latency_reverse_pdr_90_hdrh": "High-load, 90% PDR."
 296     }
 297
 298     # Operators used to filter data in comparison tables.
 299     OPERATORS = (
 300         ("contains ", ),
 301         ("lt ", "<"),
 302         ("gt ", ">"),
 303         ("eq ", "="),
 304         ("ge ", ">="),
 305         ("le ", "<="),
 306         ("ne ", "!="),
 307         ("datestartswith ", )
 308     )
 309
 310     ############################################################################
 311     # News.
 312
 313     # The title.
 314     NEWS_TITLE = "Failures and Anomalies"
 315
 316     # The pathname prefix for the application.
 317     NEWS_ROUTES_PATHNAME_PREFIX = "/news/"
 318
 319     # Time period for regressions and progressions.
 320     NEWS_TIME_PERIOD = TIME_PERIOD  # [days]
 321
 322     # Time periods for summary tables.
 323     NEWS_LAST = 1  # [days]
 324     NEWS_SHORT = 7  # [days]
 325     NEWS_LONG = NEWS_TIME_PERIOD  # [days]
 326
 327     ############################################################################
 328     # Report.
 329
 330     # The title.
 331     REPORT_TITLE = "Per Release Performance"
 332
 333     # The pathname prefix for the application.
 334     REPORT_ROUTES_PATHNAME_PREFIX = "/report/"
 335
 336     # Layout of plot.ly graphs.
 337     REPORT_GRAPH_LAYOUT_FILE = "cdash/report/layout.yaml"
 338
 339     # Default name of downloaded file with selected data.
 340     REPORT_DOWNLOAD_FILE_NAME = "iterative_data.csv"
 341
 342     ############################################################################
 343     # Comparisons.
 344
 345     # The title.
 346     COMP_TITLE = "Per Release Performance Comparisons"
 347
 348     # The pathname prefix for the application.
 349     COMP_ROUTES_PATHNAME_PREFIX = "/comparisons/"
 350
 351     # Default name of downloaded file with selected data.
 352     COMP_DOWNLOAD_FILE_NAME = "comparison_data.csv"
 353
 354     ############################################################################
 355     # Statistics.
 356
 357     # The title.
 358     STATS_TITLE = "Test Job Statistics"
 359
 360     # The pathname prefix for the application.
 361     STATS_ROUTES_PATHNAME_PREFIX = "/stats/"
 362
 363     # Layout of plot.ly graphs.
 364     STATS_GRAPH_LAYOUT_FILE = "cdash/stats/layout.yaml"
 365
 366     # The default job displayed when the page is loaded first time.
 367     STATS_DEFAULT_JOB = "csit-vpp-perf-mrr-daily-master-2n-icx"
 368
 369     # Default name of downloaded file with selected data.
 370     STATS_DOWNLOAD_FILE_NAME = "stats.csv"
 371
 372     # The width of the bar in the graph in miliseconds.
 373     STATS_BAR_WIDTH_DAILY = 1000 * 3600 * 15
 374     STATS_BAR_WIDTH_WEEKLY = 1000 * 3600 * 24
 375
 376     ############################################################################
 377     # Trending.
 378
 379     # The title.
 380     TREND_TITLE = "Performance Trending"
 381
 382     # The pathname prefix for the application.
 383     TREND_ROUTES_PATHNAME_PREFIX = "/trending/"
 384
 385     # Layout of plot.ly graphs.
 386     TREND_GRAPH_LAYOUT_FILE = "cdash/trending/layout.yaml"
 387
 388     # Default name of downloaded file with selected data.
 389     TREND_DOWNLOAD_FILE_NAME = "trending_data.csv"
 390     TELEMETRY_DOWNLOAD_FILE_NAME = "telemetry_data.csv"
 391
 392     ############################################################################
 393     # Coverage data.
 394
 395     # The title.
 396     COVERAGE_TITLE = "Per Release Coverage Data"
 397
 398     # The pathname prefix for the application.
 399     COVERAGE_ROUTES_PATHNAME_PREFIX = "/coverage/"
 400
 401     # Default name of downloaded file with selected data.
 402     COVERAGE_DOWNLOAD_FILE_NAME = "coverage_data.csv"
 403
 404     ############################################################################