Rename from prometheus-remote to prometheus-rw

Author: codebien

README.md

@@ -20,15 +20,15 @@ xk6 build --with github.com/grafana/xk6-output-prometheus-remote@latest
 
 Then run new k6 binary with:
 ```
-K6_PROMETHEUS_REMOTE_URL=http://localhost:9090/api/v1/write ./k6 run script.js -o output-prometheus-remote
+K6_PROMETHEUS_RW_REMOTE_URL=http://localhost:9090/api/v1/write ./k6 run script.js -o output-prometheus-remote
 ```
 
 Add TLS and HTTP basic authentication:
 ```
-K6_PROMETHEUS_REMOTE_URL=https://localhost:9090/api/v1/write \
-K6_PROMETHEUS_INSECURE_SKIP_TLS_VERIFY=false \
-K6_PROMETHEUS_USERNAME=foo \
-K6_PROMETHEUS_PASSWORD=bar \
+K6_PROMETHEUS_RW_REMOTE_URL=https://localhost:9090/api/v1/write \
+K6_PROMETHEUS_RW_INSECURE_SKIP_TLS_VERIFY=false \
+K6_PROMETHEUS_RW_USERNAME=foo \
+K6_PROMETHEUS_RW_PASSWORD=bar \
 ./k6 run script.js -o output-prometheus-remote
 ```
 
@@ -48,7 +48,7 @@ Mapping Trend by Gauges has the following cons:
 * It is impossible to aggregate some Gauge's value (especially the percentiles).
 * It uses a memory-expensive k6's data structure.
 
-The previous points can be resolved by mapping Trend as [Prometheus Native Histogram](https://prometheus.io/docs/concepts/metric_types/#histogram). Enabling the conversion by the `K6_PROMETHEUS_TREND_AS_NATIVE_HISTOGRAM=true` environment variable (or one of the other ways), then the Output converts all the Trend types into a dedicated Native Histogram.
+The previous points can be resolved by mapping Trend as [Prometheus Native Histogram](https://prometheus.io/docs/concepts/metric_types/#histogram). Enabling the conversion by the `K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM=true` environment variable (or one of the other ways), then the Output converts all the Trend types into a dedicated Native Histogram.
 
 Native Histogram is a Prometheus' experimental feature, so it has to be enabled (`--enable-feature=native-histograms`). Note that other Remote-write implementations don't support it yet.
 

docker-compose.yml

@@ -40,8 +40,8 @@ services:
     ports:
       - "6565:6565"
     environment:
-      - K6_PROMETHEUS_REMOTE_URL=http://prometheus:9090/api/v1/write
-      - K6_PROMETHEUS_TREND_AS_NATIVE_HISTOGRAM=true
+      - K6_PROMETHEUS_RW_REMOTE_URL=http://prometheus:9090/api/v1/write
+      - K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM=true
       - K6_OUT=output-prometheus-remote
     depends_on:
       - prometheus

pkg/remotewrite/config.go

@@ -25,32 +25,32 @@ var defaultTrendStats = []string{"p(99)"}
 
 type Config struct {
 	// URL contains the absolute URL for the Write endpoint where to flush the time series.
-	URL null.String `json:"url" envconfig:"K6_PROMETHEUS_REMOTE_URL"`
+	URL null.String `json:"url" envconfig:"K6_PROMETHEUS_RW_REMOTE_URL"`
 
 	// Headers contains additional headers that should be included in the HTTP requests.
-	Headers map[string]string `json:"headers" envconfig:"K6_PROMETHEUS_HEADERS"`
+	Headers map[string]string `json:"headers" envconfig:"K6_PROMETHEUS_RW_HEADERS"`
 
 	// InsecureSkipTLSVerify skips TLS client side checks.
-	InsecureSkipTLSVerify null.Bool `json:"insecureSkipTLSVerify" envconfig:"K6_PROMETHEUS_INSECURE_SKIP_TLS_VERIFY"`
+	InsecureSkipTLSVerify null.Bool `json:"insecureSkipTLSVerify" envconfig:"K6_PROMETHEUS_RW_INSECURE_SKIP_TLS_VERIFY"`
 
 	// Username is the User for Basic Auth.
-	Username null.String `json:"username" envconfig:"K6_PROMETHEUS_USERNAME"`
+	Username null.String `json:"username" envconfig:"K6_PROMETHEUS_RW_USERNAME"`
 
 	// Password is the Password for the Basic Auth.
-	Password null.String `json:"password" envconfig:"K6_PROMETHEUS_PASSWORD"`
+	Password null.String `json:"password" envconfig:"K6_PROMETHEUS_RW_PASSWORD"`
 
 	// PushInterval defines the time between flushes. The Output will wait the set time
 	// before push a new set of time series to the endpoint.
-	PushInterval types.NullDuration `json:"pushInterval" envconfig:"K6_PROMETHEUS_PUSH_INTERVAL"`
+	PushInterval types.NullDuration `json:"pushInterval" envconfig:"K6_PROMETHEUS_RW_PUSH_INTERVAL"`
 
 	// TrendAsNativeHistogram defines if the mapping for metrics defined as Trend type
 	// should map to a Prometheus' Native Histogram.
-	TrendAsNativeHistogram null.Bool `json:"trendAsNativeHistogram" envconfig:"K6_PROMETHEUS_TREND_AS_NATIVE_HISTOGRAM"`
+	TrendAsNativeHistogram null.Bool `json:"trendAsNativeHistogram" envconfig:"K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM"`
 
 	// TrendStats defines the stats to flush for Trend metrics.
 	//
 	// TODO: should we support K6_SUMMARY_TREND_STATS?
-	TrendStats []string `json:"trendStats" envconfig:"K6_PROMETHEUS_TREND_STATS"`
+	TrendStats []string `json:"trendStats" envconfig:"K6_PROMETHEUS_RW_TREND_STATS"`
 }
 
 // NewConfig creates an Output's configuration.
@@ -194,49 +194,49 @@ func parseEnvs(env map[string]string) (Config, error) {
 	}
 
 	// envconfig is not processing some undefined vars (at least duration) so apply them manually
-	if pushInterval, pushIntervalDefined := env["K6_PROMETHEUS_PUSH_INTERVAL"]; pushIntervalDefined {
+	if pushInterval, pushIntervalDefined := env["K6_PROMETHEUS_RW_PUSH_INTERVAL"]; pushIntervalDefined {
 		if err := c.PushInterval.UnmarshalText([]byte(pushInterval)); err != nil {
 			return c, err
 		}
 	}
 
-	if url, urlDefined := env["K6_PROMETHEUS_REMOTE_URL"]; urlDefined {
+	if url, urlDefined := env["K6_PROMETHEUS_RW_REMOTE_URL"]; urlDefined {
 		c.URL = null.StringFrom(url)
 	}
 
-	if b, err := getEnvBool(env, "K6_PROMETHEUS_INSECURE_SKIP_TLS_VERIFY"); err != nil {
+	if b, err := getEnvBool(env, "K6_PROMETHEUS_RW_INSECURE_SKIP_TLS_VERIFY"); err != nil {
 		return c, err
 	} else {
 		if b.Valid {
 			c.InsecureSkipTLSVerify = b
 		}
 	}
 
-	if user, userDefined := env["K6_PROMETHEUS_USERNAME"]; userDefined {
+	if user, userDefined := env["K6_PROMETHEUS_RW_USERNAME"]; userDefined {
 		c.Username = null.StringFrom(user)
 	}
 
-	if password, passwordDefined := env["K6_PROMETHEUS_PASSWORD"]; passwordDefined {
+	if password, passwordDefined := env["K6_PROMETHEUS_RW_PASSWORD"]; passwordDefined {
 		c.Password = null.StringFrom(password)
 	}
 
-	envHeaders := getEnvMap(env, "K6_PROMETHEUS_HEADERS_")
+	envHeaders := getEnvMap(env, "K6_PROMETHEUS_RW_HEADERS_")
 	for k, v := range envHeaders {
 		if c.Headers == nil {
 			c.Headers = make(map[string]string)
 		}
 		c.Headers[k] = v
 	}
 
-	if b, err := getEnvBool(env, "K6_PROMETHEUS_TREND_AS_NATIVE_HISTOGRAM"); err != nil {
+	if b, err := getEnvBool(env, "K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM"); err != nil {
 		return c, err
 	} else {
 		if b.Valid {
 			c.TrendAsNativeHistogram = b
 		}
 	}
 
-	if trendStats, trendStatsDefined := env["K6_PROMETHEUS_TREND_STATS"]; trendStatsDefined {
+	if trendStats, trendStatsDefined := env["K6_PROMETHEUS_RW_TREND_STATS"]; trendStatsDefined {
 		c.TrendStats = strings.Split(trendStats, ",")
 	}
 

pkg/remotewrite/config_test.go

@@ -122,8 +122,8 @@ func TestGetConsolidatedConfig(t *testing.T) {
 		"MixedSuccess": {
 			jsonRaw: json.RawMessage(fmt.Sprintf(`{"url":"%s"}`, u.String())),
 			env: map[string]string{
-				"K6_PROMETHEUS_INSECURE_SKIP_TLS_VERIFY": "false",
-				"K6_PROMETHEUS_USERNAME":                 "u",
+				"K6_PROMETHEUS_RW_INSECURE_SKIP_TLS_VERIFY": "false",
+				"K6_PROMETHEUS_RW_USERNAME":                 "u",
 			},
 			// arg: "username=user",
 			config: Config{
@@ -139,8 +139,8 @@ func TestGetConsolidatedConfig(t *testing.T) {
 		"OrderOfPrecedence": {
 			jsonRaw: json.RawMessage(`{"url":"http://json:9090","username":"json","password":"json"}`),
 			env: map[string]string{
-				"K6_PROMETHEUS_USERNAME": "env",
-				"K6_PROMETHEUS_PASSWORD": "env",
+				"K6_PROMETHEUS_RW_USERNAME": "env",
+				"K6_PROMETHEUS_RW_PASSWORD": "env",
 			},
 			// arg: "password=arg",
 			config: Config{
@@ -158,7 +158,7 @@ func TestGetConsolidatedConfig(t *testing.T) {
 			errString: "parse JSON options failed",
 		},
 		"InvalidEnv": {
-			env:       map[string]string{"K6_PROMETHEUS_INSECURE_SKIP_TLS_VERIFY": "d"},
+			env:       map[string]string{"K6_PROMETHEUS_RW_INSECURE_SKIP_TLS_VERIFY": "d"},
 			errString: "parse environment variables options failed",
 		},
 		//"InvalidArg": {
@@ -208,7 +208,7 @@ func TestOptionURL(t *testing.T) {
 		jsonRaw json.RawMessage
 	}{
 		"JSON": {jsonRaw: json.RawMessage(`{"url":"http://prometheus:9090/api/v1/write"}`)},
-		"Env":  {env: map[string]string{"K6_PROMETHEUS_REMOTE_URL": "http://prometheus:9090/api/v1/write"}},
+		"Env":  {env: map[string]string{"K6_PROMETHEUS_RW_REMOTE_URL": "http://prometheus:9090/api/v1/write"}},
 		//"Arg":  {arg: "url=http://prometheus:9090/api/v1/write"},
 	}
 
@@ -241,7 +241,7 @@ func TestOptionHeaders(t *testing.T) {
 		jsonRaw json.RawMessage
 	}{
 		"JSON": {jsonRaw: json.RawMessage(`{"headers":{"X-MY-HEADER1":"hval1","X-MY-HEADER2":"hval2"}}`)},
-		"Env":  {env: map[string]string{"K6_PROMETHEUS_HEADERS_X-MY-HEADER1": "hval1", "K6_PROMETHEUS_HEADERS_X-MY-HEADER2": "hval2"}},
+		"Env":  {env: map[string]string{"K6_PROMETHEUS_RW_HEADERS_X-MY-HEADER1": "hval1", "K6_PROMETHEUS_RW_HEADERS_X-MY-HEADER2": "hval2"}},
 		//"Arg":  {arg: "headers.X-MY-HEADER1=hval1,headers.X-MY-HEADER2=hval2"},
 	}
 
@@ -275,7 +275,7 @@ func TestOptionInsecureSkipTLSVerify(t *testing.T) {
 		jsonRaw json.RawMessage
 	}{
 		"JSON": {jsonRaw: json.RawMessage(`{"insecureSkipTLSVerify":false}`)},
-		"Env":  {env: map[string]string{"K6_PROMETHEUS_INSECURE_SKIP_TLS_VERIFY": "false"}},
+		"Env":  {env: map[string]string{"K6_PROMETHEUS_RW_INSECURE_SKIP_TLS_VERIFY": "false"}},
 		//"Arg":  {arg: "insecureSkipTLSVerify=false"},
 	}
 
@@ -306,7 +306,7 @@ func TestOptionBasicAuth(t *testing.T) {
 		jsonRaw json.RawMessage
 	}{
 		"JSON": {jsonRaw: json.RawMessage(`{"username":"user1","password":"pass1"}`)},
-		"Env":  {env: map[string]string{"K6_PROMETHEUS_USERNAME": "user1", "K6_PROMETHEUS_PASSWORD": "pass1"}},
+		"Env":  {env: map[string]string{"K6_PROMETHEUS_RW_USERNAME": "user1", "K6_PROMETHEUS_RW_PASSWORD": "pass1"}},
 		//"Arg":  {arg: "username=user1,password=pass1"},
 	}
 
@@ -340,7 +340,7 @@ func TestOptionTrendAsNativeHistogram(t *testing.T) {
 		jsonRaw json.RawMessage
 	}{
 		"JSON": {jsonRaw: json.RawMessage(`{"trendAsNativeHistogram":true}`)},
-		"Env":  {env: map[string]string{"K6_PROMETHEUS_TREND_AS_NATIVE_HISTOGRAM": "true"}},
+		"Env":  {env: map[string]string{"K6_PROMETHEUS_RW_TREND_AS_NATIVE_HISTOGRAM": "true"}},
 		//"Arg":  {arg: "trendAsNativeHistogram=true"},
 	}
 
@@ -375,7 +375,7 @@ func TestOptionPushInterval(t *testing.T) {
 		jsonRaw json.RawMessage
 	}{
 		"JSON": {jsonRaw: json.RawMessage(`{"pushInterval":"1m2s"}`)},
-		"Env":  {env: map[string]string{"K6_PROMETHEUS_PUSH_INTERVAL": "1m2s"}},
+		"Env":  {env: map[string]string{"K6_PROMETHEUS_RW_PUSH_INTERVAL": "1m2s"}},
 		//"Arg":  {arg: "pushInterval=1m2s"},
 	}
 
@@ -409,7 +409,7 @@ func TestConfigTrendStats(t *testing.T) {
 		jsonRaw json.RawMessage
 	}{
 		"JSON": {jsonRaw: json.RawMessage(`{"trendStats":["max","p(95)"]}`)},
-		"Env":  {env: map[string]string{"K6_PROMETHEUS_TREND_STATS": "max,p(95)"}},
+		"Env":  {env: map[string]string{"K6_PROMETHEUS_RW_TREND_STATS": "max,p(95)"}},
 		// TODO: support arg, check the comment in the code
 		//"Arg":  {arg: "trendStats=max,p(95)"},
 	}

register.go

@@ -6,7 +6,7 @@ import (
 )
 
 func init() {
-	output.RegisterExtension("output-prometheus-remote", func(p output.Params) (output.Output, error) {
+	output.RegisterExtension("xk6-prometheus-rw", func(p output.Params) (output.Output, error) {
 		return remotewrite.New(p)
 	})
 }