feat: use name instead of index for instance id tag (#135)

* feat: use name instead of index for instance id tag * feat: add tag for job_name instead of changing instance_id * test: add the new tag to unit tests
grafana · Sep 1, 2022 · 02dfbc9 · 02dfbc9
1 parent 25e028e
commit 02dfbc9
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 9 deletions.
diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/k6.io_k6s.yaml b/config/crd/bases/k6.io_k6s.yaml
@@ -813,7 +813,6 @@ spec:
                       - name
                       type: object
                     type: array
-                  # ref: https://github.com/kubernetes/kubernetes/blob/7e2c02d4c86d73051b6d4f47298d35a7ffb42b6a/api/openapi-spec/v3/apis__apps__v1_openapi.json#L1681
                   envFrom:
                     items:
                       description: EnvFromSource represents the source of a set of

diff --git a/pkg/resources/jobs/runner.go b/pkg/resources/jobs/runner.go
@@ -68,6 +68,9 @@ func NewRunnerJob(k6 *v1alpha1.K6, index int, testRunId, token string) (*batchv1
 	// Add an instance tag: in case metrics are stored, they need to be distinguished by instance
 	command = append(command, "--tag", fmt.Sprintf("instance_id=%d", index))
 
+	// Add an job tag: in case metrics are stored, they need to be distinguished by job
+	command = append(command, "--tag", fmt.Sprintf("job_name=%s", name))
+
 	command = script.UpdateCommand(command)
 
 	var (

diff --git a/pkg/resources/jobs/runner_test.go b/pkg/resources/jobs/runner_test.go
@@ -289,7 +289,7 @@ func TestNewRunnerJob(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:        "ghcr.io/grafana/operator:latest-runner",
 						Name:         "k6",
-						Command:      []string{"k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1"},
+						Command:      []string{"k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1", "--tag", "job_name=test-1"},
 						Env:          []corev1.EnvVar{},
 						Resources:    corev1.ResourceRequirements{},
 						VolumeMounts: script.VolumeMount(),
@@ -399,7 +399,7 @@ func TestNewRunnerJobNoisy(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:        "ghcr.io/grafana/operator:latest-runner",
 						Name:         "k6",
-						Command:      []string{"k6", "run", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1"},
+						Command:      []string{"k6", "run", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1", "--tag", "job_name=test-1"},
 						Env:          []corev1.EnvVar{},
 						Resources:    corev1.ResourceRequirements{},
 						VolumeMounts: script.VolumeMount(),
@@ -492,7 +492,7 @@ func TestNewRunnerJobUnpaused(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:        "ghcr.io/grafana/operator:latest-runner",
 						Name:         "k6",
-						Command:      []string{"k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--tag", "instance_id=1"},
+						Command:      []string{"k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--tag", "instance_id=1", "--tag", "job_name=test-1"},
 						Env:          []corev1.EnvVar{},
 						Resources:    corev1.ResourceRequirements{},
 						VolumeMounts: script.VolumeMount(),
@@ -585,7 +585,7 @@ func TestNewRunnerJobArguments(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:        "ghcr.io/grafana/operator:latest-runner",
 						Name:         "k6",
-						Command:      []string{"k6", "run", "--quiet", "--cool-thing", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1"},
+						Command:      []string{"k6", "run", "--quiet", "--cool-thing", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1", "--tag", "job_name=test-1"},
 						Env:          []corev1.EnvVar{},
 						Resources:    corev1.ResourceRequirements{},
 						VolumeMounts: script.VolumeMount(),
@@ -679,7 +679,7 @@ func TestNewRunnerJobServiceAccount(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:        "ghcr.io/grafana/operator:latest-runner",
 						Name:         "k6",
-						Command:      []string{"k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1"},
+						Command:      []string{"k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1", "--tag", "job_name=test-1"},
 						Env:          []corev1.EnvVar{},
 						Resources:    corev1.ResourceRequirements{},
 						VolumeMounts: script.VolumeMount(),
@@ -774,7 +774,7 @@ func TestNewRunnerJobIstio(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:   "ghcr.io/grafana/operator:latest-runner",
 						Name:    "k6",
-						Command: []string{"scuttle", "k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1"},
+						Command: []string{"scuttle", "k6", "run", "--quiet", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1", "--tag", "job_name=test-1"},
 						Env: []corev1.EnvVar{
 							{
 								Name:  "ENVOY_ADMIN_API",
@@ -881,7 +881,7 @@ func TestNewRunnerJobCloud(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:   "ghcr.io/grafana/operator:latest-runner",
 						Name:    "k6",
-						Command: []string{"k6", "run", "--quiet", "--out", "cloud", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1"},
+						Command: []string{"k6", "run", "--quiet", "--out", "cloud", "/test/test.js", "--address=0.0.0.0:6565", "--paused", "--tag", "instance_id=1", "--tag", "job_name=test-1"},
 						Env: []corev1.EnvVar{
 							{
 								Name:  "K6_CLOUD_PUSH_REF_ID",
@@ -979,7 +979,7 @@ func TestNewRunnerJobLocalFile(t *testing.T) {
 					Containers: []corev1.Container{{
 						Image:        "ghcr.io/grafana/operator:latest-runner",
 						Name:         "k6",
-						Command:      []string{"sh", "-c", "if [ ! -f /test/test.js ]; then echo \"LocalFile not found exiting...\"; exit 1; fi;\nk6 run --quiet /test/test.js --address=0.0.0.0:6565 --paused --tag instance_id=1"},
+						Command:      []string{"sh", "-c", "if [ ! -f /test/test.js ]; then echo \"LocalFile not found exiting...\"; exit 1; fi;\nk6 run --quiet /test/test.js --address=0.0.0.0:6565 --paused --tag instance_id=1 --tag job_name=test-1"},
 						Env:          []corev1.EnvVar{},
 						Resources:    corev1.ResourceRequirements{},
 						VolumeMounts: script.VolumeMount(),