feat: Manage network zones configuration with monaco (#1333)

Author: warber

cmd/monaco/integrationtest/v2/test-resources/integration-all-configs/project/network-zone/config.yaml

@@ -0,0 +1,16 @@
+configs:
+- id: test-zone
+  config:
+    name: test-zone
+    template: test-zone.json
+    skip: false
+  type:
+    api: network-zone
+- id: test-zone-2
+  config:
+    name: test-zone-2
+    template: test-zone-2.json
+    skip: false
+  type:
+    api: network-zone
+

cmd/monaco/integrationtest/v2/test-resources/integration-all-configs/project/network-zone/test-zone-2.json

@@ -0,0 +1,5 @@
+{
+    "alternativeZones": [],
+    "description": "This is a second test zone",
+    "fallbackMode": "ANY_ACTIVE_GATE"
+}

cmd/monaco/integrationtest/v2/test-resources/integration-all-configs/project/network-zone/test-zone.json

@@ -0,0 +1,9 @@
+{
+  "alternativeZones": [],
+  "description": "This is a test zone",
+  "fallbackMode": "ANY_ACTIVE_GATE",
+  "numOfConfiguredActiveGates": 0,
+  "numOfConfiguredOneAgents": 0,
+  "numOfOneAgentsFromOtherZones": 0,
+  "numOfOneAgentsUsing": 0
+}

pkg/api/api.go

@@ -36,6 +36,9 @@ type API struct {
 	//
 	// Those configs include all configs handling credentials, as well as the extension-API.
 	SkipDownload bool
+	// TweakResponseFunc can be optionally registered to add custom code that changes the
+	// payload of the downloaded api content (e.g. to exclude unwanted/unnecessary fields)
+	TweakResponseFunc func(map[string]any)
 }
 
 // CreateURL creates final URL for given environmentUrl/domain

pkg/api/endpoints.go

@@ -25,6 +25,17 @@ var configEndpoints = []API{
 		DeprecatedBy:                 "builtin:alerting.profile",
 		NonUniqueName:                true,
 	},
+	{
+		ID:                           "network-zone",
+		URLPath:                      "/api/v2/networkZones",
+		PropertyNameOfGetAllResponse: "networkZones",
+		TweakResponseFunc: func(m map[string]any) {
+			delete(m, "numOfOneAgentsUsing")
+			delete(m, "numOfConfiguredOneAgents")
+			delete(m, "numOfOneAgentsFromOtherZones")
+			delete(m, "numOfConfiguredActiveGates")
+		},
+	},
 	{
 		ID:                           "management-zone",
 		URLPath:                      "/api/config/v1/managementZones",

pkg/client/dtclient/config_client.go

@@ -47,6 +47,12 @@ func (d *DynatraceClient) upsertDynatraceObject(ctx context.Context, theApi api.
 			}
 		}
 
+		// The network-zone API doesn't have a POST endpoint, hence, we need to treat it as an update operation
+		// per default
+		if theApi.ID == "network-zone" {
+			existingObjectID = objectName
+		}
+
 		// The calculated-metrics-log API doesn't have a POST endpoint, to create a new log metric we need to use PUT which
 		// requires a metric key for which we can just take the objectName
 		if theApi.ID == "calculated-metrics-log" && existingObjectID == "" {

pkg/download/classic/downloader.go

@@ -164,6 +164,10 @@ func (d *Downloader) downloadConfigsOfAPI(api api.API, values []dtclient.Value,
 		go func() {
 			defer wg.Done()
 			downloadedJson, err := d.downloadAndUnmarshalConfig(api, value)
+			if api.TweakResponseFunc != nil {
+				api.TweakResponseFunc(downloadedJson)
+			}
+
 			if err != nil {
 				log.WithFields(field.Type(api.ID), field.F("value", value), field.Error(err)).Error("Error fetching config '%v' in api '%v': %v", value.Id, api.ID, err)
 				return

pkg/download/classic/filter.go

@@ -74,4 +74,9 @@ var apiContentFilters = map[string]ContentFilter{
 			return strings.HasPrefix(value.Id, "dynatrace.") || strings.HasPrefix(value.Id, "ruxit.")
 		},
 	},
+	"network-zone": {
+		ShouldBeSkippedPreDownload: func(value dtclient.Value) bool {
+			return value.Id == "default"
+		},
+	},
 }

pkg/download/classic/filter_test.go

@@ -145,4 +145,10 @@ func TestShouldConfigBeSkipped(t *testing.T) {
 			Id: "test.something",
 		}))
 	})
+
+	t.Run("default network zone - should be skipped", func(t *testing.T) {
+		assert.True(t, apiContentFilters["network-zone"].ShouldBeSkippedPreDownload(dtclient.Value{
+			Id: "default",
+		}))
+	})
 }