Documentation Grafana Cloud Testing and synthetics Synthetic Monitoring Create checks Check types k6 scripted check

k6 scripted check

k6 scripted checks can execute k6 tests in Synthetic Monitoring. Use k6 scripted checks to monitor transactions and user flows by implementing workflows, custom logic, and validations in JavaScript.

With k6 scripted checks, you can:

• Define custom user behavior and complex request logic.
• Leverage the flexibility of a scripting language.
• Test HTTP/S and WebSocket services.
• Utilize the k6 API and other JavaScript libraries.
• Enable OpenTelemetry traces for server-side correlation.
• Reuse the same k6 script for distinct testing goals.

How it works

Get started

You can write and execute a k6 script from the code editor in the Synthetics UI.

1. On the left-side menu, select Testing & synthetics and then Synthetics.
2. Click Create new check or Add new check.
3. Choose k6 scripted as your check type.
4. Set the value for the required options.
5. Edit or copy your k6 script under Script.
6. Schedule or run the check.
   1. Click Save to schedule the check.
   2. Click Test to run the k6 script.

For development and debugging, you can write and execute the k6 script from your local machine using the k6 CLI and your IDE. After completing the k6 script, create a new scripted check or update the script of an existing one.

The Synthetics script editor includes a few scripts with basic examples. To get started implementing your first k6 scripts, refer to:

• Running k6
• k6 test for functional behavior

Select a k6 version channel

You can choose which k6 version channel runs the check from the k6 version channel dropdown on the Script step. For details, refer to Manage k6 versions.

Options

The list of common options to all check types:

Additionally, k6 scripted checks have the following options:

Supported k6 Options

k6 options can be used to configure a wide range of features when running the k6 script. In Synthetic Monitoring, k6 options can only be set in the script options object:

JavaScript Copy

export const options = {
  tags: { foo: 'bar' },
  userAgent: 'MyK6UserAgentString/1.0',
};

Several k6 options don’t apply in the context of Synthetic Monitoring. Here is the list of supported options:

Expand table

k6 Option	Description
batch	Max number of simultaneous connections of a http.batch() call
batch-per-host	Max number of simultaneous connections of a http.batch() call for a host
discardResponseBodies	Specify whether response bodies should be discarded
httpDebug	log all HTTP requests and responses
insecureSkipTLSVerify	A boolean specifying whether k6 should ignore TLS verifications for connections established from code
maxRedirects	The maximum number of HTTP redirects that k6 will follow
noConnectionReuse	A boolean specifying whether k6 should disable keep-alive connections
setupTimeout	Specify how long the setup() function is allow to run before it’s terminated
systemTags	Specify which System Tags will be in the collected metrics
tags	Specify tags that should be set test-wide across all metrics
teardownTimeout	Specify how long the teardown() function is allowed to run before it’s terminated
throw	A boolean specifying whether to throw errors on failed HTTP requests
tlsAuth	A list of TLS client certificate configuration objects
tlsCipherSuites	A list of cipher suites allowed to be used by in SSL/TLS interactions with a server
tlsVersion	String or object representing the only SSL/TLS version allowed
userAgent	A string specifying the User-Agent header when sending HTTP requests

Metrics

Synthetic checks store their results as Prometheus metrics, including the list of common metrics to all check types:

k6 metrics

Scripted checks also collect the metrics produced by k6 and store them as Prometheus metrics.

k6 has two types of metrics:

• Built-in metrics: These are metrics collected by every k6 test, such as data received and total number of requests.
• Custom metrics: These are metrics that you can create in your test script to measure anything that’s specific to your system or business logic. In Prometheus, they’re renamed to probe_K6_METRIC_NAME and mapped to Prometheus gauges.

k6 built-in metrics are transformed in Synthetic Monitoring as follows:

Visualization

You can query all the produced check metrics with Grafana Explore, where you can create custom panels and add them to your dashboards.

Additionally, each check includes a dashboard displaying the results of the most relevant metrics. To learn more about the various visualization options, refer to Analyze results.

Compatibility

Load local files

For security reasons, probes can’t load local files. k6 APIs such as open, fs, and grpc.load (non-reflection) aren’t supported.

To import local modules or libraries, use a bundler to build your k6 script with its dependencies locally, then copy the output into the script option.