/
prometheus.go
1345 lines (1142 loc) · 45.4 KB
/
prometheus.go
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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package loggers
import (
"crypto/tls"
"crypto/x509"
"fmt"
"net"
"net/http"
"os"
"regexp"
"strconv"
"strings"
"sync"
"time"
"github.com/dmachard/go-dnscollector/dnsutils"
"github.com/dmachard/go-dnscollector/netlib"
"github.com/dmachard/go-dnscollector/pkgconfig"
"github.com/dmachard/go-dnscollector/pkgutils"
"github.com/dmachard/go-dnscollector/transformers"
"github.com/dmachard/go-logger"
"github.com/dmachard/go-topmap"
"github.com/hashicorp/golang-lru/v2/expirable"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/collectors"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/common/version"
// _ "net/http/pprof"
)
var metricNameRegex = regexp.MustCompile(`_*[^0-9A-Za-z_]+_*`)
/*
This is the list of available label values selectors.
Configuration may specify a list of lables to use for metrics.
Any label in this catalogueSelectors can be specidied in config (prometheus-labels stanza)
*/
var catalogueSelectors map[string]func(*dnsutils.DNSMessage) string = map[string]func(*dnsutils.DNSMessage) string{
"stream_id": GetStreamID,
"resolver": GetResolverIP,
"stream_global": GetStreamGlobal,
}
/*
OpenMetrics and the Prometheus exposition format require the metric name
to consist only of alphanumericals and "_", ":" and they must not start
with digits.
*/
func SanitizeMetricName(metricName string) string {
return metricNameRegex.ReplaceAllString(metricName, "_")
}
/*
EpsCounters (Events Per Second) - is a set of metrics we calculate on per-second basis.
For others we rely on averaging by collector
*/
type EpsCounters struct {
Eps, EpsMax uint64
TotalEvents, TotalEventsPrev uint64
TotalRcodes, TotalQtypes map[string]float64
TotalIPVersion, TotalIPProtocol map[string]float64
TotalDNSMessages float64
TotalQueries, TotalReplies int
TotalBytes, TotalBytesSent, TotalBytesReceived int
TotalTC, TotalAA, TotalRA, TotalAD float64
TotalMalformed, TotalFragmented, TotalReasembled float64
}
type PrometheusCountersCatalogue interface {
// Prometheus logger encapsulates stats counters (PrometheusCounterSet) inside
// PromCounterCatalogueContainer's. For each label the logger creates a nested level
// of containers.
// Containers and CounterSets must implemnent PrometheusCountersCatalogue interface
// to allow fetching a CounterSet by the list of metric/values by fetching values from
// the DNS message it logs.
// There is a schematic sample layout when there are 2 labels considered at the end of this file
GetCountersSet(*dnsutils.DNSMessage) PrometheusCountersCatalogue
}
// This type represents a set of counters for a unique set of label name=value pairs.
// By default, we create a set per setream_id for backward compatibility
// However, we can allow slicing and dicing data using more dimensions.
// Each CounterSet is registered with Prometheus collection independently (wrapping label values)
type PrometheusCountersSet struct {
prom *Prometheus
// LRU cache counters per domains and IP
requesters *expirable.LRU[string, int] // Requests number made by a specific requestor
allDomains *expirable.LRU[string, int] // Requests number made to find out about a specific domain
validDomains *expirable.LRU[string, int] // Requests number ended up in NOERROR
nxDomains *expirable.LRU[string, int] // Requests number ended up in NXDOMAIN
sfDomains *expirable.LRU[string, int] // Requests number ended up in SERVFAIL
tlds *expirable.LRU[string, int] // Requests number for a specific TLD
etldplusone *expirable.LRU[string, int] // Requests number for a specific eTLD+1
suspicious *expirable.LRU[string, int] // Requests number for a specific name that looked suspicious
evicted *expirable.LRU[string, int] // Requests number for a specific name that timed out
epsCounters EpsCounters
topRequesters *topmap.TopMap
topAllDomains *topmap.TopMap
topEvicted *topmap.TopMap
topValidDomains *topmap.TopMap
topSfDomains *topmap.TopMap
topNxDomains *topmap.TopMap
topTlds *topmap.TopMap
topETLDPlusOne *topmap.TopMap
topSuspicious *topmap.TopMap
labels prometheus.Labels // Do we really need to keep that map outside of registration?
sync.Mutex // Each PrometheusCountersSet locks independently
}
// PromCounterCatalogueContainer is the implementation of PrometheusCountersCatalogue interface
// That maps a single label into other Containers or CounterSet
// The 'chain' of nested Containers keep track of labelNames requested by the config
// to figure out whether nested Container should be created, or, if all labels but the last one
// already considered at the upper levels, it is time to create individual CounterSet
type PromCounterCatalogueContainer struct {
prom *Prometheus
// labelNames - is a list of label *names* for PromCounterCatalogueContainer's in stats
// map to use to get proper selectors.
// The topmost instance of PromCounterCatalogueContainer has the full list of all names to
// consider (the one provided by the config). Whenver it needs to create a new item in
// it's stats map, it suplies labelNames[1:] to the constructor for the lower level
// container to get the selector for the next level
labelNames []string // This is list of label names for nested containers
// This is the unique set of label-value pairs for this catalogue element.
// The topmost Catalog has it empty, when it creates a new entry it provides the pair of
// labelNames[0]->selector(message) to the constructor. Lower levels get these pair
// collected. Ultimately, when all label names in labelNames is exausted, Catalogue creates
// an instance of newPrometheusCounterSet and provides it with labels map to properly wrap
// in Prometheus registry.
// The goal is to separate label/values pairs construction and individual counters collection
labels map[string]string // This is the set of label=value pairs we collected to this level
stats map[string]PrometheusCountersCatalogue
// selector is a function that obtains a value for a label considering DNS Message data
// in most cases - just a field of that message
selector func(*dnsutils.DNSMessage) string
sync.RWMutex
}
/*
Selectors
*/
func GetStreamGlobal(dm *dnsutils.DNSMessage) string {
return "enabled"
}
func GetStreamID(dm *dnsutils.DNSMessage) string {
return dm.DNSTap.Identity
}
func GetResolverIP(dm *dnsutils.DNSMessage) string {
return dm.NetworkInfo.ResponseIP
}
type Prometheus struct {
doneAPI chan bool
stopProcess, doneProcess chan bool
stopRun, doneRun chan bool
httpServer *http.Server
netListener net.Listener
inputChan, outputChan chan dnsutils.DNSMessage
config *pkgconfig.Config
configChan chan *pkgconfig.Config
logger *logger.Logger
promRegistry *prometheus.Registry
sync.Mutex
catalogueLabels []string
counters *PromCounterCatalogueContainer
// All metrics use these descriptions when regestering
gaugeTopDomains *prometheus.Desc
gaugeTopNoerrDomains *prometheus.Desc
gaugeTopNxDomains *prometheus.Desc
gaugeTopSfDomains *prometheus.Desc
gaugeTopRequesters *prometheus.Desc
gaugeTopTlds *prometheus.Desc
gaugeTopETldsPlusOne *prometheus.Desc
gaugeTopSuspicious *prometheus.Desc
gaugeTopEvicted *prometheus.Desc
gaugeDomainsAll *prometheus.Desc
gaugeDomainsValid *prometheus.Desc
gaugeDomainsNx *prometheus.Desc
gaugeDomainsSf *prometheus.Desc
gaugeRequesters *prometheus.Desc
gaugeTlds *prometheus.Desc
gaugeETldPlusOne *prometheus.Desc
gaugeSuspicious *prometheus.Desc
gaugeEvicted *prometheus.Desc
gaugeEps *prometheus.Desc
gaugeEpsMax *prometheus.Desc
counterQtypes *prometheus.Desc
counterRcodes *prometheus.Desc
counterIPProtocol *prometheus.Desc
counterIPVersion *prometheus.Desc
counterDNSMessages *prometheus.Desc
counterDNSQueries *prometheus.Desc
counterDNSReplies *prometheus.Desc
counterFlagsTC *prometheus.Desc
counterFlagsAA *prometheus.Desc
counterFlagsRA *prometheus.Desc
counterFlagsAD *prometheus.Desc
counterFlagsMalformed *prometheus.Desc
counterFlagsFragmented *prometheus.Desc
counterFlagsReassembled *prometheus.Desc
totalBytes *prometheus.Desc
totalReceivedBytes *prometheus.Desc
totalSentBytes *prometheus.Desc
// Histograms are heavy and expensive, turned off
// by default in configuration
histogramQueriesLength *prometheus.HistogramVec
histogramRepliesLength *prometheus.HistogramVec
histogramQnamesLength *prometheus.HistogramVec
histogramLatencies *prometheus.HistogramVec
name string
RoutingHandler pkgutils.RoutingHandler
}
func newPrometheusCounterSet(p *Prometheus, labels prometheus.Labels) *PrometheusCountersSet {
pcs := &PrometheusCountersSet{
prom: p,
labels: labels,
requesters: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.RequestersCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.RequestersCacheTTL)),
allDomains: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.DomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.DomainsCacheTTL)),
validDomains: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.NoErrorDomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.NoErrorDomainsCacheTTL)),
nxDomains: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.NXDomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.NXDomainsCacheTTL)),
sfDomains: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.ServfailDomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.ServfailDomainsCacheTTL)),
tlds: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.DefaultDomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.DefaultDomainsCacheTTL)),
etldplusone: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.DefaultDomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.DefaultDomainsCacheTTL)),
suspicious: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.DefaultDomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.DefaultDomainsCacheTTL)),
evicted: expirable.NewLRU[string, int](p.config.Loggers.Prometheus.DefaultDomainsCacheSize, nil, time.Second*time.Duration(p.config.Loggers.Prometheus.DefaultDomainsCacheTTL)),
epsCounters: EpsCounters{
TotalRcodes: make(map[string]float64),
TotalQtypes: make(map[string]float64),
TotalIPVersion: make(map[string]float64),
TotalIPProtocol: make(map[string]float64),
},
topRequesters: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topEvicted: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topAllDomains: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topValidDomains: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topSfDomains: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topNxDomains: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topTlds: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topETLDPlusOne: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
topSuspicious: topmap.NewTopMap(p.config.Loggers.Prometheus.TopN),
}
prometheus.WrapRegistererWith(labels, p.promRegistry).MustRegister(pcs)
return pcs
}
func (c *PrometheusCountersSet) GetCountersSet(dm *dnsutils.DNSMessage) PrometheusCountersCatalogue {
return c
}
// each CounterSet has the same list of timeseries descriptors,
// so it uses descriptros from the Prometheus instance the set belongs to.
func (c *PrometheusCountersSet) Describe(ch chan<- *prometheus.Desc) {
// Gauge metrcis
c.Lock()
defer c.Unlock()
ch <- c.prom.gaugeTopDomains
ch <- c.prom.gaugeTopNoerrDomains
ch <- c.prom.gaugeTopNxDomains
ch <- c.prom.gaugeTopSfDomains
ch <- c.prom.gaugeTopRequesters
ch <- c.prom.gaugeTopTlds
ch <- c.prom.gaugeTopETldsPlusOne
ch <- c.prom.gaugeTopSuspicious
ch <- c.prom.gaugeTopEvicted
// Counter metrics
ch <- c.prom.gaugeDomainsAll
ch <- c.prom.gaugeDomainsValid
ch <- c.prom.gaugeDomainsNx
ch <- c.prom.gaugeDomainsSf
ch <- c.prom.gaugeRequesters
ch <- c.prom.gaugeTlds
ch <- c.prom.gaugeETldPlusOne
ch <- c.prom.gaugeSuspicious
ch <- c.prom.gaugeEvicted
ch <- c.prom.gaugeEps
ch <- c.prom.gaugeEpsMax
ch <- c.prom.counterQtypes
ch <- c.prom.counterRcodes
ch <- c.prom.counterIPProtocol
ch <- c.prom.counterIPVersion
ch <- c.prom.counterDNSMessages
ch <- c.prom.counterDNSQueries
ch <- c.prom.counterDNSReplies
ch <- c.prom.counterFlagsTC
ch <- c.prom.counterFlagsAA
ch <- c.prom.counterFlagsRA
ch <- c.prom.counterFlagsAD
ch <- c.prom.counterFlagsMalformed
ch <- c.prom.counterFlagsFragmented
ch <- c.prom.counterFlagsReassembled
ch <- c.prom.totalBytes
ch <- c.prom.totalReceivedBytes
ch <- c.prom.totalSentBytes
}
// Updates all counters for a specific set of labelName=labelValue
func (c *PrometheusCountersSet) Record(dm dnsutils.DNSMessage) {
c.Lock()
defer c.Unlock()
// count all uniq requesters if enabled
if c.prom.config.Loggers.Prometheus.RequestersMetricsEnabled {
count, _ := c.requesters.Get(dm.NetworkInfo.QueryIP)
c.requesters.Add(dm.NetworkInfo.QueryIP, count+1)
c.topRequesters.Record(dm.NetworkInfo.QueryIP, count+1)
}
// count all uniq domains if enabled
if c.prom.config.Loggers.Prometheus.DomainsMetricsEnabled {
count, _ := c.allDomains.Get(dm.DNS.Qname)
c.allDomains.Add(dm.DNS.Qname, count+1)
c.topAllDomains.Record(dm.DNS.Qname, count+1)
}
// top domains
switch {
case dm.DNS.Rcode == dnsutils.DNSRcodeTimeout && c.prom.config.Loggers.Prometheus.TimeoutMetricsEnabled:
count, _ := c.evicted.Get(dm.DNS.Qname)
c.evicted.Add(dm.DNS.Qname, count+1)
c.topEvicted.Record(dm.DNS.Qname, count+1)
case dm.DNS.Rcode == dnsutils.DNSRcodeServFail && c.prom.config.Loggers.Prometheus.ServfailMetricsEnabled:
count, _ := c.sfDomains.Get(dm.DNS.Qname)
c.sfDomains.Add(dm.DNS.Qname, count+1)
c.topSfDomains.Record(dm.DNS.Qname, count+1)
case dm.DNS.Rcode == dnsutils.DNSRcodeNXDomain && c.prom.config.Loggers.Prometheus.NonExistentMetricsEnabled:
count, _ := c.nxDomains.Get(dm.DNS.Qname)
c.nxDomains.Add(dm.DNS.Qname, count+1)
c.topNxDomains.Record(dm.DNS.Qname, count+1)
case dm.DNS.Rcode == dnsutils.DNSRcodeNoError && c.prom.config.Loggers.Prometheus.NoErrorMetricsEnabled:
count, _ := c.validDomains.Get(dm.DNS.Qname)
c.validDomains.Add(dm.DNS.Qname, count+1)
c.topValidDomains.Record(dm.DNS.Qname, count+1)
}
// count and top tld
if dm.PublicSuffix != nil && dm.PublicSuffix.QnamePublicSuffix != "-" {
count, _ := c.tlds.Get(dm.PublicSuffix.QnamePublicSuffix)
c.tlds.Add(dm.PublicSuffix.QnamePublicSuffix, count+1)
c.topTlds.Record(dm.PublicSuffix.QnamePublicSuffix, count+1)
}
// count TLD+1 if it is set
if dm.PublicSuffix != nil && dm.PublicSuffix.QnameEffectiveTLDPlusOne != "-" {
count, _ := c.etldplusone.Get(dm.PublicSuffix.QnameEffectiveTLDPlusOne)
c.etldplusone.Add(dm.PublicSuffix.QnameEffectiveTLDPlusOne, count+1)
c.topETLDPlusOne.Record(dm.PublicSuffix.QnameEffectiveTLDPlusOne, count+1)
}
// suspicious domains
if dm.Suspicious != nil && dm.Suspicious.Score > 0.0 {
count, _ := c.suspicious.Get(dm.DNS.Qname)
c.suspicious.Add(dm.DNS.Qname, count+1)
c.topSuspicious.Record(dm.DNS.Qname, count+1)
}
// compute histograms, no more enabled by default to avoid to hurt performance.
if c.prom.config.Loggers.Prometheus.HistogramMetricsEnabled {
c.prom.histogramQnamesLength.With(c.labels).Observe(float64(len(dm.DNS.Qname)))
if dm.DNSTap.Latency > 0.0 {
c.prom.histogramLatencies.With(c.labels).Observe(dm.DNSTap.Latency)
}
if dm.DNS.Type == dnsutils.DNSQuery {
c.prom.histogramQueriesLength.With(c.labels).Observe(float64(dm.DNS.Length))
} else {
c.prom.histogramRepliesLength.With(c.labels).Observe(float64(dm.DNS.Length))
}
}
// Record EPS related data
c.epsCounters.TotalEvents++
c.epsCounters.TotalBytes += dm.DNS.Length
c.epsCounters.TotalDNSMessages++
if _, exists := c.epsCounters.TotalIPVersion[dm.NetworkInfo.Family]; !exists {
c.epsCounters.TotalIPVersion[dm.NetworkInfo.Family] = 1
} else {
c.epsCounters.TotalIPVersion[dm.NetworkInfo.Family]++
}
if _, exists := c.epsCounters.TotalIPProtocol[dm.NetworkInfo.Protocol]; !exists {
c.epsCounters.TotalIPProtocol[dm.NetworkInfo.Protocol] = 1
} else {
c.epsCounters.TotalIPProtocol[dm.NetworkInfo.Protocol]++
}
if _, exists := c.epsCounters.TotalQtypes[dm.DNS.Qtype]; !exists {
c.epsCounters.TotalQtypes[dm.DNS.Qtype] = 1
} else {
c.epsCounters.TotalQtypes[dm.DNS.Qtype]++
}
if _, exists := c.epsCounters.TotalRcodes[dm.DNS.Rcode]; !exists {
c.epsCounters.TotalRcodes[dm.DNS.Rcode] = 1
} else {
c.epsCounters.TotalRcodes[dm.DNS.Rcode]++
}
if dm.DNS.Type == dnsutils.DNSQuery {
c.epsCounters.TotalBytesReceived += dm.DNS.Length
c.epsCounters.TotalQueries++
}
if dm.DNS.Type == dnsutils.DNSReply {
c.epsCounters.TotalBytesSent += dm.DNS.Length
c.epsCounters.TotalReplies++
}
// flags
if dm.DNS.Flags.TC {
c.epsCounters.TotalTC++
}
if dm.DNS.Flags.AA {
c.epsCounters.TotalAA++
}
if dm.DNS.Flags.RA {
c.epsCounters.TotalRA++
}
if dm.DNS.Flags.AD {
c.epsCounters.TotalAD++
}
if dm.DNS.MalformedPacket {
c.epsCounters.TotalMalformed++
}
if dm.NetworkInfo.IPDefragmented {
c.epsCounters.TotalFragmented++
}
if dm.NetworkInfo.TCPReassembled {
c.epsCounters.TotalReasembled++
}
}
func (c *PrometheusCountersSet) Collect(ch chan<- prometheus.Metric) {
c.Lock()
defer c.Unlock()
// Update number of all domains
ch <- prometheus.MustNewConstMetric(c.prom.gaugeDomainsAll, prometheus.GaugeValue,
float64(c.allDomains.Len()),
)
// Update number of valid domains (noerror)
ch <- prometheus.MustNewConstMetric(c.prom.gaugeDomainsValid, prometheus.GaugeValue,
float64(c.validDomains.Len()),
)
// Count NX domains
ch <- prometheus.MustNewConstMetric(c.prom.gaugeDomainsNx, prometheus.GaugeValue,
float64(c.nxDomains.Len()),
)
// Count SERVFAIL domains
ch <- prometheus.MustNewConstMetric(c.prom.gaugeDomainsSf, prometheus.GaugeValue,
float64(c.sfDomains.Len()),
)
// Requesters counter
ch <- prometheus.MustNewConstMetric(c.prom.gaugeRequesters, prometheus.GaugeValue,
float64(c.requesters.Len()),
)
// Count number of unique TLDs
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTlds, prometheus.GaugeValue,
float64(c.tlds.Len()),
)
ch <- prometheus.MustNewConstMetric(c.prom.gaugeETldPlusOne, prometheus.GaugeValue,
float64(c.etldplusone.Len()),
)
// Count number of unique suspicious names
ch <- prometheus.MustNewConstMetric(c.prom.gaugeSuspicious, prometheus.GaugeValue,
float64(c.suspicious.Len()),
)
// Count number of unique unanswered (timedout) names
ch <- prometheus.MustNewConstMetric(c.prom.gaugeEvicted, prometheus.GaugeValue,
float64(c.evicted.Len()),
)
// Count for all top domains
for _, r := range c.topAllDomains.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopDomains, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topValidDomains.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopNoerrDomains, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topNxDomains.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopNxDomains, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topSfDomains.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopSfDomains, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topRequesters.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopRequesters, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topTlds.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopTlds, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topETLDPlusOne.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopETldsPlusOne, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topSuspicious.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopSuspicious, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
for _, r := range c.topEvicted.Get() {
ch <- prometheus.MustNewConstMetric(c.prom.gaugeTopEvicted, prometheus.GaugeValue,
float64(r.Hit), strings.ToValidUTF8(r.Name, "�"))
}
ch <- prometheus.MustNewConstMetric(c.prom.gaugeEps, prometheus.GaugeValue,
float64(c.epsCounters.Eps),
)
ch <- prometheus.MustNewConstMetric(c.prom.gaugeEpsMax, prometheus.GaugeValue,
float64(c.epsCounters.EpsMax),
)
// Update qtypes counter
for k, v := range c.epsCounters.TotalQtypes {
ch <- prometheus.MustNewConstMetric(c.prom.counterQtypes, prometheus.CounterValue,
v, k,
)
}
// Update Return Codes counter
for k, v := range c.epsCounters.TotalRcodes {
ch <- prometheus.MustNewConstMetric(c.prom.counterRcodes, prometheus.CounterValue,
v, k,
)
}
// Update IP protocol counter
for k, v := range c.epsCounters.TotalIPProtocol {
ch <- prometheus.MustNewConstMetric(c.prom.counterIPProtocol, prometheus.CounterValue,
v, k,
)
}
// Update IP version counter
for k, v := range c.epsCounters.TotalIPVersion {
ch <- prometheus.MustNewConstMetric(c.prom.counterIPVersion, prometheus.CounterValue,
v, k,
)
}
// Update global number of dns messages
ch <- prometheus.MustNewConstMetric(c.prom.counterDNSMessages, prometheus.CounterValue,
c.epsCounters.TotalDNSMessages)
// Update number of dns queries
ch <- prometheus.MustNewConstMetric(c.prom.counterDNSQueries, prometheus.CounterValue,
float64(c.epsCounters.TotalQueries))
// Update number of dns replies
ch <- prometheus.MustNewConstMetric(c.prom.counterDNSReplies, prometheus.CounterValue,
float64(c.epsCounters.TotalReplies))
// Update flags
ch <- prometheus.MustNewConstMetric(c.prom.counterFlagsTC, prometheus.CounterValue,
c.epsCounters.TotalTC)
ch <- prometheus.MustNewConstMetric(c.prom.counterFlagsAA, prometheus.CounterValue,
c.epsCounters.TotalAA)
ch <- prometheus.MustNewConstMetric(c.prom.counterFlagsRA, prometheus.CounterValue,
c.epsCounters.TotalRA)
ch <- prometheus.MustNewConstMetric(c.prom.counterFlagsAD, prometheus.CounterValue,
c.epsCounters.TotalAD)
ch <- prometheus.MustNewConstMetric(c.prom.counterFlagsMalformed, prometheus.CounterValue,
c.epsCounters.TotalMalformed)
ch <- prometheus.MustNewConstMetric(c.prom.counterFlagsFragmented, prometheus.CounterValue,
c.epsCounters.TotalFragmented)
ch <- prometheus.MustNewConstMetric(c.prom.counterFlagsReassembled, prometheus.CounterValue,
c.epsCounters.TotalReasembled)
ch <- prometheus.MustNewConstMetric(c.prom.totalBytes,
prometheus.CounterValue, float64(c.epsCounters.TotalBytes),
)
ch <- prometheus.MustNewConstMetric(c.prom.totalReceivedBytes, prometheus.CounterValue,
float64(c.epsCounters.TotalBytesReceived),
)
ch <- prometheus.MustNewConstMetric(c.prom.totalSentBytes, prometheus.CounterValue,
float64(c.epsCounters.TotalBytesSent))
}
func (c *PrometheusCountersSet) ComputeEventsPerSecond() {
c.Lock()
defer c.Unlock()
if c.epsCounters.TotalEvents > 0 && c.epsCounters.TotalEventsPrev > 0 {
c.epsCounters.Eps = c.epsCounters.TotalEvents - c.epsCounters.TotalEventsPrev
}
c.epsCounters.TotalEventsPrev = c.epsCounters.TotalEvents
if c.epsCounters.Eps > c.epsCounters.EpsMax {
c.epsCounters.EpsMax = c.epsCounters.Eps
}
}
func NewPromCounterCatalogueContainer(p *Prometheus, selLabels []string, l map[string]string) *PromCounterCatalogueContainer {
if len(selLabels) == 0 {
panic("Cannot create a new PromCounterCatalogueContainer with empty list of selLabels")
}
sel, ok := catalogueSelectors[selLabels[0]]
if !ok {
panic(fmt.Sprintf("No selector for %v label", selLabels[0]))
}
// copy all the data over, to make sure this container does not share memory with other containers
r := &PromCounterCatalogueContainer{
prom: p,
stats: make(map[string]PrometheusCountersCatalogue),
selector: sel,
labelNames: make([]string, len(selLabels)),
labels: make(map[string]string),
}
for k, v := range l {
r.labels[k] = v
}
copy(r.labelNames, selLabels)
return r
}
// Returns a slice of all PrometheusCountersSet in a Container
func (c *PromCounterCatalogueContainer) GetAllCounterSets() []*PrometheusCountersSet {
ret := []*PrometheusCountersSet{}
c.RLock()
for _, v := range c.stats {
switch elem := v.(type) {
case *PrometheusCountersSet:
ret = append(ret, elem)
case *PromCounterCatalogueContainer:
ret = append(ret, elem.GetAllCounterSets()...)
default:
panic(fmt.Sprintf("Unexpected element in PromCounterCatalogueContainer of %T: %v", v, v))
}
}
c.RUnlock()
return ret
}
// Searches for an existing element for a label value, creating one if not found
func (c *PromCounterCatalogueContainer) GetCountersSet(dm *dnsutils.DNSMessage) PrometheusCountersCatalogue {
if c.selector == nil {
panic(fmt.Sprintf("%v: nil selector", c))
}
// c.selector fetches the value for the label *this* Catalogue Element considers.
// Check if we alreday have item for it, and return it if we do (it is either catalogue or counter set)
lbl := c.selector(dm)
c.Lock()
defer c.Unlock()
if r, ok := c.stats[lbl]; ok {
return r.GetCountersSet(dm)
}
// there is no existing element in the catalogue. We need to create a new entry.
// Entry may be a new Catalogue, or PrometheusCounterSet.
// If selector_labels consists of single element, we need to create a PrometheusCounterSet.
// Otherwise, there is another layer of labels.
var newElem PrometheusCountersCatalogue
// Prepare labels for the new element (needed for ether CatalogueContainer and CounterSet)
newLables := map[string]string{
c.labelNames[0]: lbl,
}
for k, v := range c.labels {
newLables[k] = v
}
if len(c.labelNames) > 1 {
newElem = NewPromCounterCatalogueContainer(
c.prom,
c.labelNames[1:],
newLables, // Here we'll do an extra map copy...
)
} else {
newElem = newPrometheusCounterSet(
c.prom,
prometheus.Labels(newLables),
)
}
c.stats[lbl] = newElem
// GetCountersSet of the newly created element may take some time, and we will be holding the lock
// of the current Container until it is done. This may be improved if we separate c.stats[lbl]
// update and calling GetCountersSet on the new element.
return c.stats[lbl].GetCountersSet(dm)
}
// This function checks the configuration, to determine which label dimensions were requested
// by configuration, and returns correct implementation of Catalogue.
func CreateSystemCatalogue(o *Prometheus) ([]string, *PromCounterCatalogueContainer) {
lbls := o.config.Loggers.Prometheus.LabelsList
// Default configuration is label with stream_id, to keep us backward compatible
if len(lbls) == 0 {
lbls = []string{"stream_id"}
}
return lbls, NewPromCounterCatalogueContainer(
o,
lbls,
make(map[string]string),
)
}
func NewPrometheus(config *pkgconfig.Config, logger *logger.Logger, name string) *Prometheus {
logger.Info(pkgutils.PrefixLogLogger+"[%s] prometheus - enabled", name)
o := &Prometheus{
doneAPI: make(chan bool),
stopProcess: make(chan bool),
doneProcess: make(chan bool),
stopRun: make(chan bool),
doneRun: make(chan bool),
config: config,
configChan: make(chan *pkgconfig.Config),
inputChan: make(chan dnsutils.DNSMessage, config.Loggers.Prometheus.ChannelBufferSize),
outputChan: make(chan dnsutils.DNSMessage, config.Loggers.Prometheus.ChannelBufferSize),
logger: logger,
promRegistry: prometheus.NewPedanticRegistry(),
name: name,
RoutingHandler: pkgutils.NewRoutingHandler(config, logger, name),
}
// This will create a catalogue of counters indexed by fileds requested by config
o.catalogueLabels, o.counters = CreateSystemCatalogue(o)
// init prometheus
o.InitProm()
// midleware to add basic authentication
authMiddleware := func(handler http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
username, password, ok := r.BasicAuth()
if !ok || username != o.config.Loggers.Prometheus.BasicAuthLogin || password != o.config.Loggers.Prometheus.BasicAuthPwd {
w.Header().Set("WWW-Authenticate", `Basic realm="Restricted"`)
w.WriteHeader(http.StatusUnauthorized)
fmt.Fprintf(w, "Unauthorized\n")
return
}
handler.ServeHTTP(w, r)
})
}
mux := http.NewServeMux()
mux.Handle("/metrics", promhttp.HandlerFor(o.promRegistry, promhttp.HandlerOpts{}))
handler := authMiddleware(mux)
o.httpServer = &http.Server{}
if o.config.Loggers.Prometheus.BasicAuthEnabled {
o.httpServer.Handler = handler
} else {
o.httpServer.Handler = mux
}
o.httpServer.ErrorLog = o.logger.ErrorLogger()
return o
}
func (c *Prometheus) GetName() string { return c.name }
func (c *Prometheus) AddDroppedRoute(wrk pkgutils.Worker) {
c.RoutingHandler.AddDroppedRoute(wrk)
}
func (c *Prometheus) AddDefaultRoute(wrk pkgutils.Worker) {
c.RoutingHandler.AddDefaultRoute(wrk)
}
func (c *Prometheus) SetLoggers(loggers []pkgutils.Worker) {}
func (c *Prometheus) InitProm() {
promPrefix := SanitizeMetricName(c.config.Loggers.Prometheus.PromPrefix)
// register metric about current version information.
c.promRegistry.MustRegister(version.NewCollector(promPrefix))
// export Go runtime metrics
c.promRegistry.MustRegister(
collectors.NewGoCollector(collectors.WithGoCollectorMemStatsMetricsDisabled()),
collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}),
)
// also try collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}),
// Metric description created in Prometheus object, but used in Describe method of PrometheusCounterSet
// Prometheus class itself reports signle metric - BuildInfo.
c.gaugeTopDomains = prometheus.NewDesc(
fmt.Sprintf("%s_top_domains", promPrefix),
"Number of hit per domain topN, partitioned by qname",
[]string{"domain"}, nil,
)
c.gaugeTopNoerrDomains = prometheus.NewDesc(
fmt.Sprintf("%s_top_noerror_domains", promPrefix),
"Number of hit per domain topN, partitioned by qname",
[]string{"domain"}, nil,
)
c.gaugeTopNxDomains = prometheus.NewDesc(
fmt.Sprintf("%s_top_nonexistent_domains", promPrefix),
"Number of hit per nx domain topN, partitioned by qname",
[]string{"domain"}, nil,
)
c.gaugeTopSfDomains = prometheus.NewDesc(
fmt.Sprintf("%s_top_servfail_domains", promPrefix),
"Number of hit per servfail domain topN, partitioned by stream and qname",
[]string{"domain"}, nil,
)
c.gaugeTopRequesters = prometheus.NewDesc(
fmt.Sprintf("%s_top_requesters", promPrefix),
"Number of hit per requester topN, partitioned by client IP",
[]string{"ip"}, nil,
)
c.gaugeTopTlds = prometheus.NewDesc(
fmt.Sprintf("%s_top_tlds", promPrefix),
"Number of hit per tld - topN",
[]string{"suffix"}, nil,
)
// etldplusone_top_total
c.gaugeTopETldsPlusOne = prometheus.NewDesc(
fmt.Sprintf("%s_top_etlds_plusone", promPrefix),
"Number of hit per eTLD+1 - topN",
[]string{"suffix"}, nil,
)
c.gaugeTopSuspicious = prometheus.NewDesc(
fmt.Sprintf("%s_top_suspicious", promPrefix),
"Number of hit per suspicious domain - topN",
[]string{"domain"}, nil,
)
c.gaugeTopEvicted = prometheus.NewDesc(
fmt.Sprintf("%s_top_unanswered", promPrefix),
"Number of hit per unanswered domain - topN",
[]string{"domain"}, nil,
)
c.gaugeEps = prometheus.NewDesc(
fmt.Sprintf("%s_throughput_ops", promPrefix),
"Number of ops per second received, partitioned by stream",
nil, nil,
)
c.gaugeEpsMax = prometheus.NewDesc(
fmt.Sprintf("%s_throughput_ops_max", promPrefix),
"Max number of ops per second observed, partitioned by stream",
nil, nil,
)
// Counter metrics
c.gaugeDomainsAll = prometheus.NewDesc(
fmt.Sprintf("%s_total_domains_lru", promPrefix),
"Total number of uniq domains most recently observed per stream identity ",
nil, nil,
)
c.gaugeDomainsValid = prometheus.NewDesc(
fmt.Sprintf("%s_total_noerror_domains_lru", promPrefix),
"Total number of NOERROR domains most recently observed per stream identity ",
nil, nil,
)
c.gaugeDomainsNx = prometheus.NewDesc(
fmt.Sprintf("%s_total_nonexistent_domains_lru", promPrefix),
"Total number of NX domains most recently observed per stream identity",
nil, nil,
)
c.gaugeDomainsSf = prometheus.NewDesc(
fmt.Sprintf("%s_total_servfail_domains_lru", promPrefix),
"Total number of SERVFAIL domains most recently observed per stream identity",
nil, nil,
)
c.gaugeRequesters = prometheus.NewDesc(
fmt.Sprintf("%s_total_requesters_lru", promPrefix),
"Total number of DNS clients most recently observed per stream identity.",
nil, nil,
)
c.gaugeTlds = prometheus.NewDesc(
fmt.Sprintf("%s_total_tlds_lru", promPrefix),
"Total number of tld most recently observed per stream identity",
nil, nil,
)
c.gaugeETldPlusOne = prometheus.NewDesc(
fmt.Sprintf("%s_total_etlds_plusone_lru", promPrefix),
"Total number of etld+one most recently observed per stream identity",
nil, nil,
)
c.gaugeSuspicious = prometheus.NewDesc(
fmt.Sprintf("%s_total_suspicious_lru", promPrefix),
"Total number of suspicious domains most recently observed per stream identity",
nil, nil,
)
c.gaugeEvicted = prometheus.NewDesc(
fmt.Sprintf("%s_total_unanswered_lru", promPrefix),
"Total number of unanswered domains most recently observed per stream identity",
nil, nil,
)
c.counterQtypes = prometheus.NewDesc(
fmt.Sprintf("%s_qtypes_total", promPrefix),
"Counter of queries per qtypes",
[]string{"query_type"}, nil,
)
c.counterRcodes = prometheus.NewDesc(
fmt.Sprintf("%s_rcodes_total", promPrefix),
"Counter of replies per return codes",
[]string{"return_code"}, nil,
)
c.counterIPProtocol = prometheus.NewDesc(
fmt.Sprintf("%s_ipprotocol_total", promPrefix),
"Counter of packets per IP protocol",
[]string{"net_transport"}, nil,
)
c.counterIPVersion = prometheus.NewDesc(
fmt.Sprintf("%s_ipversion_total", promPrefix),
"Counter of packets per IP version",
[]string{"net_family"}, nil,
)
c.counterDNSMessages = prometheus.NewDesc(
fmt.Sprintf("%s_dnsmessages_total", promPrefix),
"Counter of DNS messages per stream",
nil, nil,
)
c.counterDNSQueries = prometheus.NewDesc(
fmt.Sprintf("%s_queries_total", promPrefix),
"Counter of DNS queries per stream",
nil, nil,
)
c.counterDNSReplies = prometheus.NewDesc(
fmt.Sprintf("%s_replies_total", promPrefix),
"Counter of DNS replies per stream",
nil, nil,
)
c.counterFlagsTC = prometheus.NewDesc(
fmt.Sprintf("%s_flag_tc_total", promPrefix),
"Number of packet with flag TC",
nil, nil,
)
c.counterFlagsAA = prometheus.NewDesc(
fmt.Sprintf("%s_flag_aa_total", promPrefix),