Skip to main content

Plugins

Each metric is associated with a Plugin. Associated metrics are linked below. See Metrics Configuration for info on configuration.

To run Retina without any plugins, the CAP_BPF capability (since Linux 5.8) is required for memory locking and for loading/using BPF programs. This capability is mandatory. If you're using any plugins, ensure that the necessary capabilities for those plugins are also added. If a plugin requires CAP_SYS_ADMIN, you can substitute it for CAP_BPF.

NameDescriptionMetrics in Basic ModeMetrics in Advanced ModeDevelopment Guide
packetforward (Linux)Counts number of packets/bytes passing through the eth0 interface of a Node, along with the direction of the packets.Basic ModeSame metrics as Basic modeDev Guide
dropreason (Linux)Counts number of packets/bytes dropped on a Node, along with the direction and reason for drop.Basic ModeAdvanced ModeDev Guide
linuxutil (Linux)Gathers TCP/UDP statistics and network interface statistics from the netstats and ethtool Node utilities (respectively).Basic ModeSame metrics as Basic modeDev Guide
dns (Linux)Counts DNS requests/responses by query, including error codes, response IPs, and other metadata.Basic ModeAdvanced ModeDev Guide
hnstats (Windows)Gathers TCP statistics and counts number of packets/bytes forwarded or dropped in HNS and VFP.Basic ModeSame metrics as Basic modeDev Guide
packetparser (Linux)Captures TCP and UDP packets traveling to and from pods and nodes.No basic metricsAdvanced ModeDev Guide
cilium (Linux)Collect agent and perf events from cilium via monitor1_2 socket and process flows in our hubble observerMetricsSame metrics as Basic modeDev Guide