The source of the k6 Extension Registry https://registry.k6.io
Check the Contributing Guidelines for the extension registration process.
Check the Wiki for up-to-date reports based on registry content.
A custom registry can be created and maintained using the k6registry tool. The content of the registry and the catalog can be fully controlled by the user.
Only those properties of the extensions are registered, which either cannot be detected automatically, or delegation to the extension is not allowed.
Properties that are available using the repository manager API (GitHub API, GitLab API, etc) are intentionally not registered. For example, the number of stars can be queried via the repository manager API, so this property is not registered.
Exceptions are the string-like properties that are embedded in the Grafana documentation. These properties are registered because it is not allowed to inject arbitrary text into the Grafana documentation site without approval. Therefore, these properties are registered (eg description)
The properties provided by the repository managers are queried during registry processing and can be used to produce the output properties.
example entry
- module: github.com/grafana/xk6-sql
description: Load test SQL Servers
imports:
- k6/x/sql
tier: official
products: ["cloud", "oss"]
categories:
- dataThe primary identifier of an extension is the extension's go module path. Required
Brief description of the extension. Required
The JavaScript module names implemented by the extension.An extension can register multiple JavaScript module names, so this is an array property. Either imports or outputs are required
The output names implemented by the extension. An extension can register multiple output names, so this is an array property. Either imports or outputs are required
Refers to the maintainer of the extension. Optional, defaults to community
Extensions owned by the grafana GitHub organization are not officially supported by Grafana by default.
Products in which the extension can be used. Optional, defaults to ["oss"]
The categories to which the extension belongs. Optional, defaults to ["misc"]
List of supported versions. Optional, the default is to query the repository manager API
Normally, the registration does not include this property, it is automatically queried using the repository manager API. Automation can be disabled by setting it and only the versions specified here will be available.
Version constraints. Optional, the default is to use all detected versions
Version constraints are primarily used to filter automatically detected versions. It can also be used to filter the versions property imported from the origin registry.
Flag indicating the need for cgo. Optional, cgo is not enabled by default
The cgo property value true indicates that cgo must be enabled to build the extension.
The schema documentation contains a detailed description of the properties available in the registry.
Check the Contributing Guidelines for contributing to the registry schema.