Grafana 插件类型和使用介绍一

591 阅读5分钟

插件类型和使用 

了解不同类型的Grafana插件、其使用和配置。 

后端插件

了解用于扩展Grafana功能的Grafana后端插件系统。 

 Grafana plugin SDK for Go 

了解用于Go语言开发的Grafana插件SDK。 

 Life cycle of a plugin 

了解Grafana插件的生命周期。 

插件协议 

了解用于插件开发的Grafana插件协议。 

###  Data frames 

了解用于Grafana插件开发的Data frames。

###  NPM dependencies

了解Grafana插件中的前端NPM依赖项。

插件类型和使用

注意:本文档讨论插件开发者的插件配置、配置和用法。有关插件管理的通用信息请参见插件管理。

概述

Grafana插件开发可以根据您想要创建的用户体验类型提供多种选项。无论您的需求是什么,都有一个支持的插件类型可供您使用:

  • 面板插件 - 一种数据可视化的新方法。
  • 数据源插件 - 连接到新数据库或其他数据源的连接。
  • 应用程序插件 - 一种开箱即用的集成体验。

请参阅Get started了解如何快速为每种类型的插件搭建脚手架。

1、面板(可视化)插件

开发面板插件,也称为可视化插件,允许Grafana使用自定义可视化,类似于现有的插件,例如Polystat面板。

面板插件的使用

任何已安装的面板类型插件都可以在仪表板内作为可视化进行使用、选择和配置。 与数据源和应用程序相比,目前不支持在Grafana组织级别上配置可视化。

注意

随着Grafana场景的最新引入,您可以在场景实现中使用任何已安装的面板类型插件作为可视化。

2、 数据源插件

在插件开发中,您可以创建新的数据源插件,以便使用Grafana与新数据库配合使用,类似于现有的插件,如MongoDB或Google BigQuery。数据源插件可以在前端和后端添加。

数据源插件的用法

当您想要使用第三方服务提供的数据在Grafana仪表板、探索、警报等中工作时,请创建和配置Grafana数据源。

对于任何已安装的数据源类型插件,您可以为Grafana组织创建和配置任意数量的数据源。创建0到无穷个数据源后,它们将在Grafana的数据库中持久存在。

注意

为了将Grafana数据源与数据源插件区分开来,我们有时将后者称为数据源实例,即具有插件id类型为datasource的已配置Grafana数据源。

数据源插件的全局配置

使用 Grafana 配置文件配置您的应用程序 plugin_id.。

INFO 并非所有插件都支持此类配置。有关详细信息,请参阅特定插件的 readme 文件。

数据源的配置

您还可以使用 Grafana 的配置功能来配置数据源,以便在 Grafana 启动或按需时将 Grafana 作为代码定义作为 GitOps 方法的一部分。

请注意,类型为 data-source 的插件必须先安装,然后才能进行配置。

仪表板的捆绑

数据源插件可以通过在插件.json 文件中引用dashboard JSON 文件(包括属性和 type=dashboard)来包含仪表板。导入时,Grafana 将仪表板放在 General 文件夹中。

3、应用程序插件

开发应用程序插件,也称为应用程序或应用,可以创建开箱即用的解决方案,例如Redis应用中的解决方案。您可以附加数据源和面板,并提供自定义页面、场景和UI扩展。

3.1 应用程序插件的使用

当您想要利用第三方服务的定制监控视图或创建该视图时,可以使用Grafana应用程序进行配置,并可选择使用自定义页面或UI扩展。对于已安装的任何类型为应用程序的插件,您可以在Grafana组织中启用它们一次,并将它们持久存储在Grafana数据库中。

注意:为了区分Grafana应用程序与应用程序插件,我们有时将后者称为应用程序实例,即已配置的具有插件id类型为应用程序的Grafana应用程序。

3.2 应用程序插件的全局配置​

使用Grafana配置文件来配置您的应用程序 plugin_id。

信息:并非所有插件都支持这种类型的配置。有关详细信息,请参阅特定插件的readme。

3.2.1 应用程序插件的配置

应用程序也可以使用Grafana的配置功能进行配置,以便在Grafana启动时或按需定义Grafana作为代码的一部分,采用GitOps方法。

请注意,在配置成功之前,必须先安装插件id为应用程序类型的插件。

3.2.2应用程序的打包​

应用程序插件类型允许您在其中嵌套其他插件;换句话说,将多个插件打包或包含在同一个包中。

3.2.3 仪表板的打包​

应用程序插件可以通过在plugin.json中引用包括属性和类型=仪表板的仪表板JSON文件来包含仪表板。当导入时,Grafana将仪表板放在General文件夹中,这将在启用应用程序时自动发生。

原文地址:grafana.com/developers/…