The plugin.json file is required for all plugins. When Grafana starts, it scans the plugin folders and mounts every folder that contains a plugin.json file unless the folder contains a subfolder named dist. In that case, Grafana mounts the dist folder instead.
Properties
Property
Type
Required
Description
id
string
Yes
Unique name of the plugin. If the plugin is published on grafana.com, then the plugin id should follow the Grafana naming convention.
name
string
Yes
Human-readable name of the plugin that is shown to the user in the UI.
type
string
Yes
Plugin type. Possible values are: app, datasource, panel, renderer, secretsmanager.
The first part of the file name of the backend component executable. There can be multiple executables built for different operating system and architecture. Grafana will check for executables named <executable>_<$GOOS>_<lower case $GOARCH><.exe for Windows>, e.g. plugin_linux_amd64. Combination of $GOOS and $GOARCH can be found here: https://golang.org/doc/install/source#environment.
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to Authentication for data source plugins.
skipDataQuery
boolean
No
For panel plugins. Hides the query editor.
state
string
No
Marks a plugin as a pre-release. Possible values are: alpha, beta.
streaming
boolean
No
For data source plugins, if the plugin supports streaming. Used in Explore to start live streaming.
tracing
boolean
No
For data source plugins, if the plugin supports tracing. Used for example to link logs (e.g. Loki logs) with tracing plugins.
An array of screenshot objects in the form {name: 'bar', path: 'img/screenshot.png'}
author
Information about the plugin author.
Properties
Property
Type
Required
Description
email
string
No
Author's name.
name
string
No
Author's name.
url
string
No
Link to author's website.
build
Build information
Properties
Property
Type
Required
Description
branch
string
No
Git branch the plugin was built from.
hash
string
No
Git hash of the commit the plugin was built from
number
number
No
pr
number
No
GitHub pull request the plugin was built from
repo
string
No
time
number
No
Time when the plugin was built, as a Unix timestamp.
links
Properties
Property
Type
Required
Description
name
string
No
url
string
No
logos
SVG images that are used as plugin icons.
Properties
Property
Type
Required
Description
large
string
Yes
Link to the "large" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image.
small
string
Yes
Link to the "small" version of the plugin logo, which must be an SVG image. "Large" and "small" logos can be the same image.
screenshots
Properties
Property
Type
Required
Description
name
string
No
path
string
No
queryOptions
For data source plugins. There is a query options section in the plugin's query editor and these options can be turned on if needed.
Properties
Property
Type
Required
Description
cacheTimeout
boolean
No
For data source plugins. If the cache timeout option should be shown in the query options section in the query editor.
maxDataPoints
boolean
No
For data source plugins. If the max data points option should be shown in the query options section in the query editor.
minInterval
boolean
No
For data source plugins. If the min interval option should be shown in the query options section in the query editor.
routes
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to Authentication for data source plugins.
