Add additional_parameters to diagnostics action (#3333)

Add an optional parameter to the RequestDiagnostics action. This parameter is a list of strings (enum) that has a single value "CPU". If this parameter is specified, the agent should collect a CPU trace.

Author: michel-laterman

changelog/fragments/1710149156-Add-additional_parameters-to-diagnostics-actions.yaml

@@ -0,0 +1,32 @@
+# Kind can be one of:
+# - breaking-change: a change to previously-documented behavior
+# - deprecation: functionality that is being removed in a later release
+# - bug-fix: fixes a problem in a previous version
+# - enhancement: extends functionality but does not break or fix existing behavior
+# - feature: new functionality
+# - known-issue: problems that we are aware of in a given version
+# - security: impacts on the security of a product or a user’s deployment.
+# - upgrade: important information for someone upgrading from a prior version
+# - other: does not fit into any of the other categories
+kind: enchancement
+
+# Change summary; a 80ish characters long description of the change.
+summary: Add additional_parameters to diagnostics actions
+
+# Long description; in case the summary is not enough to describe the change
+# this field accommodate a description without length limits.
+# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment.
+#description:
+
+# Affected component; a word indicating the component this changeset affects.
+component:
+
+# PR URL; optional; the PR number that added the changeset.
+# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
+# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
+# Please provide it if you are adding a fragment for a different PR.
+pr: 3333
+
+# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
+# If not present is automatically filled by the tooling with the issue linked to the PR number.
+#issue: https://github.com/owner/repo/1234

internal/pkg/api/handleCheckin.go

@@ -707,7 +707,20 @@ func convertActionData(aType ActionType, raw json.RawMessage) (ad Action_Data, e
 		}
 		err = ad.FromActionUpgrade(d)
 		return
-	case REQUESTDIAGNOSTICS, UNENROLL: // Action types with no data
+	case REQUESTDIAGNOSTICS:
+		d := ActionRequestDiagnostics{}
+		// NOTE: action data was added to diagnostics actions in #3333
+		// fleet ui creates actions without a data attribute and fleet-server needs to be backwards compatible with these actions.
+		if raw == nil {
+			return
+		}
+		err = json.Unmarshal(raw, &d)
+		if err != nil {
+			return
+		}
+		err = ad.FromActionRequestDiagnostics(d)
+		return
+	case UNENROLL: // Action types with no data
 		return ad, nil
 	default:
 		return ad, fmt.Errorf("data conversion unsupported action type: %s", aType)

internal/pkg/api/handleCheckin_test.go

@@ -89,6 +89,18 @@ func TestConvertActionData(t *testing.T) {
 		aType:  REQUESTDIAGNOSTICS,
 		expect: Action_Data{},
 		hasErr: false,
+	}, {
+		name:   "request diagnostics action empty data",
+		aType:  REQUESTDIAGNOSTICS,
+		raw:    json.RawMessage(`{}`),
+		expect: Action_Data{json.RawMessage(`{}`)},
+		hasErr: false,
+	}, {
+		name:   "request diagnostics with additional cpu metric",
+		aType:  REQUESTDIAGNOSTICS,
+		raw:    json.RawMessage(`{"additional_metrics": ["CPU"]}`),
+		expect: Action_Data{json.RawMessage(`{"additional_metrics":["CPU"]}`)},
+		hasErr: false,
 	}, {
 		name:   "unenroll action",
 		aType:  UNENROLL,
@@ -126,44 +138,50 @@ func TestConvertActions(t *testing.T) {
 		token:   "",
 	}, {
 		name:    "single action",
-		actions: []model.Action{{ActionID: "1234", Type: "REQUEST_DIAGNOSTICS"}},
+		actions: []model.Action{{ActionID: "1234", Type: "REQUEST_DIAGNOSTICS", Data: json.RawMessage(`{}`)}},
 		resp: []Action{{
 			AgentId: "agent-id",
 			Id:      "1234",
 			Type:    REQUESTDIAGNOSTICS,
+			Data:    Action_Data{json.RawMessage(`{}`)},
 		}},
 		token: "",
 	}, {
 		name:    "single action signed",
-		actions: []model.Action{{ActionID: "1234", Signed: &model.Signed{Data: "eyJAdGltZXN0YW==", Signature: "U6NOg4ssxpFV="}, Type: "REQUEST_DIAGNOSTICS"}},
+		actions: []model.Action{{ActionID: "1234", Signed: &model.Signed{Data: "eyJAdGltZXN0YW==", Signature: "U6NOg4ssxpFV="}, Type: "REQUEST_DIAGNOSTICS", Data: json.RawMessage(`{}`)}},
 		resp: []Action{{
 			AgentId: "agent-id",
 			Id:      "1234",
 			Type:    REQUESTDIAGNOSTICS,
 			Signed:  &ActionSignature{Data: "eyJAdGltZXN0YW==", Signature: "U6NOg4ssxpFV="},
+			Data:    Action_Data{json.RawMessage(`{}`)},
 		}},
 		token: "",
 	}, {name: "multiple actions",
 		actions: []model.Action{
 			{
 				ActionID: "1234",
 				Type:     "REQUEST_DIAGNOSTICS",
+				Data:     json.RawMessage(`{}`),
 			},
 			{
 				ActionID: "5678",
 				Type:     "REQUEST_DIAGNOSTICS",
+				Data:     json.RawMessage(`{}`),
 				Signed:   &model.Signed{Data: "eyJAdGltZXN0YX==", Signature: "U6NOg4ssxpFQ="},
 			},
 		},
 		resp: []Action{{
 			AgentId: "agent-id",
 			Id:      "1234",
 			Type:    REQUESTDIAGNOSTICS,
+			Data:    Action_Data{json.RawMessage(`{}`)},
 		}, {
 			AgentId: "agent-id",
 			Id:      "5678",
 			Signed:  &ActionSignature{Data: "eyJAdGltZXN0YX==", Signature: "U6NOg4ssxpFQ="},
 			Type:    REQUESTDIAGNOSTICS,
+			Data:    Action_Data{json.RawMessage(`{}`)},
 		}},
 		token: "",
 	}}

internal/pkg/api/openapi.gen.go

@@ -286,14 +286,14 @@ components:
         download_rate:
           description: The artifact download rate as bytes per second.
           type: number
-          format: double 
+          format: double
         retry_error_msg:
           description: The error message that is a result of a retryable upgrade download failure.
-          type: string 
+          type: string
         retry_until:
           description: The RFC3339 timestamp of the deadline the upgrade download is retried until.
           type: string
-          format: date-time  
+          format: date-time
     upgrade_metadata_failed:
       description: Upgrade metadata for an upgrade that has failed.
       required:
@@ -549,7 +549,14 @@ components:
       # unenroll actions have no `data` attribute
     actionRequestDiagnostics:
       description: The REQUEST_DIAGNOSTICS action data.
-      # diagnostics actions have no `data` attribute
+      properties:
+        additional_metrics:
+          description: list optional additional metrics.
+          type: array
+          items:
+            type: string
+            enum:
+              - CPU
     actionPolicyReassign:
       description: The POLICY_REASSIGN action data.
       type: object