1 # Copyright (c) 2024 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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """Constants used in CDash.
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.
26 """Constants used in CDash.
29 ############################################################################
30 # General, application wide constants.
33 LOG_LEVEL = logging.INFO
34 LOG_FORMAT = "%(asctime)s: %(levelname)s: %(message)s"
35 LOG_DATE_FORMAT = "%Y/%m/%d %H:%M:%S"
37 # The application title.
41 # The application description.
42 DESCRIPTION = "Performance Dashboard"
44 # External stylesheets.
45 EXTERNAL_STYLESHEETS = ["/static/dist/css/bootstrap.css", ]
48 URL_JENKINS = "https://jenkins.fd.io/job/"
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/"
54 # Path and name of the file specifying the HTML layout of the dash
56 MAIN_HTML_LAYOUT_FILE = "base_layout.jinja2"
58 # Path and name of the file specifying the HTML layout of the dash
60 HTML_LAYOUT_FILE = "cdash/templates/dash_layout.jinja2"
65 # Data to be downloaded from the parquets specification file.
66 DATA_SPEC_FILE = "cdash/data/data.yaml"
68 # Path to schemas to use when reading data from the parquet.
69 PATH_TO_SCHEMAS = "cdash/data/_metadata/"
71 # The file with tooltips.
72 TOOLTIP_FILE = "cdash/utils/tooltips.yaml"
74 # Maximal value of TIME_PERIOD for data read from the parquets in days.
75 # Do not change without a good reason.
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]
84 ############################################################################
85 # General, application wide, layout affecting constants.
87 # Add a time delay (in ms) to the spinner being shown
90 # If True, clear all inputs in control panel when button "ADD SELECTED" is
92 CLEAR_ALL_INPUTS = False
94 # The element is disabled.
95 STYLE_DISABLED = {"visibility": "hidden"}
97 # The element is enabled and visible.
98 STYLE_ENABLED = {"visibility": "visible"}
100 # The element is not displayed.
101 STYLE_DONT_DISPLAY = {"display": "none"}
103 # The element is displaed.
104 STYLE_DISPLAY = {"display": "flex"}
106 # Checklist "All" is disabled.
115 # Checklist "All" is enabled, visible and unchecked.
124 # Placeholder for any element in the layout.
125 PLACEHOLDER = html.Nobr("")
127 # List of drivers used in CSIT.
128 DRIVERS = ("avf", "af-xdp", "rdma", "dpdk", "mlx5")
130 # Labels for input elements (dropdowns, ...).
133 "container_memif": "LXC/DRC Container Memif",
134 "crypto": "IPSec IPv4 Routing",
136 "ip4": "IPv4 Routing",
137 "ip4_tunnels": "IPv4 Tunnels",
138 "ip6": "IPv6 Routing",
139 "ip6_tunnels": "IPv6 Tunnels",
140 "l2": "L2 Ethernet Switching",
141 "lb": "Load Balancer",
142 "srv6": "SRv6 Routing",
143 "vm_vhost": "VMs vhost-user",
144 "nfv_density.dcr_memif.chain_ipsec": "CNF Service Chains Routing IPSec",
145 "nfv_density.vm_vhost.chain_dot1qip4vxlan":"VNF Service Chains Tunnels",
146 "nfv_density.vm_vhost.chain": "VNF Service Chains Routing",
147 "nfv_density.dcr_memif.pipeline": "CNF Service Pipelines Routing",
148 "nfv_density.dcr_memif.chain": "CNF Service Chains Routing",
149 "hoststack": "Hoststack",
151 "l2bd": "L2 Bridge Domain",
152 "crypto.ethip4": "IPSec IPv4 Routing",
153 "crypto.ethip6": "IPSec IPv6 Routing",
154 "interfaces": "Interfaces",
155 "ip4_tunnels.lisp": "IPv4 Tunnels LISP",
156 "ip6_tunnels.lisp": "IPv6 Tunnels LISP",
157 "l2patch": "L2 Patch",
158 "l2xc": "L2 Cross Connect",
159 "vm_vhost.ethip4": "VMs vhost-user IPv4 Routing",
160 "vm_vhost.ethip6": "VMs vhost-user IPv6 Routing"
165 "background-color": "#d2ebf5",
166 "border-color": "#bce1f1",
170 ############################################################################
171 # General, normalization constants.
173 NORM_FREQUENCY = 2.0 # [GHz]
174 FREQUENCY = { # [GHz]
192 ############################################################################
193 # General, plots and tables constants.
196 "#1A1110", "#DA2647", "#214FC6", "#01786F", "#BD8260", "#FFD12A",
197 "#A6E7FF", "#738276", "#C95A49", "#FC5A8D", "#CEC8EF", "#391285",
198 "#6F2DA8", "#FF878D", "#45A27D", "#FFD0B9", "#FD5240", "#DB91EF",
199 "#44D7A8", "#4F86F7", "#84DE02", "#FFCFF1", "#614051"
202 # Trending, anomalies.
218 TICK_TEXT_TPUT = ["Regression", "Normal", "Progression"]
229 TICK_TEXT_LAT = ["Progression", "Normal", "Regression"]
231 # Access to the results.
233 "mrr": "result_receive_rate_rate_avg",
234 "ndr": "result_ndr_lower_rate_value",
235 "pdr": "result_pdr_lower_rate_value",
236 "mrr-bandwidth": "result_receive_rate_bandwidth_avg",
237 "ndr-bandwidth": "result_ndr_lower_bandwidth_value",
238 "pdr-bandwidth": "result_pdr_lower_bandwidth_value",
239 "latency": "result_latency_forward_pdr_50_avg",
240 "hoststack-cps": "result_rate_value",
241 "hoststack-rps": "result_rate_value",
242 "hoststack-cps-bandwidth": "result_bandwidth_value",
243 "hoststack-rps-bandwidth": "result_bandwidth_value",
244 "hoststack-bps": "result_bandwidth_value",
245 "hoststack-latency": "result_latency_value"
249 "mrr": "result_receive_rate_rate_values",
250 "ndr": "result_ndr_lower_rate_value",
251 "pdr": "result_pdr_lower_rate_value",
252 "mrr-bandwidth": "result_receive_rate_bandwidth_avg",
253 "ndr-bandwidth": "result_ndr_lower_bandwidth_value",
254 "pdr-bandwidth": "result_pdr_lower_bandwidth_value",
255 "latency": "result_latency_forward_pdr_50_avg",
256 "hoststack-cps": "result_rate_value",
257 "hoststack-rps": "result_rate_value",
258 "hoststack-bps": "result_bandwidth_value",
259 "hoststack-latency": "result_latency_value"
263 "mrr": "result_receive_rate_rate_unit",
264 "ndr": "result_ndr_lower_rate_unit",
265 "pdr": "result_pdr_lower_rate_unit",
266 "mrr-bandwidth": "result_receive_rate_bandwidth_unit",
267 "ndr-bandwidth": "result_ndr_lower_bandwidth_unit",
268 "pdr-bandwidth": "result_pdr_lower_bandwidth_unit",
269 "latency": "result_latency_forward_pdr_50_unit",
270 "hoststack-cps": "result_rate_unit",
271 "hoststack-rps": "result_rate_unit",
272 "hoststack-cps-bandwidth": "result_bandwidth_unit",
273 "hoststack-rps-bandwidth": "result_bandwidth_unit",
274 "hoststack-bps": "result_bandwidth_unit",
275 "hoststack-latency": "result_latency_unit"
279 LAT_HDRH = ( # Do not change the order
280 "result_latency_forward_pdr_0_hdrh",
281 "result_latency_reverse_pdr_0_hdrh",
282 "result_latency_forward_pdr_10_hdrh",
283 "result_latency_reverse_pdr_10_hdrh",
284 "result_latency_forward_pdr_50_hdrh",
285 "result_latency_reverse_pdr_50_hdrh",
286 "result_latency_forward_pdr_90_hdrh",
287 "result_latency_reverse_pdr_90_hdrh",
290 # This value depends on latency stream rate (9001 pps) and duration (5s).
291 # Keep it slightly higher to ensure rounding errors to not remove tick mark.
292 PERCENTILE_MAX = 99.999501
294 GRAPH_LAT_HDRH_DESC = {
295 "result_latency_forward_pdr_0_hdrh": "No-load.",
296 "result_latency_reverse_pdr_0_hdrh": "No-load.",
297 "result_latency_forward_pdr_10_hdrh": "Low-load, 10% PDR.",
298 "result_latency_reverse_pdr_10_hdrh": "Low-load, 10% PDR.",
299 "result_latency_forward_pdr_50_hdrh": "Mid-load, 50% PDR.",
300 "result_latency_reverse_pdr_50_hdrh": "Mid-load, 50% PDR.",
301 "result_latency_forward_pdr_90_hdrh": "High-load, 90% PDR.",
302 "result_latency_reverse_pdr_90_hdrh": "High-load, 90% PDR."
305 # Operators used to filter data in comparison tables.
314 ("datestartswith ", )
317 ############################################################################
321 NEWS_TITLE = "Failures and Anomalies"
323 # The pathname prefix for the application.
324 NEWS_ROUTES_PATHNAME_PREFIX = "/news/"
326 # Time period for regressions and progressions.
327 NEWS_TIME_PERIOD = TIME_PERIOD # [days]
329 # Time periods for summary tables.
330 NEWS_LAST = 1 # [days]
331 NEWS_SHORT = 7 # [days]
332 NEWS_LONG = NEWS_TIME_PERIOD # [days]
334 ############################################################################
338 REPORT_TITLE = "Per Release Performance"
340 # The pathname prefix for the application.
341 REPORT_ROUTES_PATHNAME_PREFIX = "/report/"
343 # Layout of plot.ly graphs.
344 REPORT_GRAPH_LAYOUT_FILE = "cdash/report/layout.yaml"
346 # Default name of downloaded file with selected data.
347 REPORT_DOWNLOAD_FILE_NAME = "iterative_data.csv"
349 ############################################################################
353 COMP_TITLE = "Per Release Performance Comparisons"
355 # The pathname prefix for the application.
356 COMP_ROUTES_PATHNAME_PREFIX = "/comparisons/"
358 # Default name of downloaded file with selected data.
359 COMP_DOWNLOAD_FILE_NAME = "comparison_data.csv"
361 # This parameter specifies the method to use for estimating the percentile.
364 # - averaged_inverted_cdf
365 # - closest_observation
366 # - interpolated_inverted_cdf
372 COMP_PERCENTILE_METHOD = "linear"
374 # Extreme or mild outlier?
377 COMP_OUTLIER_TYPE = OUTLIER_EXTREME
379 ############################################################################
383 STATS_TITLE = "Test Job Statistics"
385 # The pathname prefix for the application.
386 STATS_ROUTES_PATHNAME_PREFIX = "/stats/"
388 # Layout of plot.ly graphs.
389 STATS_GRAPH_LAYOUT_FILE = "cdash/stats/layout.yaml"
391 # The default job displayed when the page is loaded first time.
392 STATS_DEFAULT_JOB = "csit-vpp-perf-mrr-daily-master-2n-icx"
394 # Default name of downloaded file with selected data.
395 STATS_DOWNLOAD_FILE_NAME = "stats.csv"
397 # The width of the bar in the graph in miliseconds.
398 STATS_BAR_WIDTH_DAILY = 1000 * 3600 * 15
399 STATS_BAR_WIDTH_WEEKLY = 1000 * 3600 * 24
401 ############################################################################
405 TREND_TITLE = "Performance Trending"
407 # The pathname prefix for the application.
408 TREND_ROUTES_PATHNAME_PREFIX = "/trending/"
410 # Layout of plot.ly graphs.
411 TREND_GRAPH_LAYOUT_FILE = "cdash/trending/layout.yaml"
413 # Default name of downloaded file with selected data.
414 TREND_DOWNLOAD_FILE_NAME = "trending_data.csv"
415 TELEMETRY_DOWNLOAD_FILE_NAME = "telemetry_data.csv"
417 ############################################################################
421 COVERAGE_TITLE = "Per Release Coverage Data"
423 # The pathname prefix for the application.
424 COVERAGE_ROUTES_PATHNAME_PREFIX = "/coverage/"
426 # Default name of downloaded file with selected data.
427 COVERAGE_DOWNLOAD_FILE_NAME = "coverage_data.csv"
429 ############################################################################
433 SEARCH_TITLE = "Search Tests"
435 # The pathname prefix for the application.
436 SEARCH_ROUTES_PATHNAME_PREFIX = "/search/"
438 # Layout of plot.ly graphs.
439 SEARCH_GRAPH_LAYOUT_FILE = "cdash/search/layout.yaml"
441 # Default name of downloaded file with selected data.
442 SEARCH_DOWNLOAD_FILE_NAME = "search_data.csv"
444 ############################################################################