package
1.6.3
Repository: https://github.com/form3tech-oss/cilium.git
Documentation: pkg.go.dev

# Functions

CreateConfiguration returns a Configuration with all metrics that are considered enabled from the given slice of metricsEnabled as well as a slice of prometheus.Collectors that must be registered in the prometheus default register.
No description provided by the author
DumpMetrics gets the current Cilium metrics and dumps all into a models.Metrics structure.If metrics cannot be retrieved, returns an error.
Enable begins serving prometheus metrics on the address passed in.
Errno2Outcome converts a syscall.Errno to LabelOutcome.
Error2Outcome converts an error to LabelOutcome.
GetCounterValue returns the current value stored for the counter.
MustRegister adds the collector to the registry, exposing this metric to prometheus scrapes.
NewLoggingHook returns a new instance of LoggingHook for the given Cilium component.
Register registers a collector.
RegisterList registers a list of collectors.
Unregister unregisters a collector.

# Constants

ErrorProxy is the value used to notify errors on Proxy.
ErrorTimeout is the value used to notify timeout errors.
L7DNS is the value used to report DNS label on metrics.
LabelAction is the label used to defined what kind of action was performed in a metric.
LabelAPIReturnCode is the HTTP code returned for that API path.
LabelAttempts is the number of attempts it took to complete the operation.
LabelBuildQueueName is the name of the build queue.
LabelBuildState is the state a build queue entry is in.
LabelDatapathArea marks which area the metrics are related to (eg, which BPF map).
LabelDatapathFamily marks which protocol family (IPv4, IPV6) the metric is related to.
LabelDatapathName marks a unique identifier for this metric.
LabelEventSourceAPI marks event-related metrics that come from the API.
LabelEventSourceContainerd marks event-related metrics that come from docker.
LabelEventSourceFQDN marks event-related metrics that come from pkg/fqdn.
LabelEventSourceK8s marks event-related metrics that come from k8s.
LabelKind is the kind a label.
LabelMapName is the label for the BPF map name.
LabelMethod is the label for the HTTP method.
LabelOperation is the label for BPF maps operations.
LabelOutcome indicates whether the outcome of the operation was successful or not.
LabelPath is the label for the API path.
LabelPolicyEnforcement is the label used to see the enforcement status.
LabelPolicySource is the label used to see the enforcement status.
LabelProtocol marks the L4 protocol (TCP, ANY) for the metric.
LabelProtocolL7 is the label used when working with layer 7 protocols.
LabelScope is the label used to defined multiples scopes in the same metric.
LabelStatus the label from completed task.
LabelSubsystem is the label used to refer to any of the child process started by cilium (Envoy, monitor, etc..).
LabelValueOutcomeFail is used as an unsuccessful outcome of an operation.
LabelValueOutcomeSuccess is used as a successful outcome of an operation.
Namespace is used to scope metrics from cilium.
SubsystemAgent is the subsystem to scope metrics related to the cilium agent itself.
SubsystemBPF is the subsystem to scope metrics related to the bpf syscalls.
SubsystemDatapath is the subsystem to scope metrics related to management of the datapath.
SubsystemK8s is the subsystem to scope metrics related to Kubernetes.
SubsystemK8sClient is the subsystem to scope metrics related to the kubernetes client.
SubsystemKVStore is the subsystem to scope metrics related to the kvstore.
SubsystemNodes is the subsystem to scope metrics related to the node manager.
SubsystemTriggers is the subsystem to scope metrics related to the trigger package.

# Variables

APIInteractions is the total time taken to process an API call made to the cilium-agent.
BPFMapOps is the metric to measure the number of operations done to a bpf map.
BPFSyscallDuration is the metric for bpf syscalls duration.
ConntrackGCDuration the duration of the conntrack GC process in milliseconds.
ConntrackGCKeyFallbacks number of times that the conntrack key fallback was invalid.
ConntrackGCRuns is the number of times that the conntrack GC process was run.
ConntrackGCSize the number of entries in the conntrack table.
ControllerRuns is the number of times that a controller process runs.
ControllerRunsDuration the duration of the controller process in seconds.
DatapathErrors is the number of errors managing datapath components such as BPF maps.
DropBytes is the total dropped bytes, tagged by drop reason and direction(ingress/egress).
DropCount is the total drop requests, tagged by drop reason and direction(ingress/egress).
EndpointCount is a function used to collect this metric.
EndpointRegenerationCount is a count of the number of times any endpoint has been regenerated and success/fail outcome.
EndpointRegenerationTimeStats is the total time taken to regenerate endpoints, labeled by span name and status ("success" or "failure").
EndpointStateCount is the total count of the endpoints in various states.
ErrorsWarnings is the number of errors and warnings in cilium-agent instances.
EventTSAPI is the timestamp of docker events.
EventTSContainerd is the timestamp of docker events.
EventTSK8s is the timestamp of k8s events.
ForwardBytes is the total forwarded bytes, tagged by ingress/egress direction.
ForwardCount is the total forwarded packets, tagged by ingress/egress direction.
FQDNGarbageCollectorCleanedTotal is the number of domains cleaned by the GC job.
IdentityCount is the number of identities currently in use on the node.
IpamEvent is the number of IPAM events received labeled by action and datapath family type.
KubernetesAPICalls is the counter for all API calls made to kube-apiserver.
KubernetesAPIInteractions is the total time taken to process an API call made to the kube-apiserver.
KubernetesCNPStatusCompletion is the number of seconds it takes to complete a CNP status update.
KubernetesEventProcessed is the number of Kubernetes events processed labeled by scope, action and execution result.
KubernetesEventReceived is the number of Kubernetes events received labeled by scope, action, valid data and equalness.
KVStoreEventsQueueDuration records the duration in seconds of time received event was blocked before it could be queued.
KVStoreOperationsDuration records the duration of kvstore operations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PolicyCount is the number of policies loaded into the agent.
PolicyEndpointStatus is the number of endpoints with policy labeled by enforcement type.
PolicyImplementationDelay is a distribution of times taken from adding a policy (and incrementing the policy revision) to seeing it in the datapath per Endpoint.
PolicyImportErrors is a count of failed policy imports.
PolicyRegenerationCount is the total number of successful policy regenerations.
PolicyRegenerationTimeStats is the total time taken to generate policies.
PolicyRevision is the current policy revision number for this agent.
ProxyDenied is a count of all denied requests by policy by the proxy Deprecated: in favor of ProxyPolicyL7Total.
ProxyForwarded is a count of all forwarded requests by proxy Deprecated: in favor of ProxyPolicyL7Total.
ProxyParseErrors is a count of failed parse errors on proxy Deprecated: in favor of ProxyPolicyL7Total.
ProxyPolicyL7Total is a count of all l7 requests handled by proxy.
ProxyReceived is a count of all received requests by the proxy Deprecated: in favor of ProxyPolicyL7Total.
ProxyRedirects is the number of redirects labeled by protocol.
ProxyUpstreamTime is how long the upstream server took to reply labeled by error, protocol and span time.
ServicesCount number of services.
subprocess, labeled by Subsystem.
TriggerPolicyUpdateCallDuration measures the latency and call duration of policy update triggers.
TriggerPolicyUpdateFolds is the current level folding that is happening when running policy update triggers.
TriggerPolicyUpdateTotal is the metric to count total number of policy update triggers.

# Structs

APIEventTSHelper is intended to be a global middleware to track metrics around API calls.
No description provided by the author
LoggingHook is a hook for logrus which counts error and warning messages as a Prometheus metric.

# Interfaces

No description provided by the author
No description provided by the author