aboutsummaryrefslogtreecommitdiff
path: root/src/VARNISH-MIB.txt
blob: 47e39c841e42ecdf86eed75d3bc97e0d2cff7750 (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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
VARNISH-MIB DEFINITIONS ::= BEGIN

-- *************************************************************
-- $Id: VARNISH-MIB.txt 8 2014-11-24 14:38:24Z graygnuorg $
--
-- Varnish reverse proxy MIB
-- by Shared Autonomous sYstems
--
-- *************************************************************

IMPORTS
	MODULE-IDENTITY, OBJECT-TYPE, enterprises, Counter64, TimeTicks
		FROM SNMPv2-SMI
	DateAndTime
		FROM SNMPv2-TC
	OBJECT-GROUP, MODULE-COMPLIANCE
		FROM SNMPv2-CONF;

varnishMIB MODULE-IDENTITY
	LAST-UPDATED "201411260759Z"
	ORGANIZATION "Shared Autonomous sYstems"
	CONTACT-INFO "mhe@say.no"
	DESCRIPTION 
		"This MIB module defines objects for Varnish reverse web proxy."
	REVISION "201411260759Z"
	DESCRIPTION 
		"Initial version."
	::= { varnish 0 }

varnish OBJECT IDENTIFIER	::= { enterprises 33043 6 1 }
client  OBJECT IDENTIFIER	::= { varnish 1 }
backend OBJECT IDENTIFIER	::= { varnish 2 }
total   OBJECT IDENTIFIER	::= { varnish 3 }
master	OBJECT IDENTIFIER	::= { varnish 4 }
session	OBJECT IDENTIFIER	::= { varnish 5 }
threads	OBJECT IDENTIFIER	::= { varnish 6 }
bans	OBJECT IDENTIFIER	::= { varnish 7 }

clientAcceptedConnections OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Client connections accepted"
	::= { client 1 }

clientRequestsReceived OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Client requests received"
	::= { client 2 }

clientCacheHits OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Cache hits"
	::= { client 3 }

clientCacheHitsPass OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Cache hits for pass"
	::= { client 4 }

clientCacheMisses OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Cache misses"
	::= { client 5 }

VarnishBanString ::= TEXTUAL-CONVENTION
    DISPLAY-HINT "1024t"
    STATUS       current
    DESCRIPTION ""
    SYNTAX       OCTET STRING (SIZE (0..1024))
       	
clientBan OBJECT-TYPE
	SYNTAX	VarnishBanString
	MAX-ACCESS  read-write
	STATUS      current
	DESCRIPTION
		"When set, invalidates the cache using the supplied value as
		 argument to ban.  When read, returns an empty string."
	::= { client 6 }

clientRequests400 OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Client requests received, subject to 400 errors"
	::= { client 7 }

clientRequests411 OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Client requests received, subject to 411 errors"
	::= { client 8 }


clientRequests413 OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Client requests received, subject to 413 errors"
	::= { client 9 }

clientRequests417 OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Client requests received, subject to 417 errors"
	::= { client 10 }
	
connections OBJECT IDENTIFIER    ::= { backend 1 }

backendConnSuccess OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections success"
	::= { connections 1 }
 
backendConnNotAttempted OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections not attempted"
	::= { connections 2 }
 
backendConnToMany OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections too many"
	::= { connections 3 }
 
backendConnFailures OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections failures"
	::= { connections 4 }
 
backendConnReuses OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections reuses"
	::= { connections 5 }
 
backendConnRecycled OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections recycles"
	::= { connections 6 }
 
backendConnUnused OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections unused"
	::= { connections 7 }

backendConnRetry OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Backend connections retried"
	::= { connections 8 }
	
totalSessions OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total Sessions"
	::= { total 1 }
 
totalRequests OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total Requests"
	::= { total 2 }
 
totalPipe OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total pipe"
	::= { total 3 }
 
totalPass OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total pass"
	::= { total 4 }
 
totalFetch OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total fetch"
	::= { total 5 }
 
totalRequestHeaderBytes OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total request header bytes"
	::= { total 6 }
 
totalRequestBodyBytes OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total request body bytes"
	::= { total 7 }

totalResponseHeaderBytes OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total response body bytes"
	::= { total 8 }
	
totalResponseBodyBytes OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total response body bytes"
	::= { total 9 }

uptime OBJECT-TYPE
	SYNTAX	TimeTicks
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Master daemon uptime"
	::= { master 1 }	

sessAccepted OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of sessions succesfully accepted"
	::= { session 1 }

sessQueued OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of times session was queued waiting for a thread"
	::= { session 2 }

sessDropped OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of sessions dropped because session queue was full"
	::= { session 3 }

sessClosed OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of sessions closed"
	::= { session 4 }

sessPipeline OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Session pipeline"
	::= { session 5 }

sessReadAhead OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Session read-ahead"
	::= { session 6 }

sessHerd OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Session herd"
	::= { session 7 }	
		
sessDrop OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of sessions dropped for thread"
	::= { session 8 }	

sessFail OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of session accept failures"
	::= { session 9 }	

sessPipeOverflow OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of session pipe overflows"
	::= { session 10 }	

threadsPools OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of thread pools"
	::= { threads 1 }	

threadsTotal OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of thread pools"
	::= { threads 2 }	

threadsLimitHits OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of times more threads were needed, but limit was
		 reached in a thread pool"
	::= { threads 3 }	

threadsCreated OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total number of threads created in all pools"
	::= { threads 4 }	

threadsDestroyed OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total number of threads destroyed in all pools"
	::= { threads 5 }	

threadsFailed OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of times creating a thread failed"
	::= { threads 6 }	

threadsQueueLength OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Length of session queue waiting for threads"
	::= { threads 7 }
	
bansTotal OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Total number of bans"
	::= { bans 1 }

bansCompleted OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Count of completed bans"
	::= { bans 2 }

bansObj OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of bans using obj.*"
	::= { bans 3 }

bansReq OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of bans using req.*"
	::= { bans 4 }

bansAdded OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of bans added"
	::= { bans 5 }

bansDeleted OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of bans deleted"
	::= { bans 6 }

bansTested OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of bans tested against objects (lookup)"
	::= { bans 7 }

bansObjectsKilled OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of objects killed by bans (lookup)"
	::= { bans 8 }


bansLurkerTested OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of bans tested against objects (lurker)"
	::= { bans 9 }

bansTestTested OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of ban tests tested against objects (lookup)"
	::= { bans 10 }

bansLurkerTestTested OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of ban tests tested against objects (lurker)"
	::= { bans 11 }

bansLurkerObjKilled OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of objects killed by bans (lurker)"
	::= { bans 12 }

bansDups OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of ans superseded by other bans"
	::= { bans 13 }

bansLurkerContention OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of times lurker gave way for lookup"
	::= { bans 14 }

bansPersistedBytes OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of bytes used by the persisted ban lists"
	::= { bans 15 }

bansPersistedFragmentation OBJECT-TYPE
	SYNTAX  Counter64
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Extra bytes in persisted ban lists due to fragmentation"
	::= { bans 17 }

banTable OBJECT-TYPE
       SYNTAX     SEQUENCE OF VarnishBanEntry
       MAX-ACCESS not-accessible
       STATUS     current
       DESCRIPTION
             "The (conceptual) table listing available bans"
       ::= { bans 18 }

varnishBanEntry OBJECT-TYPE
       SYNTAX     VarnishBanEntry
       MAX-ACCESS not-accessible
       STATUS     current
       DESCRIPTION
             "An entry (conceptual row) representing a ban"
       INDEX      { banIndex }
       ::= { banTable 1 }

VarnishBanEntry ::= SEQUENCE {
       banIndex                           Integer32,
       banTime				  DateAndTime,
       banRefCount                        Counter64,
       banExpression			  VarnishBanString
}

banIndex OBJECT-TYPE
	SYNTAX  Integer32
	MAX-ACCESS not-accessible
	STATUS  current
	DESCRIPTION
		"A number uniquely identifying each ban"
	::= { varnishBanEntry 1 }

banTime OBJECT-TYPE
	SYNTAX  DateAndTime
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Time when the ban was created"
	::= { varnishBanEntry 2 }

banRefCount OBJECT-TYPE
	SYNTAX  Counter32
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"Number of references to this ban"
	::= { varnishBanEntry 3 }
	
banExpression OBJECT-TYPE
	SYNTAX  VarnishBanString
	MAX-ACCESS read-only
	STATUS  current
	DESCRIPTION
		"VCL expression of the ban"
	::= { varnishBanEntry 4 }
	
--
-- Groups and Compliance
--
varnishConfs  OBJECT IDENTIFIER	::= { varnish 100 }
varnishGroups OBJECT IDENTIFIER	::= { varnishConfs 1 }
varnishCompl  OBJECT IDENTIFIER ::= { varnishConfs 2 }

--
-- Groups
--
varnishGroup OBJECT-GROUP
	OBJECTS {
                clientAcceptedConnections,
		clientRequestsReceived,
		clientCacheHits,
		clientCacheHitsPass,
		clientCacheMisses,
		clientBan,
		backendConnSuccess,
		backendConnNotAttempted,
		backendConnToMany,
		backendConnFailures,
		backendConnReuses,
		backendConnRecycled,
		backendConnUnused,
		totalSessions,
		totalRequests,
		totalPipe,
		totalPass,
		totalFetch,
		clientRequests400,
		clientRequests411,
		clientRequests413,
		clientRequests417,
		backendConnRetry,
		totalRequestHeaderBytes,
		totalRequestBodyBytes,
		totalResponseHeaderBytes,
		totalResponseBodyBytes,
		uptime,
		sessAccepted,
		sessQueued,
		sessDropped, 
		sessClosed,
		sessPipeline,
		sessReadAhead,
		sessHerd,
		sessDrop,
		sessFail,
		sessPipeOverflow,
		threadsPools,
		threadsTotal,
		threadsLimitHits,
		threadsCreated,
		threadsDestroyed,
		threadsFailed,
		threadsQueueLength,
	        banTable,
		varnishBanEntry,
		banIndex,
		banTime,
		banRefCount,
		banExpression
		}

	STATUS  current
	DESCRIPTION "Group of Varnish objects"
	::= { varnishGroups 1 }

--
-- Compliance
--
varnishStandardComplianceV1 MODULE-COMPLIANCE
	STATUS  current
	DESCRIPTION
		"Compliance for an Varnish agent"

	MODULE 
	MANDATORY-GROUPS { varnishGroup }

	::= { varnishCompl 1 }

END

-- Local variables:
-- eval: (add-hook 'write-file-hooks 'time-stamp)
-- time-stamp-start: "\\(LAST-UPDATED\\|REVISION\\)  *\""
-- time-stamp-end: "\""
-- time-stamp-format: "%:y%02m%02d%02H%02MZ"
-- time-stamp-line-limit: 25
-- time-stamp-count: 2
-- end:

Return to:

Send suggestions and report system problems to the System administrator.