api: extend TracingPolicyStatus with dedicated fields

Previously, enabled, filter_id and error were bundled into the info
string. We add new dedicated fields and make the new tetra also
retrocompatible with the old API missing those fields by parsing the
info string.

Signed-off-by: Mahe Tardy <[email protected]>

api/v1/README.md

@@ -1590,6 +1590,9 @@ Determins the behaviour of a field filter
 | namespace | [string](#string) |  | namespace is the namespace of the policy (or empty of the policy is global) |
 | info | [string](#string) |  | info is additional information about the policy |
 | sensors | [string](#string) | repeated | sensors loaded in the scope of this policy |
+| enabled | [bool](#bool) |  | indicating if the policy is enabled |
+| filter_id | [uint64](#uint64) |  | filter ID of the policy used for k8s filtering |
+| error | [string](#string) |  | potential error of the policy |
 
 
 

api/v1/tetragon/sensors.proto

@@ -40,7 +40,12 @@ message TracingPolicyStatus {
 	string info = 4;
 	// sensors loaded in the scope of this policy
 	repeated string sensors = 5;
-
+	// indicating if the policy is enabled
+	bool enabled = 6;
+	// filter ID of the policy used for k8s filtering
+	uint64 filter_id = 7;
+	// potential error of the policy
+	string error = 8;
 }
 
 message ListTracingPoliciesResponse {

cmd/tetra/tracingpolicy/tracingpolicy.go

@@ -144,7 +144,36 @@ func New() *cobra.Command {
 					}
 
 					sensors := strings.Join(pol.Sensors, ",")
-					cmd.Printf("%d %s (%s) %s %s\n", pol.Id, pol.Name, pol.Info, namespace, sensors)
+
+					// From v0.11 and before, enabled, filterID and error were
+					// bundled in a string. To have a retro-compatible tetra
+					// command, we scan the string. If the scan fails, it means
+					// something else might be in Info and we print it.
+					//
+					// we can drop the following block (and comment) when we
+					// feel tetra should support only version after v0.11
+					if pol.Info != "" {
+						var parsedEnabled bool
+						var parsedFilterID uint64
+						var parsedError string
+						var parsedName string
+						str := strings.NewReader(pol.Info)
+						_, err := fmt.Fscanf(str, "%253s enabled:%t filterID:%d error:%512s", &parsedName, &parsedEnabled, &parsedFilterID, &parsedError)
+						if err == nil {
+							pol.Enabled = parsedEnabled
+							pol.FilterId = parsedFilterID
+							pol.Error = parsedError
+							pol.Info = ""
+						}
+					}
+
+					cmd.Printf("[%d] %s enabled:%t filterID:%d namespace:%s sensors:%s\n", pol.Id, pol.Name, pol.Enabled, pol.FilterId, namespace, sensors)
+					if pol.Info != "" {
+						cmd.Printf("\tinfo: %s\n", pol.Info)
+					}
+					if pol.Error != "" && pol.Error != "<nil>" {
+						cmd.Printf("\terror: %s\n", pol.Error)
+					}
 				}
 			}
 

docs/content/en/docs/reference/grpc-api.md

@@ -931,6 +931,9 @@ Determins the behaviour of a field filter
 | namespace | [string](#string) |  | namespace is the namespace of the policy (or empty of the policy is global) |
 | info | [string](#string) |  | info is additional information about the policy |
 | sensors | [string](#string) | repeated | sensors loaded in the scope of this policy |
+| enabled | [bool](#bool) |  | indicating if the policy is enabled |
+| filter_id | [uint64](#uint64) |  | filter ID of the policy used for k8s filtering |
+| error | [string](#string) |  | potential error of the policy |
 
 <a name="tetragon-FineGuidanceSensors"></a>
 

pkg/sensors/handler.go

@@ -158,9 +158,11 @@ func (h *handler) listTracingPolicies(op *tracingPolicyList) error {
 		}
 
 		pol := tetragon.TracingPolicyStatus{
-			Id:   col.tracingpolicyID,
-			Name: name,
-			Info: fmt.Sprintf("%s enabled:%t filterID:%d error:%v", col.tracingpolicy.TpInfo(), col.enabled, col.policyfilterID, col.err),
+			Id:       col.tracingpolicyID,
+			Name:     name,
+			Enabled:  col.enabled,
+			FilterId: col.policyfilterID,
+			Error:    fmt.Sprint(col.err),
 		}
 
 		pol.Namespace = ""