-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4562 from grafana/feat/opentelemetry-output
Move opentelemetry's ouput code to the k6 core
- Loading branch information
Showing
13 changed files
with
546 additions
and
673 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,204 @@ | ||
| package opentelemetry | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| k6Const "go.k6.io/k6/lib/consts" | ||
| "go.k6.io/k6/lib/types" | ||
| "gopkg.in/guregu/null.v3" | ||
| ) | ||
|
|
||
| func TestConfig(t *testing.T) { | ||
| t.Parallel() | ||
| // TODO: add more cases | ||
| testCases := map[string]struct { | ||
| jsonRaw json.RawMessage | ||
| env map[string]string | ||
| arg string | ||
| expectedConfig Config | ||
| err string | ||
| }{ | ||
| "default": { | ||
| expectedConfig: Config{ | ||
| ServiceName: null.StringFrom("k6"), | ||
| ServiceVersion: null.StringFrom(k6Const.Version), | ||
| ExporterType: null.StringFrom(grpcExporterType), | ||
| HTTPExporterInsecure: null.NewBool(false, true), | ||
| HTTPExporterEndpoint: null.StringFrom("localhost:4318"), | ||
| HTTPExporterURLPath: null.StringFrom("/v1/metrics"), | ||
| GRPCExporterInsecure: null.NewBool(false, true), | ||
| GRPCExporterEndpoint: null.StringFrom("localhost:4317"), | ||
| ExportInterval: types.NullDurationFrom(10 * time.Second), | ||
| FlushInterval: types.NullDurationFrom(1 * time.Second), | ||
| }, | ||
| }, | ||
|
|
||
| "environment success merge": { | ||
| env: map[string]string{"K6_OTEL_GRPC_EXPORTER_ENDPOINT": "else", "K6_OTEL_EXPORT_INTERVAL": "4ms"}, | ||
| expectedConfig: Config{ | ||
| ServiceName: null.StringFrom("k6"), | ||
| ServiceVersion: null.StringFrom(k6Const.Version), | ||
| ExporterType: null.StringFrom(grpcExporterType), | ||
| HTTPExporterInsecure: null.NewBool(false, true), | ||
| HTTPExporterEndpoint: null.StringFrom("localhost:4318"), | ||
| HTTPExporterURLPath: null.StringFrom("/v1/metrics"), | ||
| GRPCExporterInsecure: null.NewBool(false, true), | ||
| GRPCExporterEndpoint: null.StringFrom("else"), | ||
| ExportInterval: types.NullDurationFrom(4 * time.Millisecond), | ||
| FlushInterval: types.NullDurationFrom(1 * time.Second), | ||
| }, | ||
| }, | ||
|
|
||
| "environment complete overwrite": { | ||
| env: map[string]string{ | ||
| "K6_OTEL_SERVICE_NAME": "foo", | ||
| "K6_OTEL_SERVICE_VERSION": "v0.0.99", | ||
| "K6_OTEL_EXPORTER_TYPE": "http", | ||
| "K6_OTEL_EXPORT_INTERVAL": "4ms", | ||
| "K6_OTEL_HTTP_EXPORTER_INSECURE": "true", | ||
| "K6_OTEL_HTTP_EXPORTER_ENDPOINT": "localhost:5555", | ||
| "K6_OTEL_HTTP_EXPORTER_URL_PATH": "/foo/bar", | ||
| "K6_OTEL_GRPC_EXPORTER_INSECURE": "true", | ||
| "K6_OTEL_GRPC_EXPORTER_ENDPOINT": "else", | ||
| "K6_OTEL_FLUSH_INTERVAL": "13s", | ||
| "K6_OTEL_TLS_INSECURE_SKIP_VERIFY": "true", | ||
| "K6_OTEL_TLS_CERTIFICATE": "cert_path", | ||
| "K6_OTEL_TLS_CLIENT_CERTIFICATE": "client_cert_path", | ||
| "K6_OTEL_TLS_CLIENT_KEY": "client_key_path", | ||
| "K6_OTEL_HEADERS": "key1=value1,key2=value2", | ||
| }, | ||
| expectedConfig: Config{ | ||
| ServiceName: null.StringFrom("foo"), | ||
| ServiceVersion: null.StringFrom("v0.0.99"), | ||
| ExporterType: null.StringFrom(httpExporterType), | ||
| ExportInterval: types.NullDurationFrom(4 * time.Millisecond), | ||
| HTTPExporterInsecure: null.NewBool(true, true), | ||
| HTTPExporterEndpoint: null.StringFrom("localhost:5555"), | ||
| HTTPExporterURLPath: null.StringFrom("/foo/bar"), | ||
| GRPCExporterInsecure: null.NewBool(true, true), | ||
| GRPCExporterEndpoint: null.StringFrom("else"), | ||
| FlushInterval: types.NullDurationFrom(13 * time.Second), | ||
| TLSInsecureSkipVerify: null.NewBool(true, true), | ||
| TLSCertificate: null.StringFrom("cert_path"), | ||
| TLSClientCertificate: null.StringFrom("client_cert_path"), | ||
| TLSClientKey: null.StringFrom("client_key_path"), | ||
| Headers: null.StringFrom("key1=value1,key2=value2"), | ||
| }, | ||
| }, | ||
|
|
||
| "OTEL environment variables": { | ||
| env: map[string]string{ | ||
| "OTEL_SERVICE_NAME": "otel-service", | ||
| }, | ||
| expectedConfig: Config{ | ||
| ServiceName: null.StringFrom("otel-service"), | ||
| ServiceVersion: null.StringFrom(k6Const.Version), | ||
| ExporterType: null.StringFrom(grpcExporterType), | ||
| HTTPExporterInsecure: null.NewBool(false, true), | ||
| HTTPExporterEndpoint: null.StringFrom("localhost:4318"), | ||
| HTTPExporterURLPath: null.StringFrom("/v1/metrics"), | ||
| GRPCExporterInsecure: null.NewBool(false, true), | ||
| GRPCExporterEndpoint: null.StringFrom("localhost:4317"), | ||
| ExportInterval: types.NullDurationFrom(10 * time.Second), | ||
| FlushInterval: types.NullDurationFrom(1 * time.Second), | ||
| }, | ||
| }, | ||
|
|
||
| "JSON complete overwrite": { | ||
| jsonRaw: json.RawMessage( | ||
| `{` + | ||
| `"serviceName":"bar",` + | ||
| `"serviceVersion":"v2.0.99",` + | ||
| `"exporterType":"http",` + | ||
| `"exportInterval":"15ms",` + | ||
| `"httpExporterInsecure":true,` + | ||
| `"httpExporterEndpoint":"localhost:5555",` + | ||
| `"httpExporterURLPath":"/foo/bar",` + | ||
| `"grpcExporterInsecure":true,` + | ||
| `"grpcExporterEndpoint":"else",` + | ||
| `"flushInterval":"13s",` + | ||
| `"tlsInsecureSkipVerify":true,` + | ||
| `"tlsCertificate":"cert_path",` + | ||
| `"tlsClientCertificate":"client_cert_path",` + | ||
| `"tlsClientKey":"client_key_path",` + | ||
| `"headers":"key1=value1,key2=value2"` + | ||
| `}`, | ||
| ), | ||
| expectedConfig: Config{ | ||
| ServiceName: null.StringFrom("bar"), | ||
| ServiceVersion: null.StringFrom("v2.0.99"), | ||
| ExporterType: null.StringFrom(httpExporterType), | ||
| ExportInterval: types.NullDurationFrom(15 * time.Millisecond), | ||
| HTTPExporterInsecure: null.NewBool(true, true), | ||
| HTTPExporterEndpoint: null.StringFrom("localhost:5555"), | ||
| HTTPExporterURLPath: null.StringFrom("/foo/bar"), | ||
| GRPCExporterInsecure: null.NewBool(true, true), | ||
| GRPCExporterEndpoint: null.StringFrom("else"), | ||
| FlushInterval: types.NullDurationFrom(13 * time.Second), | ||
| TLSInsecureSkipVerify: null.NewBool(true, true), | ||
| TLSCertificate: null.StringFrom("cert_path"), | ||
| TLSClientCertificate: null.StringFrom("client_cert_path"), | ||
| TLSClientKey: null.StringFrom("client_key_path"), | ||
| Headers: null.StringFrom("key1=value1,key2=value2"), | ||
| }, | ||
| }, | ||
|
|
||
| "JSON success merge": { | ||
| jsonRaw: json.RawMessage(`{"exporterType":"http","httpExporterEndpoint":"localhost:5566","httpExporterURLPath":"/lorem/ipsum", "exportInterval":"15ms"}`), | ||
| expectedConfig: Config{ | ||
| ServiceName: null.StringFrom("k6"), | ||
| ServiceVersion: null.StringFrom(k6Const.Version), | ||
| ExporterType: null.StringFrom(httpExporterType), | ||
| HTTPExporterInsecure: null.NewBool(false, true), | ||
| HTTPExporterEndpoint: null.StringFrom("localhost:5566"), | ||
| HTTPExporterURLPath: null.StringFrom("/lorem/ipsum"), | ||
| GRPCExporterInsecure: null.NewBool(false, true), // default | ||
| GRPCExporterEndpoint: null.StringFrom("localhost:4317"), // default | ||
| ExportInterval: types.NullDurationFrom(15 * time.Millisecond), | ||
| FlushInterval: types.NullDurationFrom(1 * time.Second), | ||
| }, | ||
| }, | ||
| "no scheme in http exporter": { | ||
| jsonRaw: json.RawMessage(`{"exporterType":"http","httpExporterEndpoint":"http://localhost:5566","httpExporterURLPath":"/lorem/ipsum", "exportInterval":"15ms"}`), | ||
| err: `config: HTTP exporter endpoint must only be host and port, no scheme`, | ||
| }, | ||
|
|
||
| "early error env": { | ||
| env: map[string]string{"K6_OTEL_GRPC_EXPORTER_ENDPOINT": "else", "K6_OTEL_EXPORT_INTERVAL": "4something"}, | ||
| err: `time: unknown unit "something" in duration "4something"`, | ||
| }, | ||
|
|
||
| "early error JSON": { | ||
| jsonRaw: json.RawMessage(`{"exportInterval":"4something"}`), | ||
| err: `time: unknown unit "something" in duration "4something"`, | ||
| }, | ||
|
|
||
| "unsupported receiver type": { | ||
| env: map[string]string{"K6_OTEL_GRPC_EXPORTER_ENDPOINT": "else", "K6_OTEL_EXPORT_INTERVAL": "4m", "K6_OTEL_EXPORTER_TYPE": "socket"}, | ||
| err: `error validating OpenTelemetry output config: unsupported exporter type "socket", currently only "grpc" and "http" are supported`, | ||
| }, | ||
|
|
||
| "missing required": { | ||
| jsonRaw: json.RawMessage(`{"exporterType":"http","httpExporterEndpoint":"","httpExporterURLPath":"/lorem/ipsum"}`), | ||
| err: `HTTP exporter endpoint is required`, | ||
| }, | ||
| } | ||
|
|
||
| for name, testCase := range testCases { | ||
| testCase := testCase | ||
| t.Run(name, func(t *testing.T) { | ||
| t.Parallel() | ||
| config, err := GetConsolidatedConfig(testCase.jsonRaw, testCase.env) | ||
| if testCase.err != "" { | ||
| require.Error(t, err) | ||
| require.Contains(t, err.Error(), testCase.err) | ||
| return | ||
| } | ||
| require.NoError(t, err) | ||
| require.Equal(t, testCase.expectedConfig, config) | ||
| }) | ||
| } | ||
| } |
File renamed without changes.
File renamed without changes.
Oops, something went wrong.