xk6-sm

Warning

Heads up, Synthetic Monitoring users: You do not need to build or download this. A k6 binary compiled with this extension is already shipped in our agent packages.

Output k6 extension used by the synthetic monitoring agent.

Configuration

By default, this extension will drop all metrics which have a resource_type tag when the value for the tag is not Document. This is done to avoid generating metrics for every URL that a k6 script using browser would normally generate, including those for images, scripts, and others.

This resource_type allowlist is configurable by means of the SM_K6_BROWSER_RESOURCE_TYPES environment variable, which should be set to a comma-separated list of resource_types that should not be dropped. The list of known resource_types can be found here.

This matching is case-insensitive, and the special value * will cause every resource_type to be retained. Conversely, an empty list will cause all metrics from browser to be omitted.

Build

Use xk6. See the CI/CD pipelines for a full example of a build command.

Release process

Merge the release PR created by release-please. Once a release is created in github, a CI/CD pipeline will build the artifacts and attach them to the release.