K6_PROMETHEUS_REMOTE_URL Support For Testkube OpenAPI

[nikhil-bilgi]

We are aware that testkube already uses the xk6 version with prometheus support.
We want to send k6 metrics (both default and custom) to our prometheus endpoint using testkube via openAPI.
Can you point us to any documentation or sample projects ?

We are using xk6 version with prometheus and sending default and custom metrics to our prometheus and grafana using K6_PROMETHEUS_REMOTE_URL environment variable.

[vsukhin]

hey @NeoKnick Great question, We do provide metrics for prometheus scraping for our key api methods, like creating or running the tests, but we don't collect them during test execution.

So, you can send us a feature-request to collect them or might be want to contribute this piece of code for existing k6 executor ;)
Or I see similar question #2739 (comment)

[nikhil-bilgi]

We are from the same team @vsukhin :)

If I'm not wrong the out-of-the box k6 executor already provides the prometheus support ?
https://github.com/kubeshop/testkube-executor-k6/blob/main/build/agent/Dockerfile#L6

If so then shouldn't testkube provide an option by just exposing the K6_PROMETHEUS_REMOTE_URL environment variable and "-o output-prometheus-remote" arg ?

[vsukhin]

Yes, true

We support both env vars and arguments for k6 executor.
For example in our CLI
--executor-args stringArray executor binary additional arguments
-v, --variable stringToString variable key value pair: --variable key1=value1 (default [])

Similar in API itself

[vasireddi78]

Hi @vsukhin , Thanks for the information. I tried following CLI command and it is throwing error message. can you please do the needful ?

CLI command:

kubectl testkube run test telemetrytest2 --args ‘--K6_PROMETHEUS_REMOTE_URL=https://xxxx/insert/0/prometheus/api/v1/write -o output-prometheus-remote’

Error Message:
Error: unknown shorthand flag: 'o' in -o
Usage:
testkube run test [flags]

[vsukhin]

kubectl testkube run test telemetrytest2 --variable K6_PROMETHEUS_REMOTE_URL="https://xxxx/insert/0/prometheus/api/v1/write" --args "-o output-prometheus-remote"

[nikhil-bilgi]

@vsukhin
We are facing issues with testkube not picking up the K6_PROMETHEUS_REMOTE_URL environment URL via openAPI spec.

This is the payload
{ "namespace": "testkube", "variables": { "prometheus-write": { "name": "K6_PROMETHEUS_REMOTE_URL", "value": "https://xxxx/insert/0/prometheus/api/v1/write", "type": "basic" } }, "args": [ "-o", "output-prometheus-remote" ] }

This is the testkube log
`{"type":"event","content":"running test [123123123123123123123123123]"}

{"type":"event","content":"Running [/data k6 [run -o output-prometheus-remote test-content]]"}
{"type":"line","content":"\n /\ |‾‾| /‾‾/ /‾‾/ \n /\ / \ | |/ / / / \n / \/ \ | ( / ‾‾\ \n / \ | |\ \ | (‾) | \n / __________ \ || \\ \_____/ .io\n\n"}
{"type":"line","content":"time="xxxx-xx-xxT01:21:43Z" level=info msg="Prometheus: configuring remote-write with prometheus mapping"\n"}`

[vsukhin]

You can find example in k6 executor docs
https://github.com/kubeshop/testkube-executor-k6

run k6-test-script.js from this Git repository

kubectl testkube create test --git-uri https://github.com/kubeshop/testkube-executor-k6.git --git-branch main --git-path examples --type "k6/script" --name k6-test-script-git
kubectl testkube run test --args examples/k6-test-script.js --watch k6-test-script-git

[nizamkhazi87]

You can find example in k6 executor docs https://github.com/kubeshop/testkube-executor-k6

run k6-test-script.js from this Git repository

kubectl testkube create test --git-uri https://github.com/kubeshop/testkube-executor-k6.git --git-branch main --git-path examples --type "k6/script" --name k6-test-script-git kubectl testkube run test --args examples/k6-test-script.js --watch k6-test-script-git

How to pass Prometheus parameter along with git file .. We are able to run using git but getting issue when we pass "args":[ "demo/script.js", "-o", "output-prometheus-remote" ] }

[vsukhin]

Use script name as a last parameter in argument list

[nikhil-bilgi]

@vsukhin This worked.
Thank you :)

I'll mark this ticket as done.

[vsukhin]

Glad to hear - welcome :)

[vsukhin]

Thank you, @NeoKnick We will ask @tkonieczny to checkit out