feat: support a custom base URL for the new relic provider (#1053)

Signed-off-by: Fischer Jemison <fjemison@newrelic.com>
argoproj · Apr 1, 2021 · 7509478 · 7509478
1 parent e803db0
commit 7509478
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 1 deletion.
diff --git a/docs/analysis/newrelic.md b/docs/analysis/newrelic.md
@@ -38,3 +38,19 @@ data:
   account-id: <newrelic-account-id>
   region: "us" # optional, defaults to "us" if not set. Only set to "eu" if you use EU New Relic
 ```
+
+To use the New Relic metric provider from behind a proxy, provide a `base-url-rest` key pointing to the base URL of the New Relic REST API for your proxy, and a `base-url-nerdgraph` key pointing to the base URL for NerdGraph for your proxy:
+
+```yaml
+apiVersion: v1
+kind: Secret
+metadata:
+  name: newrelic
+type: Opaque
+data:
+  personal-api-key: <newrelic-personal-api-key>
+  account-id: <newrelic-account-id>
+  region: "us" # optional, defaults to "us" if not set. Only set to "eu" if you use EU New Relic
+  base-url-rest: <your-base-url>
+  base-url-nerdgraph: <your-base-url>
+```
diff --git a/metricproviders/newrelic/newrelic.go b/metricproviders/newrelic/newrelic.go
@@ -152,13 +152,27 @@ func NewNewRelicAPIClient(metric v1alpha1.Metric, kubeclientset kubernetes.Inter
 
 	apiKey := string(secret.Data["personal-api-key"])
 	accountID := string(secret.Data["account-id"])
+
+	newrelicOptions := []newrelic.ConfigOption{newrelic.ConfigPersonalAPIKey(apiKey), newrelic.ConfigUserAgent(userAgent)}
+
 	region := "us"
 	if _, ok := secret.Data["region"]; ok {
 		region = string(secret.Data["region"])
 	}
+	newrelicOptions = append(newrelicOptions, newrelic.ConfigRegion(region))
+
+	// base URL for the new relic REST API
+	if _, ok := secret.Data["base-url-rest"]; ok {
+		newrelicOptions = append(newrelicOptions, newrelic.ConfigBaseURL(string(secret.Data["base-url-rest"])))
+	}
+
+	// base URL for the nerdgraph (graphQL) API
+	if _, ok := secret.Data["base-url-nerdgraph"]; ok {
+		newrelicOptions = append(newrelicOptions, newrelic.ConfigNerdGraphBaseURL(string(secret.Data["base-url-nerdgraph"])))
+	}
 
 	if apiKey != "" && accountID != "" {
-		nrClient, err := newrelic.New(newrelic.ConfigPersonalAPIKey(apiKey), newrelic.ConfigRegion(region), newrelic.ConfigUserAgent(userAgent))
+		nrClient, err := newrelic.New(newrelicOptions...)
 		if err != nil {
 			return nil, err
 		}

diff --git a/metricproviders/newrelic/newrelic_test.go b/metricproviders/newrelic/newrelic_test.go
@@ -345,6 +345,18 @@ func TestNewNewRelicAPIClient(t *testing.T) {
 		// client defaults to US when not set or set to something incorrect, does not error
 		assert.Nil(t, err)
 	})
+
+	t.Run("when a base-url is set", func(t *testing.T) {
+		tokenSecret.Data = map[string][]byte{
+			"personal-api-key":   []byte("ABCDEFG01234"),
+			"account-id":         []byte("12345"),
+			"base-url-rest":      []byte("example.com/api/v2"),
+			"base-url-nerdgraph": []byte("example.com/query"),
+		}
+		_, err := NewNewRelicAPIClient(metric, fakeClient)
+
+		assert.Nil(t, err)
+	})
 	t.Run("with api token or account id missing missing", func(t *testing.T) {
 		tokenSecret.Data = map[string][]byte{
 			"personal-api-key": []byte("ABCDEFG01234"),