Project: Tetragon (Provisioning / Security & Compliance)
File: metrics.md

title: "Metrics" description: > This reference is autogenerated from the Tetragon Prometheus metrics registry. weight: 4 {{< comment >}} This page is autogenerated via `make metrics-doc` please do not edit directly. {{< /comment >}} Build information about tetragon | label | values | | -- | | | `commit` | `931b70f2c9878ba985ba6b589827bea17da6ec33` | | `go_version` | `go1.22.0` | | `modified` | `false` | | `time ` | `2022-05-13T15:54:45Z` | The size of received data events. | label | values | | -- | | | `op ` | `bad, ok` | The number of data events by type. For internal use only. | label | values | | -- | | | `event` | `Added, Appended, Bad, Matched, NotMatched, Received` | The total number of Tetragon errors. For internal use only. | label | values | | -- | | | `type ` | `eventfinalizeprocessinfofailed, eventmissingprocessinfo, handlererror, processcacheevicted, processcachemissonget, processcachemissonremove, processpidtid_mismatch` | The total number of Tetragon event cache accesses. For internal use only. The number of entries in the event cache. The total of errors encountered while fetching process exec information from the cache. | label | values | | -- | | | `error` | `nilprocesspid` | | `eventtype` | `PROCESSEXEC, PROCESSEXIT, PROCESSKPROBE, PROCESSLOADER, PROCESSTHROTTLE, PROCESSTRACEPOINT, PROCESSUPROBE, RATELIMITINFO` | The total of times we failed to fetch cached parent info for a given event type. | label | values | | -- | | | `eventtype` | `PROCESSEXEC, PROCESSEXIT, PROCESSKPROBE, PROCESSLOADER, PROCESSTHROTTLE, PROCESSTRACEPOINT, PROCESSUPROBE, RATELIMITINFO` | The total of times we failed to fetch cached pod info for a given event type. | label | values | | -- | | | `eventtype` | `PROCESSEXEC, PROCESSEXIT, PROCESSKPROBE, PROCESSLOADER, PROCESSTHROTTLE, PROCESSTRACEPOINT, PROCESSUPROBE, RATELIMITINFO` | The total of times we failed to fetch cached process info for a given event type. | label | values | | -- | | | `eventtype` | `PROCESSEXEC, PROCESSEXIT, PROCESSKPROBE, PROCESSLOADER, PROCESSTHROTTLE, PROCESSTRACEPOINT, PROCESSUPROBE, RATELIMITINFO` | The total number of retries for event caching per entry type. | label | values | | -- | | | `entrytype` | `parentinfo, podinfo, processinfo` | Number of bytes exported for events Total number of events exported Timestamp of the most recent event to be exported The total number of Tetragon flags. For internal use only. | label | values | | -- | | | `type ` | `auid, clone, errorArgs, errorCWD, errorCgroupID, errorCgroupKn, errorCgroupName, errorCgroupSubsys, errorCgroupSubsysCgrp, errorCgroups, errorFilename, errorPathResolutionCwd, execve, execveat, miss, nocwd, procFS, rootcwd, taskWalk, truncArgs, truncFilename` | The total number of failed attempts to merge a kprobe and kretprobe

| label | values | | -- | | | `currfn` | `examplekprobe` | | `curr_type` | `enter, exit` | | `prevfn` | `examplekprobe` | | `prev_type` | `enter, exit` | The total number of successful attempts to merge a kprobe and kretprobe event. The total number of pushed events for later merge. The total number of event handler errors. For internal use only. | label | values | | -- | | | `errortype` | `eventhandlerfailed, unknownopcode` | | `opcode` | `0, 11, 13, 14, 15, 23, 24, 25, 26, 5, 7` | The latency of handling messages in us. | label | values | | -- | | | `op ` | `11, 13, 14, 15, 23, 24, 25, 26, 5, 7` | Capacity of a BPF map. Expected to be constant. | label | values | | -- | | | `map ` | `execvemap, tgexecvejoinedinfo_map` | The total number of in-use entries per map. | label | values | | -- | | | `map ` | `execvemap, tgexecvejoinedinfo_map` | The number of errors per map. | label | values | | -- | | | `map ` | `execvemap, tgexecvejoinedinfo_map` | The total number of Tetragon events per type that are failed to sent from the kernel. | label | values | | -- | | | `msg_op` | `11, 13, 14, 15, 23, 24, 25, 26, 5, 7` | The total number of times we encounter a given message opcode. For internal use only. | label | values | | -- | | | `msg_op` | `11, 13, 14, 15, 23, 24, 25, 26, 5, 7` | The total number of events dropped because listener buffer was full The total number of operations when the container name was missing in the OCI hook Policy filter metrics. For internal use only. | label | values | | -- | | | `error` | `generic-error, pod-namespace-conflict` | | `op ` | `add, add-container, delete, update` | | `subsys` | `pod-handlers, rthooks` | The capacity of the process cache. Expected to be constant. The size of the process cache Process Loader event statistics. For internal use only. | label | values | | -- | | | `count` | `LoaderReceived, LoaderResolvedImm, LoaderResolvedRetry` | The total number of rate limit Tetragon drops The total number of errors when reading the Tetragon ringbuf. The total number of Tetragon ringbuf perf events lost. The total number of Tetragon ringbuf perf events received. The total number of Tetragon events ring buffer queue lost. The total number of Tetragon events ring buffer queue received. The number of loaded tracing policy by

| label | values | | -- | | | `state` | `disabled, enabled, error, load_error` | The total number of errors for a given watcher type. | label | values | | -- | | | `error` | `failedtoget_pod` | | `watcher` | ` k8s` | The total number of events for a given watcher type. | label | values | | -- | | | `watcher` | ` k8s` | A summary of the pause duration of garbage collection cycles. Number of goroutines that currently exist. Information about the Go environment. | label | values | | -- | | | `version` | `go1.22.0` | Number of bytes allocated and still in use. Total number of bytes allocated, even if freed. Number of bytes used by the profiling bucket hash table. Total number of frees. Number of bytes used for garbage collection system metadata. Number of heap bytes allocated and still in use. Number of heap bytes waiting to be used. Number of heap bytes that are in use. Number of allocated objects. Number of heap bytes released to OS. Number of heap bytes obtained from system. Number of seconds since 1970 of last garbage collection. Total number of pointer lookups. Total number of mallocs. Number of bytes in use by mcache structures. Number of bytes used for mcache structures obtained from system. Number of bytes in use by mspan structures. Number of bytes used for mspan structures obtained from system. Number of heap bytes when next garbage collection will take place. Number of bytes used for other system allocations. Number of bytes in use by the stack allocator. Number of bytes obtained from system for stack allocator. Number of bytes obtained from system. Number of OS threads created. Total user and system CPU time spent in seconds. Maximum number of open file descriptors. Number of open file descriptors. Resident memory size in bytes. Start time of the process since unix epoch in seconds. Virtual memory size in bytes. Maximum amount of virtual memory available in bytes. The total number of Tetragon events | label | values | | -- | | | `binary` | `example-binary` | | `namespace` | `example-namespace` | | `pod ` | `example-pod` | | `type ` | `PROCESSEXEC, PROCESSEXIT, PROCESSKPROBE, PROCESSLOADER, PROCESSTHROTTLE, PROCESSTRACEPOINT, PROCESSUPROBE, RATELIMIT_INFO` | | `workload` | `example-workload` | Policy events calls observed. | label | values | | -- | | | `binary` | `example-binary` | | `hook ` | `example_kprobe` | | `namespace` | `example-namespace` | | `pod ` | `example-pod` | | `policy` | `example-tracingpolicy` | | `workload` | `example-workload` | System calls observed. | label | values | | -- | | | `binary` | `example-binary` | | `namespace` | `example-namespace` | | `pod ` | `example-pod` | | `syscall` | `example_syscall` | | `workload` | `example-workload` |