Align configuration with OpenTelemetry SDK, HTTP exporter #5
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,13 +5,36 @@ A work in progress k6 extension to output real-time test metrics in [OpenTelemet | |
| > [!WARNING] | ||
| > It's work in progress implementation and not ready for production use. | ||
|
|
||
| ## Configuration options | ||
|
|
||
| Currently, environment variables only. It's worth to mention that the extension is using the [OpenTelemetry Go SDK](https://opentelemetry.io/docs/languages/go/getting-started/) that's why it's possible to use the configuration environment variables from the SDK. However, if the `K6_OTEL_*` environment variables are set, they will take precedence over the SDK configuration. | ||
|
|
||
| ### k6-specific configuration | ||
|
|
||
| * `K6_OTEL_METRIC_PREFIX` - Metric prefix. Default is empty. | ||
| * `K6_OTEL_FLUSH_INTERVAL` - How frequently to flush metrics from k6 metrics engine. Default is `1s`. | ||
|
|
||
| ### OpenTelemetry-specific configuration | ||
|
|
||
| * `K6_OTEL_EXPORT_INTERVAL` - configures the intervening time between metrics exports. Default is `1s`. | ||
| * `K6_OTEL_EXPORTER_TYPE` - metric exporter type. Default is `grpc`. | ||
|
|
||
| #### GRPC exporter | ||
|
|
||
| * `K6_OTEL_GRPC_EXPORTER_INSECURE` - disables client transport security for the gRPC exporter. | ||
| * `K6_OTEL_GRPC_EXPORTER_ENDPOINT` - configures the gRPC exporter endpoint. Default is `localhost:4317`. | ||
|
|
||
| > [!TIP] | ||
| > Also, you can use [OpenTelemetry SDK configuration environment variables](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/[email protected]). | ||
|
|
||
| #### HTTP exporter | ||
|
|
||
| * `K6_OTEL_HTTP_EXPORTER_INSECURE` - disables client transport security for the HTTP exporter. | ||
| * `K6_OTEL_HTTP_EXPORTER_ENDPOINT` - configures the HTTP exporter endpoint. Default is `localhost:4318`. | ||
| * `K6_OTEL_HTTP_EXPORTER_URL_PATH` - configures the HTTP exporter path. Default is `/v1/metrics`. | ||
|
|
||
| > [!TIP] | ||
| > Also, you can use [OpenTelemetry SDK configuration environment variables](https://pkg.go.dev/go.opentelemetry.io/otel/exporters/otlp/otlpmetric/[email protected]). | ||
|
|
||
| ## Build | ||
|
|
||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,82 +5,185 @@ import ( | |
| "fmt" | ||
| "time" | ||
|
|
||
| k6Const "go.k6.io/k6/lib/consts" | ||
| "go.k6.io/k6/output" | ||
| "gopkg.in/guregu/null.v3" | ||
| ) | ||
|
|
||
| const ( | ||
| // grpcExporterType GRPC exporter type | ||
| grpcExporterType = "grpc" | ||
| // httpExporterType HTTP exporter type | ||
| httpExporterType = "http" | ||
| ) | ||
|
|
||
| // Config is the config for the template collector | ||
| type Config struct { | ||
| // ServiceName is the name of the service to use for the metrics | ||
| // export, if not set it will use "k6" | ||
| ServiceName string | ||
| // ServiceVersion is the version of the service to use for the metrics | ||
| // export, if not set it will use k6's library version | ||
| ServiceVersion string | ||
| // MetricPrefix is the prefix to use for the metrics | ||
| MetricPrefix string | ||
| // FlushInterval is the interval at which to flush metrics from the k6 | ||
| FlushInterval time.Duration | ||
|
|
||
| // ExporterType sets the type of OpenTelemetry Exporter to use | ||
| ExporterType string | ||
| // ExportInterval configures the intervening time between metrics exports | ||
| ExportInterval time.Duration | ||
|
|
||
| // HTTPExporterInsecure disables client transport security for the Exporter's HTTP | ||
| // connection. | ||
| HTTPExporterInsecure null.Bool | ||
| // HTTPExporterEndpoint sets the target endpoint the OpenTelemetry Exporter | ||
| // will connect to. | ||
| HTTPExporterEndpoint string | ||
| // HTTPExporterURLPath sets the target URL path the OpenTelemetry Exporter | ||
| HTTPExporterURLPath string | ||
|
|
||
| // GRPCExporterEndpoint sets the target endpoint the OpenTelemetry Exporter | ||
| // will connect to. | ||
| GRPCExporterEndpoint string | ||
| // GRPCExporterInsecure disables client transport security for the Exporter's gRPC | ||
| // connection. | ||
| GRPCExporterInsecure null.Bool | ||
| } | ||
|
|
||
| // NewConfig creates and validates a new config | ||
| func NewConfig(p output.Params) (Config, error) { | ||
| cfg := Config{ | ||
| ServiceName: "k6", | ||
| ServiceVersion: k6Const.Version, | ||
| MetricPrefix: "", | ||
| ExporterType: grpcExporterType, | ||
|
|
||
| HTTPExporterInsecure: null.BoolFrom(false), | ||
| HTTPExporterEndpoint: "localhost:4318", | ||
| HTTPExporterURLPath: "/v1/metrics", | ||
|
|
||
| GRPCExporterInsecure: null.BoolFrom(false), | ||
| GRPCExporterEndpoint: "localhost:4317", | ||
|
|
||
| ExportInterval: 1 * time.Second, | ||
| FlushInterval: 1 * time.Second, | ||
| } | ||
|
|
||
| var err error | ||
| for k, v := range p.Environment { | ||
| switch k { | ||
| case "K6_OTEL_SERVICE_NAME": | ||
| cfg.ServiceName = v | ||
| case "K6_OTEL_SERVICE_VERSION": | ||
| cfg.ServiceVersion = v | ||
|
Comment on lines
75
to
+80
There was a problem hiding this comment. Not certain if jut using envconfig.Process as all the other outputs will not be better especially before we move the whole configuration over to not using envconfig. There was a problem hiding this comment. Also, implemented as part of: #11 |
||
| case "K6_OTEL_METRIC_PREFIX": | ||
| cfg.MetricPrefix = v | ||
| case "K6_OTEL_EXPORT_INTERVAL": | ||
| cfg.ExportInterval, err = time.ParseDuration(v) | ||
| if err != nil { | ||
| return cfg, fmt.Errorf("error parsing environment variable 'K6_OTEL_EXPORT_INTERVAL': %w", err) | ||
| } | ||
| case "K6_OTEL_FLUSH_INTERVAL": | ||
| cfg.FlushInterval, err = time.ParseDuration(v) | ||
| if err != nil { | ||
| return cfg, fmt.Errorf("error parsing environment variable 'K6_OTEL_FLUSH_INTERVAL': %w", err) | ||
| } | ||
| case "K6_OTEL_EXPORTER_TYPE": | ||
| cfg.ExporterType = v | ||
| case "K6_OTEL_GRPC_EXPORTER_ENDPOINT": | ||
| cfg.GRPCExporterEndpoint = v | ||
| case "K6_OTEL_HTTP_EXPORTER_ENDPOINT": | ||
| cfg.HTTPExporterEndpoint = v | ||
| case "K6_OTEL_HTTP_EXPORTER_URL_PATH": | ||
| cfg.HTTPExporterURLPath = v | ||
| case "K6_OTEL_HTTP_EXPORTER_INSECURE": | ||
| cfg.HTTPExporterInsecure, err = parseBool(k, v) | ||
| if err != nil { | ||
| return cfg, err | ||
| } | ||
| case "K6_OTEL_GRPC_EXPORTER_INSECURE": | ||
| cfg.GRPCExporterInsecure, err = parseBool(k, v) | ||
| if err != nil { | ||
| return cfg, err | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // TDOO: consolidated config | ||
|
|
||
| if err = cfg.Validate(); err != nil { | ||
| return cfg, fmt.Errorf("error validating OpenTelemetry output config: %w", err) | ||
| } | ||
|
|
||
| return cfg, nil | ||
| } | ||
|
|
||
| func parseBool(k, v string) (null.Bool, error) { | ||
| bv := null.NewBool(false, false) | ||
|
|
||
| err := bv.UnmarshalText([]byte(v)) | ||
| if err != nil { | ||
| return bv, fmt.Errorf("error parsing %q environment variable: %w", k, err) | ||
| } | ||
|
|
||
| return bv, nil | ||
| } | ||
|
|
||
| // Validate validates the config | ||
| func (c Config) Validate() error { | ||
| if c.ServiceName == "" { | ||
| return errors.New("providing service name is required") | ||
| } | ||
|
|
||
| if c.ServiceVersion == "" { | ||
| return errors.New("providing service version is required") | ||
| } | ||
|
|
||
| if c.ExporterType != grpcExporterType && c.ExporterType != httpExporterType { | ||
| return fmt.Errorf( | ||
| "unsupported exporter type %q, currently only %q and %q are supported", | ||
| c.ExporterType, | ||
| grpcExporterType, | ||
| httpExporterType, | ||
| ) | ||
| } | ||
|
|
||
| if c.ExporterType == grpcExporterType { | ||
| if c.GRPCExporterEndpoint == "" { | ||
| return errors.New("gRPC exporter endpoint is required") | ||
| } | ||
| } | ||
|
|
||
| if c.ExporterType == httpExporterType { | ||
| if c.HTTPExporterEndpoint == "" { | ||
| return errors.New("HTTP exporter endpoint is required") | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| // String returns a string representation of the config | ||
| func (c Config) String() string { | ||
| var endpoint string | ||
| exporter := c.ExporterType | ||
|
|
||
| if c.ExporterType == httpExporterType { | ||
| endpoint = "http" | ||
| if !c.HTTPExporterInsecure.Bool { | ||
| endpoint += "s" | ||
| } | ||
|
|
||
| endpoint += "://" + c.HTTPExporterEndpoint + c.HTTPExporterURLPath | ||
| } else { | ||
| endpoint = c.GRPCExporterEndpoint | ||
|
|
||
| if c.GRPCExporterInsecure.Bool { | ||
| exporter += " (insecure)" | ||
| } | ||
| } | ||
|
|
||
| return fmt.Sprintf("%s, %s", exporter, endpoint) | ||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: In general it is better idea to always use
nulltypes for everything as that lets you know if you should use a default value or if somebody just managed to match it.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Implemented as part of: #11