Use a dedicated option instead of MaxMetricSamplesPerPackage

[codebien]

What

As defined by the code's comment below, we should use a better name that matches the purpose for MaxMetricSamplesPerPackage in cloudv2.

cloudv2 uses MaxMetricSamplesPerPackage for defining the max number of time series in a single flush batch. Instead, the current option defines the number of k6 samples.

k6/cloudapi/config.go

Lines 34 to 36 in 1df72a0

	// TODO: rename the config field to align to the new logic by time series
	// when the migration from the version 1 is completed.
	MaxMetricSamplesPerPackage null.Int `json:"maxMetricSamplesPerPackage" envconfig:"K6_CLOUD_MAX_METRIC_SAMPLES_PER_PACKAGE"`

k6/output/cloud/expv2/output.go

Lines 110 to 112 in 1df72a0

	// TODO: rename the config field to align to the new logic by time series
	// when the migration from the version 1 is completed.
	maxSeriesInSingleBatch: int(o.config.MaxMetricSamplesPerPackage.Int64),

Why

MaxMetricSamplesPerPackage is inherited from v1 but we should use a cleaner and dedicated field.

Suggestion

Add a dedicated new field for defining the max number of series in a single flush batch.

[imiric]

Whatever the new name is, it shouldn't reference "packages", which I'm not sure what they are. I think this was meant to be "per (network) packet", but even that would be wrong, as HTTP is not concerned with TCP/IP packets, and requests could be split over several packets. So "per (HTTP) request" would be more accurate, or since the v2 output now deals with protobuf, maybe "per (protobuf) message", or more generically "per payload", would be better.