grafana/docs/sources/plugins/app.md

page_title	page_description	page_keywords
App plugin	App plugin for Grafana	grafana, plugins, documentation

Our goal is not to have a very extensive documentation but rather have actual code that people can look at. An example implementation of an app can be found in this example app repo

Apps

App plugins is a new kind of grafana plugin that can bundle datasource and panel plugins within one package. It also enable the plugin author to create custom pages within grafana. The custom pages enables the plugin author to include things like documentation, sign up forms or controlling other services using HTTP requests.

Datasource and panel plugins will show up like normal plugins. The app pages will be available in the main menu.

Enabling app plugins

After installing an app it have to be enabled before it show up as an datasource or panel. You can do that on the app page in the config tab.

README.md

The readme file in the mounted folder will show up in the overview tab on the app page.

Module exports

export {
  ExampleAppConfigCtrl as ConfigCtrl,
  StreamPageCtrl,
  LogsPageCtrl
};

The only required export is the ConfigCtrl. Both StreamPageCtrl and LogsPageCtrl are custom pages defined in plugin.json

Custom pages

Custom pages are defined in the plugin.json like this.

"pages": [
  { "name": "Live stream", "component": "StreamPageCtrl", "role": "Editor"},
  { "name": "Log view", "component": "LogsPageCtrl", "role": "Viewer"}
]

The component field have to match one of the components exported in the module.js in the root of the plugin.

Bundled plugins

When Grafana starts it will scan all directories within an app plugin and load folders containing a plugin.json as an plugin.