feat(workloads): add intelligent workload support with dynamic flows and alert policy

Author: nr-ramapuram

pkg/testhelpers/helpers.go

@@ -52,6 +52,16 @@ func GetNonExistentIDs() (string, string) {
 	return "00000FF000F0FFFF000F0F0000FF0FF0000000F000F00F0FF000FFFFF0FF00F0", "00000HH000H0HHHH000H0H0000HH0HH0000000H000H00H0HH000HHHHH0HH00H0"
 }
 
+// GetTestEntityGUID returns the entity GUID for intelligent workload integration tests from the environment.
+func GetTestEntityGUID() (string, error) {
+	return getEnvString("NEW_RELIC_TEST_ENTITY_GUID")
+}
+
+// GetTestTransactionName returns the transaction name for intelligent workload integration tests from the environment.
+func GetTestTransactionName() (string, error) {
+	return getEnvString("NEW_RELIC_TEST_TRANSACTION_NAME")
+}
+
 // getEnvInt helper to DRY up the other env get calls for integers
 func getEnvInt(name string) (int, error) {
 	if name == "" {
@@ -72,6 +82,20 @@ func getEnvInt(name string) (int, error) {
 	return n, nil
 }
 
+// getEnvString helper to DRY up the other env get calls for strings
+func getEnvString(name string) (string, error) {
+	if name == "" {
+		return "", fmt.Errorf("failed to get environment value, no name specified")
+	}
+
+	value := os.Getenv(name)
+	if value == "" {
+		return "", fmt.Errorf("failed to get environment value due to undefined environment variable %s", name)
+	}
+
+	return value, nil
+}
+
 // Use this method to generate a random name to be used in integration tests
 // for whatever resource you might be trying to create and/or test.
 // If no random character count is provided, the default behavior is to append 5 random

pkg/workloads/example_basic_test.go

@@ -65,3 +65,68 @@ func Example_basic() {
 		log.Fatal("error deleting workload: ", err)
 	}
 }
+
+func Example_intelligentWorkload() {
+	// Initialize the client configuration. A Personal API key is required to
+	// communicate with the backend API.
+	cfg := config.New()
+	cfg.PersonalAPIKey = os.Getenv("NEW_RELIC_API_KEY")
+
+	// Initialize the client.
+	client := New(cfg)
+
+	accountID := 12345678
+	entityGUID := common.EntityGUID("MjUwODy1OXxOUjF8V097S0xPQ3R8ODcz")
+
+	// Create a new intelligent workload using dynamic flows.
+	// New Relic auto-discovers related entities via Transaction 360 distributed tracing.
+	// If set alongside entityGuids or entitySearchQueries, dynamicFlows takes precedence
+	// and others will be ignored.
+	createInput := WorkloadCreateInput{
+		Name: "Example intelligent workload",
+		ScopeAccounts: &WorkloadScopeAccountsInput{
+			AccountIDs: []int{accountID},
+		},
+		DynamicFlows: []WorkloadDynamicFlowInput{
+			{
+				EntityGUID:      entityGUID,
+				TransactionName: "WebTransaction/Action/index",
+			},
+		},
+		StatusConfig: &WorkloadStatusConfigInput{
+			AlertPolicy: &WorkloadAlertPolicyInput{
+				Enabled: true,
+			},
+		},
+	}
+
+	workload, err := client.WorkloadCreate(accountID, createInput)
+	if err != nil {
+		log.Fatal("error creating intelligent workload: ", err)
+	}
+
+	// Update an existing intelligent workload.
+	updated, err := client.WorkloadUpdate(workload.GUID, WorkloadUpdateInput{
+		Name: "Example intelligent workload - updated",
+		DynamicFlows: []WorkloadUpdateDynamicFlowInput{
+			{
+				EntityGUID:      entityGUID,
+				TransactionName: "WebTransaction/Action/index",
+			},
+		},
+		StatusConfig: &WorkloadUpdateStatusConfigInput{
+			AlertPolicy: &WorkloadUpdateAlertPolicyInput{
+				Enabled: false,
+			},
+		},
+	})
+	if err != nil {
+		log.Fatal("error updating intelligent workload: ", err)
+	}
+
+	// Delete an existing intelligent workload.
+	_, err = client.WorkloadDelete(updated.GUID)
+	if err != nil {
+		log.Fatal("error deleting intelligent workload: ", err)
+	}
+}

pkg/workloads/types.go

@@ -191,6 +191,18 @@ type WorkloadAutomaticStatus struct {
 	Rules []WorkloadRegularRule `json:"rules"`
 }
 
+// WorkloadAlertPolicy - The alert policy status configuration (response type).
+type WorkloadAlertPolicy struct {
+	// Whether the alert policy status configuration is enabled or not.
+	Enabled bool `json:"enabled"`
+}
+
+// WorkloadAlertPolicyInput - The input object used to represent the alert policy status configuration for create.
+type WorkloadAlertPolicyInput struct {
+	// Whether the alert policy status configuration is enabled or not.
+	Enabled bool `json:"enabled"`
+}
+
 // WorkloadAutomaticStatusInput - An input object used to represent an automatic status configuration. If not provided, a status configuration will be created by default.
 type WorkloadAutomaticStatusInput struct {
 	// Whether the automatic status configuration is enabled or not.
@@ -231,6 +243,8 @@ type WorkloadCollection struct {
 	Status WorkloadWorkloadStatus `json:"status"`
 	// The configuration that defines how the status of the workload is calculated.
 	StatusConfig WorkloadStatusConfig `json:"statusConfig,omitempty"`
+	// A list of dynamic flow entries for an intelligent workload.
+	DynamicFlows []WorkloadDynamicFlow `json:"dynamicFlows,omitempty"`
 	// The moment when the object was last updated, represented in milliseconds since the Unix epoch.
 	UpdatedAt *nrtime.EpochMilliseconds `json:"updatedAt,omitempty"`
 	// The user who last updated the workload.
@@ -241,6 +255,8 @@ type WorkloadCollection struct {
 type WorkloadCreateInput struct {
 	// Relevant information about the workload.
 	Description string `json:"description,omitempty"`
+	// A list of dynamic flow entries for an intelligent workload. When provided alongside entityGuids or entitySearchQueries, dynamicFlows takes precedence and others will be ignored.
+	DynamicFlows []WorkloadDynamicFlowInput `json:"dynamicFlows,omitempty"`
 	// A list of entity GUIDs composing the workload.
 	EntityGUIDs []common.EntityGUID `json:"entityGuids"`
 	// A list of entity search queries used to retrieve the entities that compose the workload.
@@ -259,6 +275,24 @@ type WorkloadDuplicateInput struct {
 	Name string `json:"name,omitempty"`
 }
 
+// WorkloadDynamicFlow - A dynamic flow entry in an intelligent workload (response type).
+type WorkloadDynamicFlow struct {
+	// The unique entity identifier of the dynamic flow entry.
+	EntityGUID common.EntityGUID `json:"entityGuid"`
+	// The unique identifier of the dynamic flow entry.
+	ID int `json:"id"`
+	// The transaction name associated with the dynamic flow entry.
+	TransactionName string `json:"transactionName"`
+}
+
+// WorkloadDynamicFlowInput - The input object used to represent a dynamic flow entry for create.
+type WorkloadDynamicFlowInput struct {
+	// The unique entity identifier of the dynamic flow entry.
+	EntityGUID common.EntityGUID `json:"entityGuid"`
+	// The transaction name associated with the dynamic flow entry.
+	TransactionName string `json:"transactionName"`
+}
+
 // WorkloadEntityRef - A reference to a New Relic entity.
 type WorkloadEntityRef struct {
 	// The unique entity identifier in New Relic.
@@ -459,6 +493,8 @@ type WorkloadStatus struct {
 
 // WorkloadStatusConfig - The configuration that defines how the status of the workload is calculated.
 type WorkloadStatusConfig struct {
+	// An alert policy status configuration for intelligent workloads.
+	AlertPolicy WorkloadAlertPolicy `json:"alertPolicy,omitempty"`
 	// An automatic status configuration.
 	Automatic WorkloadAutomaticStatus `json:"automatic,omitempty"`
 	// A list of static status configurations.
@@ -467,6 +503,8 @@ type WorkloadStatusConfig struct {
 
 // WorkloadStatusConfigInput - The input object used to provide the configuration that defines how the status of the workload is calculated.
 type WorkloadStatusConfigInput struct {
+	// An alert policy status configuration for intelligent workloads.
+	AlertPolicy *WorkloadAlertPolicyInput `json:"alertPolicy,omitempty"`
 	// An input object used to represent an automatic status configuration.
 	Automatic *WorkloadAutomaticStatusInput `json:"automatic,omitempty"`
 	// A list of static status configurations. You can only configure one static status for a workload.
@@ -483,6 +521,12 @@ type WorkloadStatusResult struct {
 
 func (x *WorkloadStatusResult) ImplementsWorkloadStatusResult() {}
 
+// WorkloadUpdateAlertPolicyInput - The input object used to represent the alert policy status configuration for update.
+type WorkloadUpdateAlertPolicyInput struct {
+	// Whether the alert policy status configuration is enabled or not.
+	Enabled bool `json:"enabled"`
+}
+
 // WorkloadUpdateAutomaticStatusInput - An input object used to represent an automatic status configuration.
 type WorkloadUpdateAutomaticStatusInput struct {
 	// Whether the automatic status configuration is enabled or not.
@@ -493,6 +537,16 @@ type WorkloadUpdateAutomaticStatusInput struct {
 	Rules []WorkloadUpdateRegularRuleInput `json:"rules,omitempty"`
 }
 
+// WorkloadUpdateDynamicFlowInput - The input object used to represent a dynamic flow entry for update.
+type WorkloadUpdateDynamicFlowInput struct {
+	// The unique entity identifier of the dynamic flow entry.
+	EntityGUID common.EntityGUID `json:"entityGuid"`
+	// The unique identifier of the dynamic flow entry to be updated. If not provided, a new entry is created.
+	ID int `json:"id,omitempty"`
+	// The transaction name associated with the dynamic flow entry.
+	TransactionName string `json:"transactionName"`
+}
+
 // WorkloadUpdateCollectionEntitySearchQueryInput - The input object used to represent the entity search query to be updated.
 type WorkloadUpdateCollectionEntitySearchQueryInput struct {
 	// The unique identifier of the entity search query to be updated. If not provided, a new entity search query is created.
@@ -505,6 +559,8 @@ type WorkloadUpdateCollectionEntitySearchQueryInput struct {
 type WorkloadUpdateInput struct {
 	// Relevant information about the workload.
 	Description string `json:"description,omitempty"`
+	// A list of dynamic flow entries for an intelligent workload. When provided alongside entityGuids or entitySearchQueries, dynamicFlows takes precedence and others will be ignored.
+	DynamicFlows []WorkloadUpdateDynamicFlowInput `json:"dynamicFlows,omitempty"`
 	// A list of entity GUIDs composing the workload.
 	EntityGUIDs []common.EntityGUID `json:"entityGuids"`
 	// A list of entity search queries used to retrieve the groups of entities that compose the workload.
@@ -545,6 +601,8 @@ type WorkloadUpdateStaticStatusInput struct {
 
 // WorkloadUpdateStatusConfigInput - The input object used to provide the configuration that defines how the status of the workload is calculated.
 type WorkloadUpdateStatusConfigInput struct {
+	// An alert policy status configuration for intelligent workloads.
+	AlertPolicy *WorkloadUpdateAlertPolicyInput `json:"alertPolicy,omitempty"`
 	// An input object used to represent an automatic status configuration.
 	Automatic *WorkloadUpdateAutomaticStatusInput `json:"automatic,omitempty"`
 	// A list of static status configurations. You can only configure one static status for a workload.