aboutsummaryrefslogtreecommitdiffstats
path: root/resources/templates/telemetry/vppctl_runtime.yaml
blob: d8ff734e84774eb7a446f6b1da2d22839c1ee38f (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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
---
logging:
  version: 1
  formatters:
    console_stdout:
      format: '%(asctime)s - %(name)s - %(message)s'
    console_stderr:
      format: '%(message)s'
    prom:
      format: '%(message)s'
  handlers:
    console_stdout:
      class: logging.StreamHandler
      level: INFO
      formatter: console_stdout
      stream: ext://sys.stdout
    console_stderr:
      class: logging.StreamHandler
      level: ERROR
      formatter: console_stderr
      stream: ext://sys.stderr
    prom:
      class: logging.handlers.RotatingFileHandler
      level: INFO
      formatter: prom
      filename: /tmp/metric.prom
      mode: w
  loggers:
    prom:
      handlers: [prom]
      level: INFO
      propagate: False
  root:
    level: INFO
    handlers: [console_stdout, console_stderr]
scheduler:
  duration: 1
programs:
  - name: bundle_vppctl
    metrics:
      info:
        - name: version
          documentation: VPP version
          namespace: vpp
          subsystem: version
          labelnames:
            - version
    code: |
      vppctl -s {socket} show version
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: calls
          documentation: Number of calls total
          namespace: vpp
          subsystem: runtime
          labelnames:
            - name
            - state
            - thread_name
            - thread_id
            - thread_lcore
        - name: vectors
          documentation: Number of vectors total
          namespace: vpp
          subsystem: runtime
          labelnames:
            - name
            - state
            - thread_name
            - thread_id
            - thread_lcore
        - name: suspends
          documentation: Number of suspends total
          namespace: vpp
          subsystem: runtime
          labelnames:
            - name
            - state
            - thread_name
            - thread_id
            - thread_lcore
        - name: clocks
          documentation: Number of clocks total
          namespace: vpp
          subsystem: runtime
          labelnames:
            - name
            - state
            - thread_name
            - thread_id
            - thread_lcore
        - name: vectors_calls
          documentation: Number of vectors per call
          namespace: vpp
          subsystem: runtime
          labelnames:
            - name
            - state
            - thread_name
            - thread_id
            - thread_lcore
    code: |
      vppctl -s {socket} clear runtime
      sleep {duration}
      vppctl -s {socket} show runtime
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: rx_packets
          documentation: Number of received packets for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: rx_bytes
          documentation: Number of received bytes for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: rx_error
          documentation: Number of errors on interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: tx_packets
          documentation: Number of transitted packets for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: tx_bytes
          documentation: Number of transitted bytes for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: tx_error
          documentation: Number of errors on interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: drops
          documentation: Number of dropped packets for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: punt
          documentation: Number of punted packets for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: ip4
          documentation: Number of IPv4 packets for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: ip6
          documentation: Number of IPv6 packets for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: mpls
          documentation: Number of MPLS packets for interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: rx_no_buf
          documentation: Number of out of buffer RX packets on interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
        - name: rx_miss
          documentation: Number of missed RX packets on interface
          namespace: vpp
          subsystem: interface
          labelnames:
            - name
            - index
    code: |
      vppctl -s {socket} clear interfaces
      sleep {duration}
      vppctl -s {socket} show interface
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: node_counter
          documentation: Node counter
          namespace: vpp
          subsystem: counters
          labelnames:
            - name
            - reason
            - severity
            - thread_name
            - thread_id
    code: |
      vppctl -s {socket} clear node counters
      sleep {duration}
      vppctl -s {socket} show node counters verbose
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: context_switches
          documentation: Per-thread context switches
          namespace: vpp
          subsystem: context_switches
          labelnames:
            - name
            - id
    code: |
      vppctl -s {socket} perfmon reset
      vppctl -s {socket} perfmon start bundle context-switches
      sleep {duration}
      vppctl -s {socket} perfmon stop
      vppctl -s {socket} show perfmon statistics
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: minor_page_faults
          documentation: Per-thread page faults (minor)
          namespace: vpp
          subsystem: page_faults
          labelnames:
            - name
            - id
        - name: major_page_faults
          documentation: Per-thread page faults (major)
          namespace: vpp
          subsystem: page_faults
          labelnames:
            - name
            - id
    code: |
      vppctl -s {socket} perfmon reset
      vppctl -s {socket} perfmon start bundle page-faults
      sleep {duration}
      vppctl -s {socket} perfmon stop
      vppctl -s {socket} show perfmon statistics
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: calls
          documentation: Instructions/packet, cycles/packet and IPC (calls)
          namespace: vpp
          subsystem: inst_and_clock
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: packets
          documentation: Instructions/packet, cycles/packet and IPC (packets)
          namespace: vpp
          subsystem: inst_and_clock
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: packets_per_call
          documentation: Instructions/packet, cycles/packet and IPC (packets/call)
          namespace: vpp
          subsystem: inst_and_clock
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: clocks_per_packets
          documentation: Instructions/packet, cycles/packet and IPC (clocks/packets)
          namespace: vpp
          subsystem: inst_and_clock
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: instructions_per_packets
          documentation: Instructions/packet, cycles/packet and IPC (clocks/packets)
          namespace: vpp
          subsystem: inst_and_clock
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: ipc
          documentation: Instructions/packet, cycles/packet and IPC (clocks/packets)
          namespace: vpp
          subsystem: inst_and_clock
          labelnames:
            - name
            - thread_name
            - thread_id
    code: |
      vppctl -s {socket} perfmon reset
      vppctl -s {socket} perfmon start bundle inst-and-clock
      sleep {duration}
      vppctl -s {socket} perfmon stop
      vppctl -s {socket} show perfmon statistics
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: l1_hit
          documentation:  Cache hits and misses (L1 hit)
          namespace: vpp
          subsystem: cache_hierarchy
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: l1_miss
          documentation:  Cache hits and misses (L1 miss)
          namespace: vpp
          subsystem: cache_hierarchy
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: l2_hit
          documentation:  Cache hits and misses (L2 hit)
          namespace: vpp
          subsystem: cache_hierarchy
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: l2_miss
          documentation:  Cache hits and misses (L2 miss)
          namespace: vpp
          subsystem: cache_hierarchy
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: l3_hit
          documentation:  Cache hits and misses (L3 hit)
          namespace: vpp
          subsystem: cache_hierarchy
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: l3_miss
          documentation:  Cache hits and misses (L3 miss)
          namespace: vpp
          subsystem: cache_hierarchy
          labelnames:
            - name
            - thread_name
            - thread_id
    code: |
      vppctl -s {socket} perfmon reset
      vppctl -s {socket} perfmon start bundle cache-hierarchy
      sleep {duration}
      vppctl -s {socket} perfmon stop
      vppctl -s {socket} show perfmon statistics
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: calls
          documentation: Load operations (calls)
          namespace: vpp
          subsystem: load_blocks
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: packets
          documentation: Load operations (packets)
          namespace: vpp
          subsystem: load_blocks
          labelnames:
            - name
            - thread_name
            - thread_id
    code: |
      vppctl -s {socket} perfmon reset
      vppctl -s {socket} perfmon start bundle load-blocks
      sleep {duration}
      vppctl -s {socket} perfmon stop
      vppctl -s {socket} show perfmon statistics
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: branches_per_call
          documentation: Branches/call
          namespace: vpp
          subsystem: branch_mispred
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: branches_per_packet
          documentation: Branches/packet
          namespace: vpp
          subsystem: branch_mispred
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: taken_per_call
          documentation: Taken/call
          namespace: vpp
          subsystem: branch_mispred
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: taken_per_packet
          documentation: Taken/packet
          namespace: vpp
          subsystem: branch_mispred
          labelnames:
            - name
            - thread_name
            - thread_id
        - name: mis_predictions
          documentation: Mis-predictions
          namespace: vpp
          subsystem: branch_mispred
          labelnames:
            - name
            - thread_name
            - thread_id
    code: |
      vppctl -s {socket} perfmon reset
      vppctl -s {socket} perfmon start bundle branch-mispred
      sleep {duration}
      vppctl -s {socket} perfmon stop
      vppctl -s {socket} show perfmon statistics
  - name: bundle_vppctl
    metrics:
      gauge:
        - name: runtime
          documentation: RunTime
          namespace: vpp
          subsystem: memory_bandwidth
          labelnames:
            - name
        - name: reads_mbs
          documentation: Reads (MB/s)
          namespace: vpp
          subsystem: memory_bandwidth
          labelnames:
            - name
        - name: writes_mbs
          documentation: Writes (MB/s)
          namespace: vpp
          subsystem: memory_bandwidth
          labelnames:
            - name
        - name: total_mbs
          documentation: Total (MB/s)
          namespace: vpp
          subsystem: memory_bandwidth
          labelnames:
            - name
    code: |
      vppctl -s {socket} perfmon reset
      vppctl -s {socket} perfmon start bundle memory-bandwidth
      sleep {duration}
      vppctl -s {socket} perfmon stop
      vppctl -s {socket} show perfmon statistics