Files
grafana/docs/sources/shared/tutorials/create-plugin.md
Kate Brenner 17b8d28cae Update build a datasource plugin tutorial (#66381)
* update tutorial

* add punctuation
2023-04-25 12:20:14 -06:00

1.2 KiB
Executable File

title
Create Plugin

Tooling for modern web development can be tricky to wrap your head around. While you certainly can write your own webpack configuration, for this guide, you'll be using grafana create-plugin tool

Grafana create-plugin tool is a CLI application that simplifies Grafana plugin development, so that you can focus on code. The tool scaffolds a starter plugin and all the required configuration for you.

  1. In the plugin directory, create a plugin from template using create-plugin. When prompted for the kind of plugin, select datasource:

    npx @grafana/create-plugin@latest
    
  2. Change directory to your newly created plugin:

    cd my-plugin
    
  3. Install the dependencies:

    yarn install
    
  4. Build the plugin:

    yarn dev
    
  5. Restart the Grafana server for Grafana to discover your plugin.

  6. Open Grafana and go to Connections -> Connect Data. Make sure that your data source is there.

By default, Grafana logs whenever it discovers a plugin:

INFO[01-01|12:00:00] Plugin registered       logger=plugin.loader pluginID=my-plugin