Merge pull request #17 from chr15murray/main

Add support for keepUrlTag
grafana · Mar 30, 2022 · 0751e79 · 0751e79
2 parents d8c2b37 + 4127047
commit 0751e79
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 0 deletions.
diff --git a/pkg/remotewrite/config.go b/pkg/remotewrite/config.go
@@ -38,6 +38,7 @@ type Config struct {
 
 	KeepTags    null.Bool `json:"keepTags" envconfig:"K6_KEEP_TAGS"`
 	KeepNameTag null.Bool `json:"keepNameTag" envconfig:"K6_KEEP_NAME_TAG"`
+	KeepUrlTag  null.Bool `json:"keepUrlTag" envconfig:"K6_KEEP_URL_TAG"`
 }
 
 func NewConfig() Config {
@@ -51,6 +52,7 @@ func NewConfig() Config {
 		FlushPeriod:           types.NullDurationFrom(defaultFlushPeriod),
 		KeepTags:              null.BoolFrom(true),
 		KeepNameTag:           null.BoolFrom(false),
+		KeepUrlTag:            null.BoolFrom(true),
 		Headers:               make(map[string]string),
 	}
 }
@@ -131,6 +133,10 @@ func (base Config) Apply(applied Config) Config {
 		base.KeepNameTag = applied.KeepNameTag
 	}
 
+	if applied.KeepUrlTag.Valid {
+		base.KeepUrlTag = applied.KeepUrlTag
+	}
+
 	if len(applied.Headers) > 0 {
 		for k, v := range applied.Headers {
 			base.Headers[k] = v
@@ -186,6 +192,10 @@ func ParseArg(arg string) (Config, error) {
 		c.KeepNameTag = null.BoolFrom(v)
 	}
 
+	if v, ok := params["keepUrlTag"].(bool); ok {
+		c.KeepUrlTag = null.BoolFrom(v)
+	}
+
 	c.Headers = make(map[string]string)
 	if v, ok := params["headers"].(map[string]interface{}); ok {
 		for k, v := range v {
@@ -284,6 +294,14 @@ func GetConsolidatedConfig(jsonRawConf json.RawMessage, env map[string]string, a
 		}
 	}
 
+	if b, err := getEnvBool(env, "K6_KEEP_URL_TAG"); err != nil {
+		return result, err
+	} else {
+		if b.Valid {
+			result.KeepUrlTag = b
+		}
+	}
+
 	envHeaders := getEnvMap(env, "K6_PROMETHEUS_HEADERS_")
 	for k, v := range envHeaders {
 		result.Headers[k] = v

diff --git a/pkg/remotewrite/config_test.go b/pkg/remotewrite/config_test.go
@@ -117,6 +117,7 @@ func TestConstructRemoteConfig(t *testing.T) {
 				FlushPeriod:           types.NullDurationFrom(defaultFlushPeriod),
 				KeepTags:              null.BoolFrom(true),
 				KeepNameTag:           null.BoolFrom(false),
+				KeepUrlTag:            null.BoolFrom(true),
 				Headers:               make(map[string]string),
 			},
 			errString: "",
@@ -146,6 +147,7 @@ func TestConstructRemoteConfig(t *testing.T) {
 				FlushPeriod:           types.NullDurationFrom(defaultFlushPeriod),
 				KeepTags:              null.BoolFrom(true),
 				KeepNameTag:           null.BoolFrom(false),
+				KeepUrlTag:            null.BoolFrom(true),
 				Headers:               make(map[string]string),
 			},
 			errString: "",
@@ -194,6 +196,7 @@ func TestConstructRemoteConfig(t *testing.T) {
 				FlushPeriod:           types.NullDurationFrom(defaultFlushPeriod),
 				KeepTags:              null.BoolFrom(true),
 				KeepNameTag:           null.BoolFrom(false),
+				KeepUrlTag:            null.BoolFrom(true),
 				Headers: map[string]string{
 					"X-Header": "value",
 				},
@@ -230,6 +233,7 @@ func TestConstructRemoteConfig(t *testing.T) {
 				FlushPeriod:           types.NullDurationFrom(defaultFlushPeriod),
 				KeepTags:              null.BoolFrom(true),
 				KeepNameTag:           null.BoolFrom(false),
+				KeepUrlTag:            null.BoolFrom(true),
 				Headers: map[string]string{
 					"X-Header": "value_from_env",
 				},
@@ -266,6 +270,7 @@ func TestConstructRemoteConfig(t *testing.T) {
 				FlushPeriod:           types.NullDurationFrom(defaultFlushPeriod),
 				KeepTags:              null.BoolFrom(true),
 				KeepNameTag:           null.BoolFrom(false),
+				KeepUrlTag:            null.BoolFrom(true),
 				Headers: map[string]string{
 					"X-Header": "value_from_arg",
 				},
@@ -315,6 +320,7 @@ func assertConfig(t *testing.T, actual, expected Config) {
 	assert.Equal(t, expected.FlushPeriod, actual.FlushPeriod)
 	assert.Equal(t, expected.KeepTags, actual.KeepTags)
 	assert.Equal(t, expected.KeepNameTag, expected.KeepNameTag)
+	assert.Equal(t, expected.KeepUrlTag, expected.KeepUrlTag)
 	assert.Equal(t, expected.Headers, actual.Headers)
 }
 

diff --git a/pkg/remotewrite/labels.go b/pkg/remotewrite/labels.go
@@ -22,6 +22,10 @@ func tagsToLabels(tags *stats.SampleTags, config Config) ([]prompb.Label, error)
 			continue
 		}
 
+		if !config.KeepUrlTag.Bool && name == "url" {
+			continue
+		}
+
 		labelPairs = append(labelPairs, prompb.Label{
 			Name:  name,
 			Value: value,

diff --git a/pkg/remotewrite/labels_test.go b/pkg/remotewrite/labels_test.go
@@ -48,6 +48,27 @@ func TestTagsToLabels(t *testing.T) {
 				{Name: "name", Value: "nnn"},
 			},
 		},
+		"url-tag-discard": {
+			tags: stats.NewSampleTags(map[string]string{"foo": "bar", "url": "uuu"}),
+			config: Config{
+				KeepTags:   null.BoolFrom(true),
+				KeepUrlTag: null.BoolFrom(false),
+			},
+			labels: []prompb.Label{
+				{Name: "foo", Value: "bar"},
+			},
+		},
+		"url-tag-keep": {
+			tags: stats.NewSampleTags(map[string]string{"foo": "bar", "url": "uuu"}),
+			config: Config{
+				KeepTags:   null.BoolFrom(true),
+				KeepUrlTag: null.BoolFrom(true),
+			},
+			labels: []prompb.Label{
+				{Name: "foo", Value: "bar"},
+				{Name: "url", Value: "uuu"},
+			},
+		},
 		"discard-tags": {
 			tags: stats.NewSampleTags(map[string]string{"foo": "bar", "name": "nnn"}),
 			config: Config{