aboutsummaryrefslogtreecommitdiffstats
path: root/resources/tools/presentation/specification_CPTA.yaml
blob: 51cdc6324b8b99f86a517f1dc7941e6a707c1310 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# Copyright (c) 2018 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# This is the specification of parameters for "Continuous Performance Trending
# and Analysis" feature provided by PAL.

-
  type: "environment"
  configuration:
    # Debug mode:
    # - Skip:
    #   - Download of input data files
    # - Do:
    #   - Read data from given zip / xml files
    #   - Set the configuration as it is done in normal mode
    # If the section "type: debug" is missing, CFG[DEBUG] is set to 0.
    CFG[DEBUG]: 0

  paths:
    # Top level directories:
    ## Working directory
    DIR[WORKING]: "_tmp"
    ## Build directories
    DIR[BUILD,HTML]: "_build"
    ## Static .rst files
    DIR[RST]: "../../../docs/cpta"

    # Static html content
    DIR[STATIC]: "{DIR[BUILD,HTML]}/_static"
    DIR[STATIC,VPP]: "{DIR[STATIC]}/vpp"
    # DIR[STATIC,DPDK]: "{DIR[STATIC]}/dpdk"
    DIR[STATIC,ARCH]: "{DIR[STATIC]}/archive"

    # Working directories
    ## Input data files (.zip, .xml)
    DIR[WORKING,DATA]: "{DIR[WORKING]}/data"
    ## Static source files from git
    DIR[WORKING,SRC]: "{DIR[WORKING]}/src"
    DIR[WORKING,SRC,STATIC]: "{DIR[WORKING,SRC]}/_static"

    # .css patch file
    DIR[CSS_PATCH_FILE]: "{DIR[STATIC]}/theme_overrides.css"
    DIR[CSS_PATCH_FILE2]: "{DIR[WORKING,SRC,STATIC]}/theme_overrides.css"

  urls:
    URL[JENKINS,CSIT]: "https://jenkins.fd.io/view/csit/job"
    URL[NEXUS,LOG]: "https://logs.fd.io/production/vex-yul-rot-jenkins-1"
    URL[NEXUS]: "https://docs.fd.io/csit"
    DIR[NEXUS]: "report/_static/archive"

  make-dirs:
  # List the directories which are created while preparing the environment.
  # All directories MUST be defined in "paths" section.
  - "DIR[WORKING,DATA]"
  - "DIR[WORKING,SRC,STATIC]"
  - "DIR[BUILD,HTML]"
  - "DIR[STATIC,VPP]"
  - "DIR[STATIC,ARCH]"
  build-dirs:
  # List the directories where the results (build) is stored.
  # All directories MUST be defined in "paths" section.
  - "DIR[BUILD,HTML]"

-
  type: "configuration"

  data-sets:
# TODO: Specify input data, this is only an example:
    plot-performance-trending:
      csit-vpp-perf-mrr-daily-master:
        start: 9
        end: 14 # "lastSuccessfulBuild"  # take all from the 'start'

  plot-layouts:
    plot-cpta:
      title: ""
      autosize: False
      showlegend: True
      width: 1100
      height: 800
      yaxis:
        showticklabels: True
        title: "Throughput [Mpps]"
        hoverformat: ".4s"
        range: []
        gridcolor: "rgb(238, 238, 238)"
        linecolor: "rgb(238, 238, 238)"
        showline: True
        zeroline: False
        tickcolor: "rgb(238, 238, 238)"
        linewidth: 1
        showgrid: True
      xaxis:
        showticklabels: True
        title: "VPP Performance Trending Job ID"
        autorange: True
        showgrid: True
        gridcolor: "rgb(238, 238, 238)"
        linecolor: "rgb(238, 238, 238)"
        fixedrange: False
        zeroline: False
        tickcolor: "rgb(238, 238, 238)"
        showline: True
        linewidth: 1
        autotick: True
      margin:
        r: 20
        b: 50
        t: 50
        l: 70
      legend:
        orientation: "h"
        traceorder: "normal"
#        tracegroupgap: 10
#        bordercolor: "rgb(238, 238, 238)"
#        borderwidth: 1

-
  type: "debug"
  general:
    input-format: "xml"  # zip or xml
    extract: "robot-plugin/output.xml"  # Only for zip
  builds:
    # The files must be in the directory DIR[WORKING,DATA]
    csit-vpp-perf-mrr-daily-master:
    -
      build: 1
      file: "{DIR[WORKING,DATA]}/output_mrr_1.xml"
    -
      build: 2
      file: "{DIR[WORKING,DATA]}/output_mrr_2.xml"
    -
      build: 3
      file: "{DIR[WORKING,DATA]}/output_mrr_3.xml"
    -
      build: 4
      file: "{DIR[WORKING,DATA]}/output_mrr_4.xml"
    -
      build: 5
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"
    -
      build: 6
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"
    -
      build: 7
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"
    -
      build: 8
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"
    -
      build: 9
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"
    -
      build: 10
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"
    -
      build: 11
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"
    -
      build: 12
      file: "{DIR[WORKING,DATA]}/output_mrr_5.xml"

-
  type: "static"
  src-path: "{DIR[RST]}"
  dst-path: "{DIR[WORKING,SRC]}"

-
  type: "input"  # Ignored in debug mode
  general:
    file-name: "output.xml.log.gz"
    file-format: ".gz"
    download-path: "{job}/{build}/archives/{filename}"
    extract: "output.xml"
#    file-name: "robot-plugin.zip"
#    file-format: ".zip"
#    download-path: "{job}/{build}/robot/report/*zip*/{filename}"
#    extract: "robot-plugin/output.xml"
  builds:
    csit-vpp-perf-mrr-daily-master:
      start: 9
      end: 14 #"lastSuccessfulBuild"  # take all from the 'start'
#    csit-vpp-perf-check-master:
#      start: 22
#      end: 22

-
  type: "output"
  output:
#   "report"
    "CPTA"  # Continuous Performance Trending and Analysis
  format:
    html:
    - full
    pdf:
    - minimal

################################################################################
###                                 C P T A                                  ###
################################################################################

# Plots VPP Continuous Performance Trending and Analysis
-
  type: "cpta"
  title: "Continuous Performance Trending and Analysis"
  algorithm: "cpta"
  output-file-type: ".html"
  output-file: "{DIR[STATIC,VPP]}/cpta"
  plots:

# L2

    - title: "VPP 1T1C L2 64B Packet Throughput - {period} Trending"
      output-file-name: "l2"
      data: "plot-performance-trending"
      filter: "'MRR' and '64B' and ('BASE' or 'SCALE') and '1T1C' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST' and not 'MEMIF'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

# IPv4

    - title: "VPP 1T1C IPv4 64B Packet Throughput - {period} Trending"
      output-file-name: "ip4"
      data: "plot-performance-trending"
      filter: "'MRR' and '64B' and ('BASE' or 'SCALE' or 'FEATURE') and '1T1C' and 'IP4FWD' and not 'IPSEC' and not 'VHOST'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

# IPv6

    - title: "VPP 1T1C IPv6 78B Packet Throughput - {period} Trending"
      output-file-name: "ip6"
      data: "plot-performance-trending"
      filter: "'MRR' and '78B' and ('BASE' or 'SCALE' or 'FEATURE') and '1T1C' and 'IP6FWD' and not 'IPSEC' and not 'VHOST'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

# Container memif

    - title: "VPP 1T1C L2 Container memif 64B Packet Throughput - {period} Trending"
      output-file-name: "container-memif-l2-1t1c-x520"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-X520-DA2' and 'MRR' and '64B' and 'BASE' and '1T1C' and 'MEMIF' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 2T2C L2 Container memif 64B Packet Throughput - {period} Trending"
      output-file-name: "container-memif-l2-2t2c-x520"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-X520-DA2' and 'MRR' and '64B' and 'BASE' and '2T2C' and 'MEMIF' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 1T1C L2 Container memif 64B Packet Throughput - {period} Trending"
      output-file-name: "container-memif-l2-1t1c-xl710"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-XL710' and 'MRR' and '64B' and 'BASE' and '1T1C' and 'MEMIF' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 2T2C L2 Container memif 64B Packet Throughput - {period} Trending"
      output-file-name: "container-memif-l2-2t2c-xl710"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-XL710' and 'MRR' and '64B' and 'BASE' and '2T2C' and 'MEMIF' and ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD') and not 'VHOST'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

# VM vhost

    - title: "VPP 1T1C VM vhost ethip4 64B Packet Throughput - {period} Trending"
      output-file-name: "vm-vhost-ethip4-1t1c-x520"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-X520-DA2' and '64B' and 'MRR' and '1T1C' and 'VHOST' and not ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD')"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 2T2C VM vhost ethip4 64B Packet Throughput - {period} Trending"
      output-file-name: "vm-vhost-ethip4-2t2c-x520"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-X520-DA2' and '64B' and 'MRR' and '2T2C' and 'VHOST' and not ('L2BDMACSTAT' or 'L2BDMACLRN' or 'L2XCFWD')"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 1T1C VM vhost eth 64B Packet Throughput - {period} Trending"
      output-file-name: "vm-vhost-eth-1t1c-x520"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-X520-DA2' and '64B' and 'MRR' and '1T1C' and 'VHOST' and not 'VXLAN' and not 'IP4FWD' and not 'DOT1Q' and not '2VM'"

      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 2T2C VM vhost eth 64B Packet Throughput - {period} Trending"
      output-file-name: "vm-vhost-eth-2t2c-x520"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-X520-DA2' and '64B' and 'MRR' and '2T2C' and 'VHOST' and not 'VXLAN' and not 'IP4FWD' and not 'DOT1Q' and not '2VM'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 1T1C VM vhost eth 64B Packet Throughput - {period} Trending"
      output-file-name: "vm-vhost-eth-1t1c-xl710"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-XL710' and '64B' and 'MRR' and '1T1C' and 'VHOST' and not 'VXLAN' and not 'IP4FWD' and not 'DOT1Q' and not '2VM'"

      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"

    - title: "VPP 2T2C VM vhost eth 64B Packet Throughput - {period} Trending"
      output-file-name: "vm-vhost-eth-2t2c-xl710"
      data: "plot-performance-trending"
      filter: "'NIC_Intel-XL710' and '64B' and 'MRR' and '2T2C' and 'VHOST' and not 'VXLAN' and not 'IP4FWD' and not 'DOT1Q' and not '2VM'"
      parameters:
      - "result"
      - "name"
      periods:
      - 1
      - 5
      - 30
      layout: "plot-cpta"