Tweaking instructions for running against docker

Changes bring Dockerfile more in line with that of k6 itself.

Author: javaducky

.gitignore

@@ -1,2 +1,3 @@
+.idea/
 .DS_Store
 k6

Dockerfile

@@ -17,5 +17,4 @@ COPY --from=builder /tmp/k6 /usr/bin/k6
 USER 12345
 WORKDIR /home/k6
 
-# By default, the image is setup for running js scripts.
-ENTRYPOINT ["k6", "run"]
+ENTRYPOINT ["k6"]

README.md

@@ -60,22 +60,26 @@ This repo includes a [docker-compose.yml](./docker-compose.yml) file that starts
 Clone the repo to get started and follow these steps: 
 
 1. Start the docker compose environment.
-	```shell
-	docker-compose up -d
-	```
+    ```shell
+    docker-compose up -d
+    ```
 
     > Some users have encountered failures for the k6 build portion. A workaround may be to disable the _"Use Docker Compose V2"_ checkbox in the _General_ section of Docker Desktop settings.
 
-	```shell
-	# Output
-	Creating xk6-output-prometheus-remote_grafana_1     ... done
-	Creating xk6-output-prometheus-remote_prometheus_1  ... done
-	Creating xk6-output-prometheus-remote_k6_1          ... done
-	```
-
-2. Use the k6 Docker image to run the k6 script and send metrics to the Prometheus container started on the previous step. The [test.js](./example/test.js) sets a [test-wide tag](https://k6.io/docs/using-k6/tags-and-groups/#test-wide-tags) with a unique identifier to segment the metrics into discrete test runs for Grafana dashboards.
-	```shell
-	docker-compose run --rm k6 -<example/test.js
-	```
+    ```shell
+    # Output
+    Creating xk6-output-prometheus-remote_grafana_1     ... done
+    Creating xk6-output-prometheus-remote_prometheus_1  ... done
+    Creating xk6-output-prometheus-remote_k6_1          ... done
+    ```
+
+2. Use the k6 Docker image to run the k6 script and send metrics to the Prometheus container started on the previous step. You must [set the `testid` tag](https://k6.io/docs/using-k6/tags-and-groups/#test-wide-tags) with a unique identifier to segment the metrics into discrete test runs for the Grafana dashboards.
+    ```shell
+    docker-compose run --rm k6 run -<example/test.js --tag testid=<SOME-ID>
+    ```
+    For convenience, the `docker-run.sh` can be used to simply:
+    ```shell
+    ./docker-run.sh example/test.js
+    ```
 
 3. Visit http://localhost:3000/ to view results in Grafana.

docker-run.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env zsh
+
+#
+# This script simply executes a provided JavaScript test using
+# the local environment established with the `docker-compose`.
+# 
+# Each execution is provided a unique tag to differentiate
+# discrete test runs within the Grafana dashboard.
+#
+
+set -e
+
+if [ $# -ne 1 ]; then
+    echo "Usage: ./docker-run.sh <SCRIPT_NAME>"
+    exit 1
+fi
+
+SCRIPT_NAME=$1
+TAG_NAME="$(basename -s .js $SCRIPT_NAME)-$(date +%s)"
+
+docker-compose run --rm k6 run -<$SCRIPT_NAME --tag testid=$TAG_NAME