API docs by Redocly

Grafana k6 Extension Registry Service (0.1.0)

Download OpenAPI specification:

License: AGPL-3.0-only Terms of Service

Query the Grafana k6 Extension Registry database.

The Grafana k6 Extension Registry Service enables read-only access to the Grafana k6 Extension Registry database.

The Grafana k6 Extension Registry database contains up-to-date information about registered extensions. The basic data of the extensions (e.g. go module path, JavaScript import path, description) are registered manually, the other data (e.g. available versions, number of stars) are retrieved automatically via the repository manager API (GitHub, GitLab, etc.).

Detailed information about response schemas can be found in the schema documentation. Schemas are defined in registry.schema.json

The source code of extensions is automatically statically analyzed. The result of the analysis is the compliance level of the best practices of Grafana k6 extensions (0-100%). Based on the compliance level, a compliance grade is also calculated (A-F). Based on the compliance grade, an SVG compliance badge is created for each extension. Example badge:

xk6-sql

The k6 Extension Catalog is an alternative representation of the k6 Extension Registry. Most queries have an alternative counterpart that returns a catalog instead of a registry.

You can try the k6 Extension Registry Service!

Information about modifying the registry (register new extensions, modify or delete existing registrations) can be found in the grafana/k6-extension-registry GitHub repository.

Find out more about Grafana k6 extensions

global

Access to the entire registry

Entire registry

Download the entire registry as a single JSON file

Responses

Response samples

Content type
application/json
[
  • {
    }
]

module

Query a specific extension

Query an extension

Query the data of a specific extension as a single JSON file

path Parameters
module
required
string
Examples:
  • github.com/grafana/xk6-dashboard -
  • github.com/grafana/xk6-sql -

go module path of the extension

Responses

Response samples

Content type
application/json
{
  • "module": "github.com/grafana/xk6-dashboard",
  • "imports": [
    ],
  • "outputs": [
    ],
  • "description": "This is a very cool extension, it displays the message 'Hello World!'",
  • "versions": [
    ],
  • "cgo": false,
  • "constraints": [
    ],
  • "repo": {},
  • "tier": "community",
  • "compliance": {
    }
}

Download a badge

Download an extension's badge as an SVG image

Example:

xk6-sql

path Parameters
module
required
string
Examples:
  • github.com/grafana/xk6-dashboard -
  • github.com/grafana/xk6-sql -

go module path of the extension

Responses

Download a grade badge

Download an extension's grade badge as an SVG image

Example:

xk6-sql

path Parameters
module
required
string
Examples:
  • github.com/grafana/xk6-dashboard -
  • github.com/grafana/xk6-sql -

go module path of the extension

Responses

catalog

Extension catalog queries

Entire catalog

Download the entire catalog as a single JSON file

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Catalog by support

Query the catalog containing extensions available with a given support.

path Parameters
tier
required
string (tier)
Enum: "official" "community"
Examples:
  • official -
  • community -

tier to be queried

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

subset

Query subsets of the registry

Subset by support

Querying the subset of the registry containing the extensions with support specified in the parameter

path Parameters
tier
required
string (tier)
Enum: "official" "community"
Examples:
  • official -
  • community -

tier to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Subset by grade

Querying the subset of the registry containing the extensions with the compliance grade specified in the parameter

path Parameters
grade
required
string (grade)
Enum: "A" "B" "C" "D" "E" "F" "G"
Examples:
  • A -
  • C -

grade to be queried

Responses

Response samples

Content type
application/json
[
  • {
    }
]

metrics

Registry metrics queries

Registry metrics

Download the registry metrics as a single JSON file

Responses

Response samples

Content type
application/json
"{\n \"cgo_count\": 1,\n \"extension_count\": 72,\n \"grade_a_count\": 19,\n \"grade_b_count\": 4,\n \"grade_c_count\": 44,\n \"grade_d_count\": 4,\n \"grade_e_count\": 1,\n \"issue_build_count\": 5,\n \"issue_codeowners_count\": 5,\n \"issue_examples_count\": 16,\n \"issue_replace_count\": 2,\n \"issue_smoke_count\": 51,\n \"issue_types_count\": 44,\n \"product_cloud_count\": 4,\n \"product_oss_count\": 71,\n \"product_synthetic_count\": 2,\n \"tier_community_count\": 54,\n \"tier_official_count\": 18,\n \"type_javascript_count\": 57,\n \"type_output_count\": 16\n}\n"

Registry metrics in Prometheus text format.

Download the registry metrics as a single TXT file in Prometheus text format

Responses

Response samples

Content type
text/plain
# HELP registry_tier_official_count Number of extensions in the 'official' tier.
# TYPE registry_tier_official_count counter
registry_tier_official_count 14 1733941259568
# HELP registry_type_javascript_count Number of JavaScript extension.
# TYPE registry_type_javascript_count counter
registry_type_javascript_count 56 1733941259568
# HELP registry_type_output_count Number of Output extension.
# TYPE registry_type_output_count counter
registry_type_output_count 16 1733941259568
# HELP registry_grade_d_count Number of D-grade extensions.
# TYPE registry_grade_d_count counter
registry_grade_d_count 2 1733941259568
# HELP registry_issue_examples_count Number of extensions without examples directory.
# TYPE registry_issue_examples_count counter
registry_issue_examples_count 14 1733941259568
# HELP registry_tier_community_count Number of extension in the community' tier.
# TYPE registry_tier_community_count counter
registry_tier_community_count 57 1733941259568
# HELP registry_grade_a_count Number of A-grade extensions.
# TYPE registry_grade_a_count counter
registry_grade_a_count 22 1733941259568
# HELP registry_grade_c_count Number of C-grade extensions.
# TYPE registry_grade_c_count counter
registry_grade_c_count 44 1733941259568
# HELP registry_extension_count The total number of extensions.
# TYPE registry_extension_count counter
registry_extension_count 71 1733941259568
# HELP registry_issue_smoke_count Number of extensions without smoke test script.
# TYPE registry_issue_smoke_count counter
registry_issue_smoke_count 49 1733941259568
# HELP registry_tier_unofficial_count Number of unofficial extensions.
# TYPE registry_tier_unofficial_count counter
registry_tier_unofficial_count 11 1733941259568
# HELP registry_issue_build_count Number of extensions not buildable with the latest k6 version.
# TYPE registry_issue_build_count counter
registry_issue_build_count 3 1733941259568
# HELP registry_grade_b_count Number of B-grade extensions.
# TYPE registry_grade_b_count counter
registry_grade_b_count 2 1733941259568
# HELP registry_grade_e_count Number of E-grade extensions.
# TYPE registry_grade_e_count counter
registry_grade_e_count 1 1733941259568
# HELP registry_cgo_count Number of extensions requiring cgo.
# TYPE registry_cgo_count counter
registry_cgo_count 1 1733941259568
# HELP registry_issue_replace_count Number of extensions with replace directive in go.mod.
# TYPE registry_issue_replace_count counter
registry_issue_replace_count 2 1733941259568
# HELP registry_issue_types_count Number of extensions without API declaration file.
# TYPE registry_issue_types_count counter
registry_issue_types_count 42 1733941259568

Subset of registry metrics for tier.

Download the registry metrics for tier as a single JSON file

Responses

Response samples

Content type
application/json
"{\n \"cgo_count\": 1,\n \"extension_count\": 72,\n \"grade_a_count\": 19,\n \"grade_b_count\": 4,\n \"grade_c_count\": 44,\n \"grade_d_count\": 4,\n \"grade_e_count\": 1,\n \"issue_build_count\": 5,\n \"issue_codeowners_count\": 5,\n \"issue_examples_count\": 16,\n \"issue_replace_count\": 2,\n \"issue_smoke_count\": 51,\n \"issue_types_count\": 44,\n \"product_cloud_count\": 4,\n \"product_oss_count\": 71,\n \"product_synthetic_count\": 2,\n \"tier_community_count\": 54,\n \"tier_official_count\": 18,\n \"type_javascript_count\": 57,\n \"type_output_count\": 16\n}\n"