发展与当地环境

按照本指南中的步骤设置一个开发环境,运行Grafana和当地你的插件。使用这个设置,您可以看到您的更改添加它们。

在您的主机运行Grafana

克隆并在本地运行Grafana:

下载和设置Grafana。指的是开发者指南。
Grafana查找插件,在默认情况下,在它数据/插件目录中。您可以创建一个符号链接到你的插件库来检测新变化:
```
ln - s < plugin-path > / dist数据/插件/ <插件名称>
```
可选的:如果前面的步骤对你不起作用(例如,如果您正在运行在Windows上),然后Grafana配置中修改默认路径。找到默认路径conf / custom.ini),点你的插件的目录:
```
(路径)插件= < path-to-your-plugin-parent-directory >
```

运行Grafana docker-compose

另一个选择是用docker-compose运行Grafana以便它运行在一个容器中。为此,创建docker-compose文件在你的插件目录中。

注意:如果你的插件已经包含一个docker-compose文件,然后跳过这一步。

版本:“3.7”服务:grafana: #与你的目标版本最新变化,如果需要图片:grafana / grafana:最新的港口:- 3000:3000 / tcp卷:#使用你的插件文件夹(例如,redshift-datasource)。/ dist: / var / lib / grafana /插件/ < plugin-folder >——。/配置:/ etc / grafana /配置环境:-项= linux - GF_LOG_LEVEL =调试GF_DATAPROXY_LOGGING = true - GF_DEFAULT_APP_MODE =发展

运行您的插件的开发模式

最后,开始你的插件的开发模式。去你的插件根目录,遵循这些步骤:

构建你的插件后端和前端开始观看模式:
```
法师- v纱看
```
启动Grafana后端和前端:
1. Grafana的本地副本,去Grafana源代码的目录并运行:
```
使运行
```
```
纱线开始
```
1. 与docker-compose,或者,在你的插件目录中,运行:
```
docker-compose起来
```

在这之后,您应该能够看到你的插件在Grafana上市,然后您可以测试您的更改。

在前端如果你做出改变,你必须刷新浏览器。然而,后台的变化可能需要重建你的插件的二进制文件并重新加载插件(法师& &法师reloadPlugin为当地的发展,或运行docker-compose起来如果您正在使用docker-compose)。

运行您的后端与调试器插件

注意:下面的方法只适用于本地Grafana实例和码头工人目前不工作。

运行一个后台插件的调试器支持Visual Studio代码和GoLand开箱即用的,但它也可以与其他IDE或调试器。

您可以运行一个后台插件并将调试器附加到它,它允许您设置断点和调试你的后端直接从IDE插件的选择:

去你的插件文件夹。
检查你的go.mod以确保grafana-plugin-sdk-go至少在v0.156.0
- 如果不是,更新到最新版本:
```
去- u github.com/grafana/grafana-plugin-sdk-go
```
构建你的插件:至少一次
```
纱构建& &法师
```
你的插件安装到您的本地Grafana实例。

现在,你的插件可以运行,按照说明波形选择的IDE。

Visual Studio代码

如果不是已经存在,去你的插件的文件夹,并将以下文件里面.vscode / launch.json:

{“版本”:“0.2.0”、“配置”:[{“名称”:“独立调试模式”,“类型”:“去”,“要求”:“发射”、“模式”:“调试”,“计划”:“$ {workspaceFolder} / pkg”、“env”:{},“参数”:["独立"]}]}

新闻F5在调试模式下运行你的插件。
如果Grafana不是已经运行,运行它。

如果你重新运行配置,Grafana自动重新加载插件。

GoLand

创建一个新的运行/调试配置:
- 运行类:包
- 包的路径:你的包裹包
- 程序参数:独立的
运行配置(有或没有调试器)。
如果Grafana不是已经运行,运行它。

注意:如果你重新运行配置,Grafana自动重新加载插件。

其他ide

配置您的代码编辑器运行以下步骤:

构建可执行文件的调试旗帜。
```
法师构建:调试
```
插件的可执行文件(在运行经销),独立的调试旗帜。
```
。/ gpx_xyz_linux_amd64独立调试
```
将调试器附加到进程。
如果Grafana不是已经运行,运行它。

如果你重新运行配置,Grafana自动重新加载插件。

笔记

所有日志打印插件的stdout而不是在Grafana日志。
如果后端插件不服务请求关闭调试模式后,你可以强制重置到独立的模式。为此,删除文件dist / standalone.txt,dist / pid.txt和可执行文件,然后重启Grafana。
Grafana不支持调试后台插件运行在码头工人。但这是一个计划增强。