-
Notifications
You must be signed in to change notification settings - Fork 2.8k
/
metrics.go
1612 lines (1324 loc) · 60.4 KB
/
metrics.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
// SPDX-License-Identifier: Apache-2.0
// Copyright Authors of Cilium
// Package metrics holds prometheus metrics objects and related utility functions. It
// does not abstract away the prometheus client but the caller rarely needs to
// refer to prometheus directly.
package metrics
// Adding a metric
// - Add a metric object of the appropriate type as an exported variable
// - Register the new object in the init function
import (
"context"
"github.com/prometheus/client_golang/prometheus"
dto "github.com/prometheus/client_model/go"
"github.com/sirupsen/logrus"
"github.com/cilium/cilium/api/v1/models"
"github.com/cilium/cilium/pkg/metrics/metric"
"github.com/cilium/cilium/pkg/promise"
"github.com/cilium/cilium/pkg/source"
"github.com/cilium/cilium/pkg/time"
"github.com/cilium/cilium/pkg/version"
)
const (
// ErrorTimeout is the value used to notify timeout errors.
ErrorTimeout = "timeout"
// ErrorProxy is the value used to notify errors on Proxy.
ErrorProxy = "proxy"
// L7DNS is the value used to report DNS label on metrics
L7DNS = "dns"
// SubsystemBPF is the subsystem to scope metrics related to the bpf syscalls.
SubsystemBPF = "bpf"
// SubsystemDatapath is the subsystem to scope metrics related to management of
// the datapath. It is prepended to metric names and separated with a '_'.
SubsystemDatapath = "datapath"
// SubsystemAgent is the subsystem to scope metrics related to the cilium agent itself.
SubsystemAgent = "agent"
// SubsystemFQDN is the subsystem to scope metrics related to the FQDN proxy.
SubsystemIPCache = "ipcache"
// SubsystemK8s is the subsystem to scope metrics related to Kubernetes
SubsystemK8s = "k8s"
// SubsystemK8sClient is the subsystem to scope metrics related to the kubernetes client.
SubsystemK8sClient = "k8s_client"
// SubsystemWorkQueue is the subsystem to scope metrics related to the workqueue.
SubsystemWorkQueue = "k8s_workqueue"
// SubsystemKVStore is the subsystem to scope metrics related to the kvstore.
SubsystemKVStore = "kvstore"
// SubsystemFQDN is the subsystem to scope metrics related to the FQDN proxy.
SubsystemFQDN = "fqdn"
// SubsystemNodes is the subsystem to scope metrics related to the node manager.
SubsystemNodes = "nodes"
// SubsystemTriggers is the subsystem to scope metrics related to the trigger package.
SubsystemTriggers = "triggers"
// SubsystemAPILimiter is the subsystem to scope metrics related to the API limiter package.
SubsystemAPILimiter = "api_limiter"
// CiliumAgentNamespace is used to scope metrics from the Cilium Agent
CiliumAgentNamespace = "cilium"
// CiliumClusterMeshAPIServerNamespace is used to scope metrics from the
// Cilium Cluster Mesh API Server
CiliumClusterMeshAPIServerNamespace = "cilium_clustermesh_apiserver"
// CiliumClusterMeshAPIServerNamespace is used to scope metrics from
// Cilium KVStoreMesh
CiliumKVStoreMeshNamespace = "cilium_kvstoremesh"
// CiliumOperatorNamespace is used to scope metrics from the Cilium Operator
CiliumOperatorNamespace = "cilium_operator"
// LabelError indicates the type of error (string)
LabelError = "error"
// LabelOutcome indicates whether the outcome of the operation was successful or not
LabelOutcome = "outcome"
// LabelAttempts is the number of attempts it took to complete the operation
LabelAttempts = "attempts"
// Labels
// LabelValueFalse is the string value for true metric label values.
LabelValueTrue = "true"
// LabelValueFalse is the string value for false metric label values.
LabelValueFalse = "false"
// LabelValueOutcomeSuccess is used as a successful outcome of an operation
LabelValueOutcomeSuccess = "success"
// LabelValueOutcomeFail is used as an unsuccessful outcome of an operation
LabelValueOutcomeFail = "fail"
// LabelValueOutcomeFailure is used as an unsuccessful outcome of an operation.
// NOTE: This should only be used for existing metrics, new metrics should use LabelValueOutcomeFail.
LabelValueOutcomeFailure = "failure"
// LabelDropReason is used to describe reason for dropping a packets/bytes
LabelDropReason = "reason"
// LabelEventSourceAPI marks event-related metrics that come from the API
LabelEventSourceAPI = "api"
// LabelEventSourceK8s marks event-related metrics that come from k8s
LabelEventSourceK8s = "k8s"
// LabelEventSourceFQDN marks event-related metrics that come from pkg/fqdn
LabelEventSourceFQDN = "fqdn"
// LabelEventSourceContainerd marks event-related metrics that come from docker
LabelEventSourceContainerd = "docker"
// LabelDatapathArea marks which area the metrics are related to (eg, which BPF map)
LabelDatapathArea = "area"
// LabelDatapathName marks a unique identifier for this metric.
// The name should be defined once for a given type of error.
LabelDatapathName = "name"
// LabelDatapathFamily marks which protocol family (IPv4, IPV6) the metric is related to.
LabelDatapathFamily = "family"
// LabelProtocol marks the L4 protocol (TCP, ANY) for the metric.
LabelProtocol = "protocol"
// LabelSignalType marks the signal name
LabelSignalType = "signal"
// LabelSignalData marks the signal data
LabelSignalData = "data"
// LabelStatus the label from completed task
LabelStatus = "status"
// LabelPolicyEnforcement is the label used to see the enforcement status
LabelPolicyEnforcement = "enforcement"
// LabelPolicySource is the label used to see the enforcement status
LabelPolicySource = "source"
LabelSource = "source"
// LabelScope is the label used to defined multiples scopes in the same
// metric. For example, one counter may measure a metric over the scope of
// the entire event (scope=global), or just part of an event
// (scope=slow_path)
LabelScope = "scope"
// LabelProtocolL7 is the label used when working with layer 7 protocols.
LabelProtocolL7 = "protocol_l7"
// LabelBuildState is the state a build queue entry is in
LabelBuildState = "state"
// LabelBuildQueueName is the name of the build queue
LabelBuildQueueName = "name"
// LabelAction is the label used to defined what kind of action was performed in a metric
LabelAction = "action"
// LabelSubsystem is the label used to refer to any of the child process
// started by cilium (Envoy, monitor, etc..)
LabelSubsystem = "subsystem"
// LabelKind is the kind of a label
LabelKind = "kind"
// LabelEventSource is the source of a label for event metrics
// i.e. k8s, containerd, api.
LabelEventSource = "source"
// LabelPath is the label for the API path
LabelPath = "path"
// LabelMethod is the label for the HTTP method
LabelMethod = "method"
// LabelAPIReturnCode is the HTTP code returned for that API path
LabelAPIReturnCode = "return_code"
// LabelOperation is the label for BPF maps operations
LabelOperation = "operation"
// LabelMapName is the label for the BPF map name
LabelMapName = "map_name"
LabelMapGroup = "map_group"
// LabelVersion is the label for the version number
LabelVersion = "version"
// LabelVersionRevision is the label for the version revision
LabelVersionRevision = "revision"
// LabelArch is the label for the platform architecture (e.g. linux/amd64)
LabelArch = "arch"
// LabelDirection is the label for traffic direction
LabelDirection = "direction"
// LabelSourceCluster is the label for source cluster name
LabelSourceCluster = "source_cluster"
// LabelSourceNodeName is the label for source node name
LabelSourceNodeName = "source_node_name"
// LabelTargetCluster is the label for target cluster name
LabelTargetCluster = "target_cluster"
// LabelTargetNodeIP is the label for target node IP
LabelTargetNodeIP = "target_node_ip"
// LabelTargetNodeName is the label for target node name
LabelTargetNodeName = "target_node_name"
// LabelTargetNodeType is the label for target node type (local_node, remote_intra_cluster, vs remote_inter_cluster)
LabelTargetNodeType = "target_node_type"
LabelLocationLocalNode = "local_node"
LabelLocationRemoteIntraCluster = "remote_intra_cluster"
LabelLocationRemoteInterCluster = "remote_inter_cluster"
// Rule label is a label for a L7 rule name.
LabelL7Rule = "rule"
// LabelL7ProxyType is the label for denoting a L7 proxy type.
LabelL7ProxyType = "proxy_type"
// LabelType is the label for type in general (e.g. endpoint, node)
LabelType = "type"
LabelPeerEndpoint = "endpoint"
LabelPeerNode = "node"
LabelTrafficHTTP = "http"
LabelTrafficICMP = "icmp"
LabelAddressType = "address_type"
LabelAddressTypePrimary = "primary"
LabelAddressTypeSecondary = "secondary"
)
var (
// LabelValuesBool is metric label value set for boolean type.
LabelValuesBool = metric.NewValues(LabelValueTrue, LabelValueFalse)
// Namespace is used to scope metrics from cilium. It is prepended to metric
// names and separated with a '_'
Namespace = CiliumAgentNamespace
registryResolver, registry = promise.New[*Registry]()
BPFMapPressure = true
// BootstrapTimes is the durations of cilium-agent bootstrap sequence.
BootstrapTimes = NoOpObserverVec
// APIInteractions is the total time taken to process an API call made
// to the cilium-agent
APIInteractions = NoOpObserverVec
// Status
// NodeConnectivityStatus is the connectivity status between local node to
// other node intra or inter cluster.
NodeConnectivityStatus = NoOpGaugeDeletableVec
// NodeConnectivityLatency is the connectivity latency between local node to
// other node intra or inter cluster.
NodeConnectivityLatency = NoOpGaugeDeletableVec
// Endpoint
// Endpoint is a function used to collect this metric.
// It must be thread-safe.
Endpoint metric.GaugeFunc
// EndpointMaxIfindex is the maximum observed interface index for existing endpoints
EndpointMaxIfindex = NoOpGauge
// EndpointRegenerationTotal is a count of the number of times any endpoint
// has been regenerated and success/fail outcome
EndpointRegenerationTotal = NoOpCounterVec
// EndpointStateCount is the total count of the endpoints in various states.
EndpointStateCount = NoOpGaugeVec
// EndpointRegenerationTimeStats is the total time taken to regenerate
// endpoints, labeled by span name and status ("success" or "failure")
EndpointRegenerationTimeStats = NoOpObserverVec
// EndpointPropagationDelay is the delay between creation of local CiliumEndpoint
// and update for that CiliumEndpoint received through CiliumEndpointSlice.
// Measure of local CEP roundtrip time with CiliumEndpointSlice feature enabled.
EndpointPropagationDelay = NoOpObserverVec
// Policy
// Policy is the number of policies loaded into the agent
Policy = NoOpGauge
// PolicyRegenerationCount is the total number of successful policy
// regenerations.
PolicyRegenerationCount = NoOpCounter
// PolicyRegenerationTimeStats is the total time taken to generate policies
PolicyRegenerationTimeStats = NoOpObserverVec
// PolicyRevision is the current policy revision number for this agent
PolicyRevision = NoOpGauge
// PolicyChangeTotal is a count of policy changes by outcome ("success" or
// "failure")
PolicyChangeTotal = NoOpCounterVec
// PolicyEndpointStatus is the number of endpoints with policy labeled by enforcement type
PolicyEndpointStatus = NoOpGaugeVec
// PolicyImplementationDelay is a distribution of times taken from adding a
// policy (and incrementing the policy revision) to seeing it in the datapath
// per Endpoint. This reflects the actual delay perceived by traffic flowing
// through the datapath. The longest times will roughly correlate with the
// time taken to fully deploy an endpoint.
PolicyImplementationDelay = NoOpObserverVec
// CIDRGroup
// CIDRGroupsReferenced is the number of CNPs and CCNPs referencing at least one CiliumCIDRGroup.
// CNPs with empty or non-existing CIDRGroupRefs are not considered.
CIDRGroupsReferenced = NoOpGauge
// CIDRGroupTranslationTimeStats is the time taken to translate the policy field `FromCIDRGroupRef`
// after the referenced CIDRGroups have been updated or deleted.
CIDRGroupTranslationTimeStats = NoOpHistogram
// Identity
// Identity is the number of identities currently in use on the node by type
Identity = NoOpGaugeVec
// Events
// EventTS is the time in seconds since epoch that we last received an
// event that was handled by Cilium. This metric tracks the source of the
// event which can be one of K8s or Cilium's API.
EventTS = NoOpGaugeVec
// EventLagK8s is the lag calculation for k8s Pod events.
EventLagK8s = NoOpGauge
// L7 statistics
// ProxyRedirects is the number of redirects labeled by protocol
ProxyRedirects = NoOpGaugeVec
// ProxyPolicyL7Total is a count of all l7 requests handled by proxy
ProxyPolicyL7Total = NoOpCounterVec
// ProxyUpstreamTime is how long the upstream server took to reply labeled
// by error, protocol and span time
ProxyUpstreamTime = NoOpObserverVec
// ProxyDatapathUpdateTimeout is a count of all the timeouts encountered while
// updating the datapath due to an FQDN IP update
ProxyDatapathUpdateTimeout = NoOpCounter
// L3-L4 statistics
// Datapath statistics
// ConntrackGCRuns is the number of times that the conntrack GC
// process was run.
ConntrackGCRuns = NoOpCounterVec
// ConntrackGCKeyFallbacks number of times that the conntrack key fallback was invalid.
ConntrackGCKeyFallbacks = NoOpCounterVec
// ConntrackGCSize the number of entries in the conntrack table
ConntrackGCSize = NoOpGaugeVec
// NatGCSize the number of entries in the nat table
NatGCSize = NoOpGaugeVec
// ConntrackGCDuration the duration of the conntrack GC process in milliseconds.
ConntrackGCDuration = NoOpObserverVec
// ConntrackDumpReset marks the count for conntrack dump resets
ConntrackDumpResets = NoOpCounterVec
// Signals
// SignalsHandled is the number of signals received.
SignalsHandled = NoOpCounterVec
// Services
// ServicesEventsCount counts the number of services
ServicesEventsCount = NoOpCounterVec
// Errors and warnings
// ErrorsWarnings is the number of errors and warnings in cilium-agent instances
ErrorsWarnings = NoOpCounterVec
// ControllerRuns is the number of times that a controller process runs.
ControllerRuns = NoOpCounterVec
// ControllerRunsDuration the duration of the controller process in seconds
ControllerRunsDuration = NoOpObserverVec
// subprocess, labeled by Subsystem
SubprocessStart = NoOpCounterVec
// Kubernetes Events
// KubernetesEventProcessed is the number of Kubernetes events
// processed labeled by scope, action and execution result
KubernetesEventProcessed = NoOpCounterVec
// KubernetesEventReceived is the number of Kubernetes events received
// labeled by scope, action, valid data and equalness.
KubernetesEventReceived = NoOpCounterVec
// Kubernetes interactions
// KubernetesAPIInteractions is the total time taken to process an API call made
// to the kube-apiserver
KubernetesAPIInteractions = NoOpObserverVec
// KubernetesAPIRateLimiterLatency is the client side rate limiter latency metric
KubernetesAPIRateLimiterLatency = NoOpObserverVec
// KubernetesAPICallsTotal is the counter for all API calls made to
// kube-apiserver.
KubernetesAPICallsTotal = NoOpCounterVec
// KubernetesCNPStatusCompletion is the number of seconds it takes to
// complete a CNP status update
KubernetesCNPStatusCompletion = NoOpObserverVec
// TerminatingEndpointsEvents is the number of terminating endpoint events received from kubernetes.
TerminatingEndpointsEvents = NoOpCounter
// IPAM events
// IPAMEvent is the number of IPAM events received labeled by action and
// datapath family type
IPAMEvent = NoOpCounterVec
// IPAMCapacity tracks the total number of IPs that could be allocated. To
// get the current number of available IPs, it would be this metric
// subtracted by IPAMEvent{allocated}.
IPAMCapacity = NoOpGaugeVec
// KVstore events
// KVStoreOperationsDuration records the duration of kvstore operations
KVStoreOperationsDuration = NoOpObserverVec
// KVStoreEventsQueueDuration records the duration in seconds of time
// received event was blocked before it could be queued
KVStoreEventsQueueDuration = NoOpObserverVec
// KVStoreQuorumErrors records the number of kvstore quorum errors
KVStoreQuorumErrors = NoOpCounterVec
// FQDNGarbageCollectorCleanedTotal is the number of domains cleaned by the
// GC job.
FQDNGarbageCollectorCleanedTotal = NoOpCounter
// FQDNActiveNames is the number of domains inside the DNS cache that have
// not expired (by TTL), per endpoint.
FQDNActiveNames = NoOpGaugeVec
// FQDNActiveIPs is the number of IPs inside the DNS cache associated with
// a domain that has not expired (by TTL) and are currently active, per
// endpoint.
FQDNActiveIPs = NoOpGaugeVec
// FQDNAliveZombieConnections is the number IPs associated with domains
// that have expired (by TTL) yet still associated with an active
// connection (aka zombie), per endpoint.
FQDNAliveZombieConnections = NoOpGaugeVec
// FQDNSemaphoreRejectedTotal is the total number of DNS requests rejected
// by the DNS proxy because too many requests were in flight, as enforced by
// the admission semaphore.
FQDNSemaphoreRejectedTotal = NoOpCounter
// IPCacheErrorsTotal is the total number of IPCache events handled in
// the IPCache subsystem that resulted in errors.
IPCacheErrorsTotal = NoOpCounterVec
// IPCacheEventsTotal is the total number of IPCache events handled in
// the IPCache subsystem.
IPCacheEventsTotal = NoOpCounterVec
// BPFSyscallDuration is the metric for bpf syscalls duration.
BPFSyscallDuration = NoOpObserverVec
// BPFMapOps is the metric to measure the number of operations done to a
// bpf map.
BPFMapOps = NoOpCounterVec
// BPFMapCapacity is the max capacity of bpf maps, labelled by map group classification.
BPFMapCapacity = NoOpGaugeVec
// TriggerPolicyUpdateTotal is the metric to count total number of
// policy update triggers
TriggerPolicyUpdateTotal = NoOpCounterVec
// TriggerPolicyUpdateFolds is the current level folding that is
// happening when running policy update triggers
TriggerPolicyUpdateFolds = NoOpGauge
// TriggerPolicyUpdateCallDuration measures the latency and call
// duration of policy update triggers
TriggerPolicyUpdateCallDuration = NoOpObserverVec
// VersionMetric labelled by Cilium version
VersionMetric = NoOpGaugeVec
// APILimiterWaitHistoryDuration is a histogram that measures the
// individual wait durations of API limiters
APILimiterWaitHistoryDuration = NoOpObserverVec
// APILimiterWaitDuration is the gauge of the current mean, min, and
// max wait duration
APILimiterWaitDuration = NoOpGaugeVec
// APILimiterProcessingDuration is the gauge of the mean and estimated
// processing duration
APILimiterProcessingDuration = NoOpGaugeVec
// APILimiterRequestsInFlight is the gauge of the current and max
// requests in flight
APILimiterRequestsInFlight = NoOpGaugeVec
// APILimiterRateLimit is the gauge of the current rate limiting
// configuration including limit and burst
APILimiterRateLimit = NoOpGaugeVec
// APILimiterAdjustmentFactor is the gauge representing the latest
// adjustment factor that was applied
APILimiterAdjustmentFactor = NoOpGaugeVec
// APILimiterProcessedRequests is the counter of the number of
// processed (successful and failed) requests
APILimiterProcessedRequests = NoOpCounterVec
// WorkQueueDepth is the depth of the workqueue
//
// We set actual metrics here instead of NoOp for the workqueue metrics
// because these metrics will be registered with workqueue.SetProvider
// by init function in watcher.go. Otherwise, we will register NoOps.
//
WorkQueueDepth = metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_" + SubsystemWorkQueue + "_depth",
Namespace: Namespace,
Subsystem: SubsystemWorkQueue,
Name: "depth",
Help: "Current depth of workqueue.",
}, []string{"name"})
// WorkQueueAddsTotal is the total number of adds to the workqueue
WorkQueueAddsTotal = metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_" + SubsystemWorkQueue + "_adds_total",
Namespace: Namespace,
Subsystem: SubsystemWorkQueue,
Name: "adds_total",
Help: "Total number of adds handled by workqueue.",
}, []string{"name"})
// WorkQueueLatency is the latency of how long an item stays in the workqueue
WorkQueueLatency = metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_" + SubsystemWorkQueue + "_queue_duration_seconds",
Namespace: Namespace,
Subsystem: SubsystemWorkQueue,
Name: "queue_duration_seconds",
Help: "How long in seconds an item stays in workqueue before being requested.",
Buckets: prometheus.ExponentialBuckets(10e-9, 10, 10),
}, []string{"name"})
// WorkQueueDuration is the duration of how long processing an item for the workqueue
WorkQueueDuration = metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_" + SubsystemWorkQueue + "_work_duration_seconds",
Namespace: Namespace,
Subsystem: SubsystemWorkQueue,
Name: "work_duration_seconds",
Help: "How long in seconds processing an item from workqueue takes.",
Buckets: prometheus.ExponentialBuckets(10e-9, 10, 10),
}, []string{"name"})
// WorkQueueUnfinishedWork is how many seconds of work has been done that is in progress
WorkQueueUnfinishedWork = metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_" + SubsystemWorkQueue + "_unfinished_work_seconds",
Namespace: Namespace,
Subsystem: SubsystemWorkQueue,
Name: "unfinished_work_seconds",
Help: "How many seconds of work has been done that " +
"is in progress and hasn't been observed by work_duration. Large " +
"values indicate stuck threads. One can deduce the number of stuck " +
"threads by observing the rate at which this increases.",
}, []string{"name"})
// WorkQueueLongestRunningProcessor is the longest running processor in the workqueue
WorkQueueLongestRunningProcessor = metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_" + SubsystemWorkQueue + "_longest_running_processor_seconds",
Namespace: Namespace,
Subsystem: SubsystemWorkQueue,
Name: "longest_running_processor_seconds",
Help: "How many seconds has the longest running " +
"processor for workqueue been running.",
}, []string{"name"})
// WorkQueueRetries is the number of retries for handled by the workqueue
WorkQueueRetries = metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_" + SubsystemWorkQueue + "_retries_total",
Namespace: Namespace,
Subsystem: SubsystemWorkQueue,
Name: "retries_total",
Help: "Total number of retries handled by workqueue.",
}, []string{"name"})
)
type LegacyMetrics struct {
BootstrapTimes metric.Vec[metric.Observer]
APIInteractions metric.Vec[metric.Observer]
NodeConnectivityStatus metric.DeletableVec[metric.Gauge]
NodeConnectivityLatency metric.DeletableVec[metric.Gauge]
Endpoint metric.GaugeFunc
EndpointMaxIfindex metric.Gauge
EndpointRegenerationTotal metric.Vec[metric.Counter]
EndpointStateCount metric.Vec[metric.Gauge]
EndpointRegenerationTimeStats metric.Vec[metric.Observer]
EndpointPropagationDelay metric.Vec[metric.Observer]
Policy metric.Gauge
PolicyRegenerationCount metric.Counter
PolicyRegenerationTimeStats metric.Vec[metric.Observer]
PolicyRevision metric.Gauge
PolicyChangeTotal metric.Vec[metric.Counter]
PolicyEndpointStatus metric.Vec[metric.Gauge]
PolicyImplementationDelay metric.Vec[metric.Observer]
CIDRGroupsReferenced metric.Gauge
CIDRGroupTranslationTimeStats metric.Histogram
Identity metric.Vec[metric.Gauge]
EventTS metric.Vec[metric.Gauge]
EventLagK8s metric.Gauge
ProxyRedirects metric.Vec[metric.Gauge]
ProxyPolicyL7Total metric.Vec[metric.Counter]
ProxyUpstreamTime metric.Vec[metric.Observer]
ProxyDatapathUpdateTimeout metric.Counter
ConntrackGCRuns metric.Vec[metric.Counter]
ConntrackGCKeyFallbacks metric.Vec[metric.Counter]
ConntrackGCSize metric.Vec[metric.Gauge]
NatGCSize metric.Vec[metric.Gauge]
ConntrackGCDuration metric.Vec[metric.Observer]
ConntrackDumpResets metric.Vec[metric.Counter]
SignalsHandled metric.Vec[metric.Counter]
ServicesEventsCount metric.Vec[metric.Counter]
ErrorsWarnings metric.Vec[metric.Counter]
ControllerRuns metric.Vec[metric.Counter]
ControllerRunsDuration metric.Vec[metric.Observer]
SubprocessStart metric.Vec[metric.Counter]
KubernetesEventProcessed metric.Vec[metric.Counter]
KubernetesEventReceived metric.Vec[metric.Counter]
KubernetesAPIInteractions metric.Vec[metric.Observer]
KubernetesAPIRateLimiterLatency metric.Vec[metric.Observer]
KubernetesAPICallsTotal metric.Vec[metric.Counter]
KubernetesCNPStatusCompletion metric.Vec[metric.Observer]
TerminatingEndpointsEvents metric.Counter
IPAMEvent metric.Vec[metric.Counter]
IPAMCapacity metric.Vec[metric.Gauge]
KVStoreOperationsDuration metric.Vec[metric.Observer]
KVStoreEventsQueueDuration metric.Vec[metric.Observer]
KVStoreQuorumErrors metric.Vec[metric.Counter]
FQDNGarbageCollectorCleanedTotal metric.Counter
FQDNActiveNames metric.Vec[metric.Gauge]
FQDNActiveIPs metric.Vec[metric.Gauge]
FQDNAliveZombieConnections metric.Vec[metric.Gauge]
FQDNSemaphoreRejectedTotal metric.Counter
IPCacheErrorsTotal metric.Vec[metric.Counter]
IPCacheEventsTotal metric.Vec[metric.Counter]
BPFSyscallDuration metric.Vec[metric.Observer]
BPFMapOps metric.Vec[metric.Counter]
BPFMapCapacity metric.Vec[metric.Gauge]
TriggerPolicyUpdateTotal metric.Vec[metric.Counter]
TriggerPolicyUpdateFolds metric.Gauge
TriggerPolicyUpdateCallDuration metric.Vec[metric.Observer]
VersionMetric metric.Vec[metric.Gauge]
APILimiterWaitHistoryDuration metric.Vec[metric.Observer]
APILimiterWaitDuration metric.Vec[metric.Gauge]
APILimiterProcessingDuration metric.Vec[metric.Gauge]
APILimiterRequestsInFlight metric.Vec[metric.Gauge]
APILimiterRateLimit metric.Vec[metric.Gauge]
APILimiterAdjustmentFactor metric.Vec[metric.Gauge]
APILimiterProcessedRequests metric.Vec[metric.Counter]
WorkQueueDepth metric.Vec[metric.Gauge]
WorkQueueAddsTotal metric.Vec[metric.Counter]
WorkQueueLatency metric.Vec[metric.Observer]
WorkQueueDuration metric.Vec[metric.Observer]
WorkQueueUnfinishedWork metric.Vec[metric.Gauge]
WorkQueueLongestRunningProcessor metric.Vec[metric.Gauge]
WorkQueueRetries metric.Vec[metric.Counter]
}
func NewLegacyMetrics() *LegacyMetrics {
lm := &LegacyMetrics{
BootstrapTimes: metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_" + SubsystemAgent + "_bootstrap_seconds",
Namespace: Namespace,
Subsystem: SubsystemAgent,
Name: "bootstrap_seconds",
Help: "Duration of bootstrap sequence",
}, []string{LabelScope, LabelOutcome}),
APIInteractions: metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_" + SubsystemAgent + "_api_process_time_seconds",
Namespace: Namespace,
Subsystem: SubsystemAgent,
Name: "api_process_time_seconds",
Help: "Duration of processed API calls labeled by path, method and return code.",
}, []string{LabelPath, LabelMethod, LabelAPIReturnCode}),
EndpointRegenerationTotal: metric.NewCounterVecWithLabels(metric.CounterOpts{
ConfigName: Namespace + "_endpoint_regenerations_total",
Namespace: Namespace,
Name: "endpoint_regenerations_total",
Help: "Count of all endpoint regenerations that have completed, tagged by outcome",
}, metric.Labels{
{
Name: LabelOutcome,
Values: metric.NewValues(LabelValueOutcomeSuccess, LabelValueOutcomeFailure),
},
}),
EndpointStateCount: metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_endpoint_state",
Namespace: Namespace,
Name: "endpoint_state",
Help: "Count of all endpoints, tagged by different endpoint states",
},
[]string{"endpoint_state"},
),
EndpointRegenerationTimeStats: metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_endpoint_regeneration_time_stats_seconds",
Namespace: Namespace,
Name: "endpoint_regeneration_time_stats_seconds",
Help: "Endpoint regeneration time stats labeled by the scope",
}, []string{LabelScope, LabelStatus}),
Policy: metric.NewGauge(metric.GaugeOpts{
ConfigName: Namespace + "_policy",
Namespace: Namespace,
Name: "policy",
Help: "Number of policies currently loaded",
}),
PolicyRegenerationCount: metric.NewCounter(metric.CounterOpts{
ConfigName: Namespace + "_policy_regeneration_total",
Namespace: Namespace,
Name: "policy_regeneration_total",
Help: "Total number of successful policy regenerations",
}),
PolicyRegenerationTimeStats: metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_policy_regeneration_time_stats_seconds",
Namespace: Namespace,
Name: "policy_regeneration_time_stats_seconds",
Help: "Policy regeneration time stats labeled by the scope",
}, []string{LabelScope, LabelStatus}),
PolicyRevision: metric.NewGauge(metric.GaugeOpts{
ConfigName: Namespace + "_policy_max_revision",
Namespace: Namespace,
Name: "policy_max_revision",
Help: "Highest policy revision number in the agent",
}),
PolicyChangeTotal: metric.NewCounterVecWithLabels(metric.CounterOpts{
ConfigName: Namespace + "_policy_change_total",
Namespace: Namespace,
Name: "policy_change_total",
Help: "Number of policy changes by outcome",
}, metric.Labels{
{
Name: LabelOutcome,
Values: metric.NewValues(LabelValueOutcomeSuccess, LabelValueOutcomeFailure),
},
}),
PolicyEndpointStatus: metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_policy_endpoint_enforcement_status",
Namespace: Namespace,
Name: "policy_endpoint_enforcement_status",
Help: "Number of endpoints labeled by policy enforcement status",
}, []string{LabelPolicyEnforcement}),
PolicyImplementationDelay: metric.NewHistogramVecWithLabels(metric.HistogramOpts{
ConfigName: Namespace + "_policy_implementation_delay",
Namespace: Namespace,
Name: "policy_implementation_delay",
Help: "Time between a policy change and it being fully deployed into the datapath",
}, metric.Labels{
{
Name: LabelPolicySource,
Values: metric.NewValues(string(source.Kubernetes), string(source.CustomResource), string(source.LocalAPI)),
},
}),
CIDRGroupsReferenced: metric.NewGauge(metric.GaugeOpts{
ConfigName: Namespace + "cidrgroups_referenced",
Namespace: Namespace,
Name: "cidrgroups_referenced",
Help: "Number of CNPs and CCNPs referencing at least one CiliumCIDRGroup. CNPs with empty or non-existing CIDRGroupRefs are not considered",
}),
CIDRGroupTranslationTimeStats: metric.NewHistogram(metric.HistogramOpts{
ConfigName: Namespace + "cidrgroup_translation_time_stats_seconds",
Disabled: true,
Namespace: Namespace,
Name: "cidrgroup_translation_time_stats_seconds",
Help: "CIDRGroup translation time stats",
}),
Identity: metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_identity",
Namespace: Namespace,
Name: "identity",
Help: "Number of identities currently allocated",
}, []string{LabelType}),
EventTS: metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_event_ts",
Namespace: Namespace,
Name: "event_ts",
Help: "Last timestamp when Cilium received an event from a control plane source, per resource and per action",
}, []string{LabelEventSource, LabelScope, LabelAction}),
EventLagK8s: metric.NewGauge(metric.GaugeOpts{
ConfigName: Namespace + "_k8s_event_lag_seconds",
Disabled: true,
Namespace: Namespace,
Name: "k8s_event_lag_seconds",
Help: "Lag for Kubernetes events - computed value between receiving a CNI ADD event from kubelet and a Pod event received from kube-api-server",
ConstLabels: prometheus.Labels{"source": LabelEventSourceK8s},
}),
ProxyRedirects: metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_proxy_redirects",
Namespace: Namespace,
Name: "proxy_redirects",
Help: "Number of redirects installed for endpoints, labeled by protocol",
}, []string{LabelProtocolL7}),
ProxyPolicyL7Total: metric.NewCounterVecWithLabels(metric.CounterOpts{
ConfigName: Namespace + "_policy_l7_total",
Namespace: Namespace,
Name: "policy_l7_total",
Help: "Number of total proxy requests handled",
}, metric.Labels{
{
Name: LabelL7Rule,
Values: metric.NewValues("received", "forwarded", "denied", "parse_errors"),
},
{
Name: LabelL7ProxyType,
Values: metric.NewValues("fqdn", "envoy"),
},
}),
ProxyUpstreamTime: metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_proxy_upstream_reply_seconds",
Namespace: Namespace,
Name: "proxy_upstream_reply_seconds",
Help: "Seconds waited to get a reply from a upstream server",
}, []string{"error", LabelProtocolL7, LabelScope}),
ProxyDatapathUpdateTimeout: metric.NewCounter(metric.CounterOpts{
ConfigName: Namespace + "_proxy_datapath_update_timeout_total",
Disabled: true,
Namespace: Namespace,
Name: "proxy_datapath_update_timeout_total",
Help: "Number of total datapath update timeouts due to FQDN IP updates",
}),
ConntrackGCRuns: metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_" + SubsystemDatapath + "_conntrack_gc_runs_total",
Namespace: Namespace,
Subsystem: SubsystemDatapath,
Name: "conntrack_gc_runs_total",
Help: "Number of times that the conntrack garbage collector process was run " +
"labeled by completion status",
}, []string{LabelDatapathFamily, LabelProtocol, LabelStatus}),
ConntrackGCKeyFallbacks: metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_" + SubsystemDatapath + "_conntrack_gc_key_fallbacks_total",
Namespace: Namespace,
Subsystem: SubsystemDatapath,
Name: "conntrack_gc_key_fallbacks_total",
Help: "Number of times a key fallback was needed when iterating over the BPF map",
}, []string{LabelDatapathFamily, LabelProtocol}),
ConntrackGCSize: metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_" + SubsystemDatapath + "_conntrack_gc_entries",
Namespace: Namespace,
Subsystem: SubsystemDatapath,
Name: "conntrack_gc_entries",
Help: "The number of alive and deleted conntrack entries at the end " +
"of a garbage collector run labeled by datapath family.",
}, []string{LabelDatapathFamily, LabelProtocol, LabelStatus}),
NatGCSize: metric.NewGaugeVec(metric.GaugeOpts{
ConfigName: Namespace + "_" + SubsystemDatapath + "_nat_gc_entries",
Disabled: true,
Namespace: Namespace,
Subsystem: SubsystemDatapath,
Name: "nat_gc_entries",
Help: "The number of alive and deleted nat entries at the end " +
"of a garbage collector run labeled by datapath family.",
}, []string{LabelDatapathFamily, LabelDirection, LabelStatus}),
ConntrackGCDuration: metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_" + SubsystemDatapath + "_conntrack_gc_duration_seconds",
Namespace: Namespace,
Subsystem: SubsystemDatapath,
Name: "conntrack_gc_duration_seconds",
Help: "Duration in seconds of the garbage collector process " +
"labeled by datapath family and completion status",
}, []string{LabelDatapathFamily, LabelProtocol, LabelStatus}),
ConntrackDumpResets: metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_" + SubsystemDatapath + "_conntrack_dump_resets_total",
Namespace: Namespace,
Subsystem: SubsystemDatapath,
Name: "conntrack_dump_resets_total",
Help: "Number of conntrack dump resets. Happens when a BPF entry gets removed while dumping the map is in progress",
}, []string{LabelDatapathArea, LabelDatapathName, LabelDatapathFamily}),
SignalsHandled: metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_" + SubsystemDatapath + "_signals_handled_total",
Namespace: Namespace,
Subsystem: SubsystemDatapath,
Name: "signals_handled_total",
Help: "Number of times that the datapath signal handler process was run " +
"labeled by signal type, data and completion status",
}, []string{LabelSignalType, LabelSignalData, LabelStatus}),
ServicesEventsCount: metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_services_events_total",
Namespace: Namespace,
Name: "services_events_total",
Help: "Number of services events labeled by action type",
}, []string{LabelAction}),
ErrorsWarnings: newErrorsWarningsMetric(),
ControllerRuns: metric.NewCounterVec(metric.CounterOpts{
ConfigName: Namespace + "_controllers_runs_total",
Namespace: Namespace,
Name: "controllers_runs_total",
Help: "Number of times that a controller process was run labeled by completion status",
}, []string{LabelStatus}),
ControllerRunsDuration: metric.NewHistogramVec(metric.HistogramOpts{
ConfigName: Namespace + "_controllers_runs_duration_seconds",
Namespace: Namespace,
Name: "controllers_runs_duration_seconds",
Help: "Duration in seconds of the controller process labeled by completion status",
}, []string{LabelStatus}),
SubprocessStart: metric.NewCounterVec(metric.CounterOpts{