Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Enterprise Open source

Plugin.json

The plugin.json file is mandatory for all plugins. When Grafana starts it will scan the plugin folders and mount every folder that contains a plugin.json file unless the folder contains a subfolder named dist. In that case grafana will mount the dist folder instead.

Plugin.json Schema

PropertyDescription
idUnique name of the plugin. See naming conventions described in styleguide
typeOne of app, datasource, panel
nameHuman-readable name of the plugin
dependencies.grafanaVersionRequired Grafana version for this plugin
dependencies.pluginsAn array of required plugins on which this plugin depends
info.author.nameAuthor’s name
info.author.urlLink to author’s website
info.descriptionDescription of plugin. Used for search on grafana.com
info.keywordsArray of plugin keywords. Used for search on grafana.com
info.linksAn array of link objects to be displayed on this plugin’s project page in the form {name: 'foo', url: 'http://example.com'}
info.logos.smallLink to the “small” version of the plugin logo, which must be an SVG image. “Large” and “small” logos can be the same image.
info.logos.largeLink to the “large” version of the plugin logo, which must be an SVG image. “Large” and “small” logos can be the same image.
info.screenshotsAn array of screenshot objects in the form {name: 'bar', path: 'img/screenshot.png'}
info.updatedDate when this plugin was built. Use %TODAY% for Grafana to autopopulate this value.
info.versionProject version of this commit. Use %VERSION% for Grafana to autopopulate this value.

Plugin.json Example

Here’s an example of an up-to-date plugin.json file:

https://github.com/grafana/clock-panel/blob/master/src/plugin.json