From 8e5de18ca0b23f0de0cde193060547f2d78b110b Mon Sep 17 00:00:00 2001
From: Kornilios Kourtis <kornilios@isovalent.com>
Date: Mon, 9 Dec 2024 15:14:25 +0100
Subject: [PATCH] tetra: add command to dump bpf errmetrics

To test this, I changed MapEntries to 4 in pkg/cgtracker and built and
started tetragon.

Then:
 # mkdir /sys/fs/cgroup/pizza
 # ./tetra cgtracker add /sys/fs/cgroup/pizza /sys/fs/cgroup/pizza
 # sudo mkdir /sys/fs/cgroup/pizza/{a,b,c,d,e,f,g,h,i,j,k}
 # sudo ./tetra debug dump errmetrics
Location                        Error       Count
bpf/cgroup/bpf_cgtracker.c:64   E2BIG (7)   8

Signed-off-by: Kornilios Kourtis <kornilios@isovalent.com>
---
 cmd/tetra/debug/dump.go | 59 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)

diff --git a/cmd/tetra/debug/dump.go b/cmd/tetra/debug/dump.go
index e10ae00bd43..da0484a1b6d 100644
--- a/cmd/tetra/debug/dump.go
+++ b/cmd/tetra/debug/dump.go
@@ -4,15 +4,19 @@
 package debug
 
 import (
+	"encoding/json"
 	"fmt"
+	"io"
 	"path/filepath"
 	"strconv"
 	"strings"
+	"text/tabwriter"
 
 	"github.com/cilium/ebpf"
 	"github.com/cilium/tetragon/api/v1/tetragon"
 	"github.com/cilium/tetragon/cmd/tetra/common"
 	"github.com/cilium/tetragon/pkg/defaults"
+	"github.com/cilium/tetragon/pkg/errmetrics"
 	"github.com/cilium/tetragon/pkg/logger"
 	"github.com/cilium/tetragon/pkg/policyfilter"
 	"github.com/cilium/tetragon/pkg/sensors/base"
@@ -40,6 +44,7 @@ func NewDumpCommand() *cobra.Command {
 		execveMapCmd(),
 		policyfilterCmd(),
 		dumpProcessCache(),
+		bpfErrMetricsCmd(),
 	)
 
 	return ret
@@ -219,3 +224,57 @@ func NamespaceState(fname string) error {
 
 	return nil
 }
+
+func bpfErrMetricsCmd() *cobra.Command {
+
+	mapFname := filepath.Join(defaults.DefaultMapRoot, defaults.DefaultMapPrefix, errmetrics.MapName)
+	var output string
+
+	ret := &cobra.Command{
+		Use:   "errmetrics",
+		Short: "dump BPF error metrics",
+		Args:  cobra.ExactArgs(0),
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			return ErrMetrics(mapFname, cmd.OutOrStdout(), output)
+		},
+	}
+
+	flags := ret.Flags()
+	flags.StringVar(&mapFname, "map-fname", mapFname, "policyfilter map filename")
+	flags.StringVarP(&output, "output", "o", "tab", "Output format. One of tab or json.")
+
+	return ret
+}
+
+func ErrMetrics(fname string, out io.Writer, output string) error {
+	m, err := errmetrics.OpenMap(fname)
+	if err != nil {
+		return fmt.Errorf("failed to open errmetrics map: %w", err)
+	}
+	defer m.Close()
+
+	ret, err := m.Dump()
+	if err != nil {
+		return fmt.Errorf("failed to dump errmetrics map: %w", err)
+	}
+
+	switch output {
+	case "json":
+		jsonOut, err := json.Marshal(ret)
+		if err != nil {
+			return fmt.Errorf("failed to marshal output to JSON: %w", err)
+		}
+		out.Write(jsonOut)
+	case "tab":
+		w := tabwriter.NewWriter(out, 0, 0, 3, ' ', 0)
+		fmt.Fprintln(w, "Location\tError\tCount")
+		for _, entry := range ret {
+			fmt.Fprintf(w, "%s\t%s\t%d\n", entry.Location, entry.Error, entry.Count)
+		}
+		w.Flush()
+	default:
+		return fmt.Errorf("unknown output format: %s", output)
+	}
+
+	return nil
+}