技术标签: 前端环境 开发grafana的panel插件
<1>推荐一个网址:http://blog.leanote.com/post/nixon/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91
Grafana Panel Plugin 开发
上一次分享提到过Grafana的插件氛围三种类型(Panel, Datasource, App),这一次主要记录Panel类型的插件开发.
根据官网的描述, 插件包一般放在/var/lib/grafana/plugins
或者data/plugins
(相对Grafana源码目录). 前者是生产环境, 后者是开发环境. 所以我们这一次选择后者, 毕竟一会儿要从源码修改Grafana的前端代码, 然后启动go语言编写的后端.
基础知识准备:
angularjs, systemjs, typescript, jquery, echarts, grunt, nodejs and golang.
先把官网上说明需要的文件目录加上.
johnnyb-awesome-datasource
|-- dist # 存放编译打包后的插件代码
|-- spec # 测试代码
| |-- datasource_spec.js
| |-- query_ctrl_spec.js
| |-- test-main.js
|-- src # 插件源码
| |-- img # 需要的图片, 比如LOGO, 可选
| | |-- logo.svg
| |-- partials # 界面文件, 可选
| | |-- annotations.editor.html
| | |-- config.html
| | |-- query.editor.html
| |-- datasource.js
| |-- module.js # 唯一入口文件
| |-- plugin.json # 插件描述文件
| |-- query_ctrl.js
|-- Gruntfile.js # Grunt任务
|-- LICENSE
|-- package.json
|-- README.md # 这也会显示在插件说明中
README.md: The only difference from how GitHub renders markdown is that html is not allowed.
实际上并不需要严格按照上述目录存放文件, 关键点在于: 插件目录下需要有src/
, dist/
. src/
中需要有module.js
和plugin.json
. 其他开心就好.
所以实际上, 我的目录结构是这样:
practice-panel
|-- dist # 存放编译打包后的插件代码
|-- src # 插件源码
| |-- partials # 界面文件, 可选
| | |-- module.html
| | |-- module.editor.html
| |-- module.js # 唯一入口文件
| |-- plugin.json # 插件描述文件
| |-- controller.js # 分离出来的Controller, 也可全部放在module.js里面
|-- Gruntfile.js # Grunt任务描述
|-- package.json
|-- README.md
然后来认识一个文件, 这个文件是用来描述插件的. 包括插件的唯一标识, 名字, 作者, 版本等等. 全文是这样的:
{
"id": "",
"type": "",
"name": "",
"info": {
"description": "",
"author": {
"name": "",
"url": ""
},
"keywords": [],
"logos": [
"small": "",
"large": ""
],
"version": ""
},
"dependencies": {
"grafanaVersion": "",
"plugins": []
}
}
具体的含义, 参考附录中的官方说明链接. 本次的内容参考源码文件.
这基本上就是约定, Grafana会从插件包的dist/
第一个读取的文件就是module.js
文件. 不管用什么语言编写, 最终都要保证dist/module.js
可读.
Grafana的前端模块化方案采用的Systemjs. 如果熟悉任何一种模块化方案都行, 这里的影响并不是很大, 除了需要添加依赖资源. 在插件开发过程中, 开发者是无法添加任何依赖资源的. 因为插件是作为Grafana前端整体的一部分在运行. 所有的资源配置都写在Grafana源码目录的public/app/system.conf.js
文件中, 资源都放在public/vendor/
目录中.
默认可用资源如下:
virtual-scroll
mousetrap
remarkable
tether
eventemitter3
tether-drop
moment
jquery
lodash-src
lodash
angular
bootstrap
angular-route
angular-sanitize
angular-ui
angular-strap
angular-dragdrop
angular-bindonce
spectrum
bootstrap-tagsinput
jquery.flot
jquery.flot.pie
jquery.flot.selection
jquery.flot.stack
jquery.flot.stackpercent
jquery.flot.time
jquery.flot.crosshair
jquery.flot.fillbelow
jquery.flot.gauge
d3
jquery.flot.dashes
是的, 像D3, jquery, moment, lodash这些非常有用的图表基础库都有了, 甚至很贴心的连AngularJS全家桶都有. 美中不足的是AngularJS版本偏低: 1.6.1
.
但这一次练习, 我们要用echarts来构建图表. 很遗憾, Grafana没有这项资源. 所以总共需要修改二个地方.
echarts.min.js
放入public/vendor/
目录修改public/app/system.conf.js
文件, 在paths
节点中添加代码: 'echarts': 'vendor/echarts.min.js',
上下文看起来像这样:
'tether-drop': 'vendor/npm/tether-drop/dist/js/drop.js',
'moment': 'vendor/moment.js',
'echarts': 'vendor/echarts.min.js',
'jquery': 'vendor/jquery/dist/jquery.js',
准备工作基本完成了, 但是编码之前, 需要认识一个类: MetricsPanelCtrl
. 这个类的源码文件位于Grafana源码目录下public/app/features/panel/metrics_panel_ctrl.ts
. MetricsPanelCtrl
类继承自PanelCtrl
类, 是我们完成本次Panel类型插件开发必须要用到的. 它主要是解决了以下三个问题:
在进入编辑状态后, 使metrics Tab成为默认面板.
constructor($scope, $injector) {
super($scope, $injector);
// make metrics tab the default
this.editorTabIndex = 1;
// ... other code
}
订阅事件:
this.events.on('refresh', this.onMetricsPanelRefresh.bind(this));
this.events.on('init-edit-mode', this.onInitMetricsPanelEditMode.bind(this));
this.events.on('panel-teardown', this.onPanelTearDown.bind(this));
提供设置数据源后的响应:
setDatasource(datasource) {
// ... other code
this.panel.datasource = datasource.value;
this.datasourceName = datasource.name;
this.datasource = null;
this.refresh();
}
因为文档中并无特别描述, 所以以下是已知的插件支持的事件:
refresh
can be used to response when refresh button was clicked.init-edit-mode
can be used to add tabs when editing a panelpanel-teardown
can be used for clean updata-received
is an event in that is triggered on data refresh and can be hooked intodata-snapshot-load
is an event triggered to load data when in snapshot mode.data-error
is used to handle errors on dashboard refresh.Controller类必须实现link方法或者init方法. 这是Grafana的插件机制决定的. 与此同时, Controller的实例对象也将作为AngularJS组件的上下文对象存在.
// app/core/directives/plugin_component.ts
function getPluginComponentDirective(options) {
// other code
return function() {
return {
// other code
link: (scope, elem, attrs, ctrl) => {
if (ctrl.link) {
ctrl.link(scope, elem, attrs, ctrl);
}
if (ctrl.init) {
ctrl.init();
}
}
}
}
}
而这个函数是作为AngularJS的指令处理函数存在的. 所以我们的controller.js看起来至少应该是这样的:
import { MetricsPanelCtrl } from 'app/plugins/sdk';
export class Controller extends MetricsPanelCtrl {
constructor() {
// initialize
// subscribe events
}
link(scope, elem, attrs, ctrl) {
// impelement linking
}
}
完整实现细节请参考源码文件.
是的, 此时还没有界面. 在编写界面之前, 我们先了解一下插件的二种状态.
插件有二种状态, 一种是只读状态, 一种是编辑状态. 只读状态就是打开一个dashboard时各个Panel表现的状态. 编辑状态是点击”Edit”之后, 进入的可以影响数据源的状态. 我们需要分别为这二种状态编写页面.
完整实现细节参考源码文件.
Grafana提供一些布局样式和外观样式. 非常不幸, 我没有在官方文档上找到对应的样式说明. 不过幸运的是, 插件目前只有三种, 而且三种都提供了Example代码. 分别是:
https://github.com/grafana/piechart-panel
https://github.com/grafana/simple-json-datasource
https://github.com/grafana/kubernetes-app
这一次练习则是copy的piechart-panel的编辑页面. 用起来有点类似bootstrap的感觉.
好了, 重点来了: 在编写完成界面后, 需要将界面和controller关联在一起.
只读状态的界面关联方法是在controller.js中声明完Controller类后, 添加静态属性字段:
Controller.templateUrl = './partials/module.html';
编辑状态的界面则需要在init-edit-mode
事件处理函数中注册:
onInitEditMode() {
this.addEditorTab('Options', 'public/plugins/practice-panel/partials/module.editor.html', 2);
}
完整实现细节参考源码文件.
编译Grafana官方使用的是Grunt, 实际上只要按照目录结构来, 用什么打包工具并不重要.
grunt
一个练习插件就这么完成了.
一种数据的四种表现形式. 其中右下角红色的柱状图即本次练习插件.
图表数据Grafana只支持二种, 时序图和非时序图. 非时序图仅返回一个普通的数据结构:
文章浏览阅读3.8k次,点赞9次,收藏28次。直接上一个工作中碰到的问题,另外一个系统开启多线程调用我这边的接口,然后我这边会开启多线程批量查询第三方接口并且返回给调用方。使用的是两三年前别人遗留下来的方法,放到线上后发现确实是可以正常取到结果,但是一旦调用,CPU占用就直接100%(部署环境是win server服务器)。因此查看了下相关的老代码并使用JProfiler查看发现是在某个while循环的时候有问题。具体项目代码就不贴了,类似于下面这段代码。while(flag) {//your code;}这里的flag._main函数使用while(1)循环cpu占用99
文章浏览阅读347次。idea shift f6 快捷键无效_idea shift +f6快捷键不生效
文章浏览阅读135次。Ecmacript 中没有DOM 和 BOM核心模块Node为JavaScript提供了很多服务器级别,这些API绝大多数都被包装到了一个具名和核心模块中了,例如文件操作的 fs 核心模块 ,http服务构建的http 模块 path 路径操作模块 os 操作系统信息模块// 用来获取机器信息的var os = require('os')// 用来操作路径的var path = require('path')// 获取当前机器的 CPU 信息console.log(os.cpus._node模块中有很多核心模块,以下不属于核心模块,使用时需下载的是
文章浏览阅读10w+次,点赞435次,收藏3.4k次。SPSS 22 下载安装过程7.6 方差分析与回归分析的SPSS实现7.6.1 SPSS软件概述1 SPSS版本与安装2 SPSS界面3 SPSS特点4 SPSS数据7.6.2 SPSS与方差分析1 单因素方差分析2 双因素方差分析7.6.3 SPSS与回归分析SPSS回归分析过程牙膏价格问题的回归分析_化工数学模型数据回归软件
文章浏览阅读7.5k次。如何利用hutool工具包实现邮件发送功能呢?1、首先引入hutool依赖<dependency> <groupId>cn.hutool</groupId> <artifactId>hutool-all</artifactId> <version>5.7.19</version></dependency>2、编写邮件发送工具类package com.pc.c..._hutool发送邮件
文章浏览阅读867次,点赞2次,收藏2次。docker安装elasticsearch,elasticsearch-head,kibana,ik分词器安装方式基本有两种,一种是pull的方式,一种是Dockerfile的方式,由于pull的方式pull下来后还需配置许多东西且不便于复用,个人比较喜欢使用Dockerfile的方式所有docker支持的镜像基本都在https://hub.docker.com/docker的官网上能找到合..._docker安装kibana连接elasticsearch并且elasticsearch有密码
文章浏览阅读1.3w次,点赞57次,收藏92次。整理 | 郑丽媛出品 | CSDN(ID:CSDNnews)近年来,随着机器学习的兴起,有一门编程语言逐渐变得火热——Python。得益于其针对机器学习提供了大量开源框架和第三方模块,内置..._beeware
文章浏览阅读7.9k次。//// ViewController.swift// Day_10_Timer//// Created by dongqiangfei on 2018/10/15.// Copyright 2018年 飞飞. All rights reserved.//import UIKitclass ViewController: UIViewController { ..._swift timer 暂停
文章浏览阅读986次,点赞2次,收藏2次。1.硬性等待让当前线程暂停执行,应用场景:代码执行速度太快了,但是UI元素没有立马加载出来,造成两者不同步,这时候就可以让代码等待一下,再去执行找元素的动作线程休眠,强制等待 Thread.sleep(long mills)package com.example.demo;import org.junit.jupiter.api.Test;import org.openqa.selenium.By;import org.openqa.selenium.firefox.Firefox.._元素三大等待
文章浏览阅读3k次,点赞4次,收藏14次。Java软件工程师职位分析_java岗位分析
文章浏览阅读2k次。Java:Unreachable code的解决方法_java unreachable code
文章浏览阅读1w次。1、html中设置标签data-*的值 标题 11111 222222、点击获取当前标签的data-url的值$('dd').on('click', function() { var urlVal = $(this).data('ur_如何根据data-*属性获取对应的标签对象