Kibana Datasweet Formula 插件使用教程

Kibana Datasweet Formula 插件使用教程

kibana-datasweet-formulaThis Kibana plugin allows calculated metrics on any standard kibana visualizations.项目地址:https://gitcode.com/gh_mirrors/ki/kibana-datasweet-formula

1. 项目的目录结构及介绍

kibana-datasweet-formula/
├── docs/
│   ├── mkdocs-theme/
│   └── ...
├── public/
│   └── ...
├── tests/
│   └── ...
├── .eslintrc.yml
├── .gitignore
├── LICENSE
├── README.md
├── build.sh
├── index.js
├── mkdocs.yml
├── package.json
└── yarn.lock

目录结构介绍

• docs/: 包含项目的文档文件，其中 mkdocs-theme/ 是文档主题文件夹。
• public/: 包含项目的公共资源文件。
• tests/: 包含项目的测试文件。
• .eslintrc.yml: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• build.sh: 项目的构建脚本。
• index.js: 项目的入口文件。
• mkdocs.yml: MkDocs 配置文件，用于生成文档。
• package.json: 项目的依赖管理文件。
• yarn.lock: Yarn 锁定文件，用于确保依赖版本一致性。

2. 项目的启动文件介绍

index.js

index.js 是 Kibana Datasweet Formula 插件的入口文件。它负责初始化插件并将其加载到 Kibana 中。以下是 index.js 的基本结构：

// index.js
import { PluginInitializerContext } from 'kibana/server';
import { DatasweetFormulaPlugin } from './plugin';

export function plugin(initializerContext: PluginInitializerContext) {
  return new DatasweetFormulaPlugin(initializerContext);
}

启动流程

1. 初始化插件: index.js 文件通过 PluginInitializerContext 初始化插件。
2. 加载插件: 插件实例被创建并加载到 Kibana 中，开始提供计算指标的功能。

3. 项目的配置文件介绍

package.json

package.json 是项目的依赖管理文件，包含了项目的元数据和依赖信息。以下是 package.json 的基本结构：

{
  "name": "kibana-datasweet-formula",
  "version": "2.2.0",
  "description": "A real time calculated metric plugin for Kibana",
  "main": "index.js",
  "scripts": {
    "build": "node build.sh",
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "Datasweet",
  "license": "Apache-2.0",
  "dependencies": {
    "kibana": "^7.0.0"
  }
}

配置项介绍

• name: 项目名称。
• version: 项目版本号。
• description: 项目描述。
• main: 项目的入口文件。
• scripts: 包含项目的脚本命令，如构建和测试。
• author: 项目作者。
• license: 项目许可证。
• dependencies: 项目的依赖包。

mkdocs.yml

mkdocs.yml 是 MkDocs 的配置文件，用于生成项目的文档。以下是 mkdocs.yml 的基本结构：

site_name: Datasweet Formula
nav:
  - Home: index.md
  - Usage: usage.md
  - Installation: installation.md
  - Functions List: functions.md
  - About: about.md

配置项介绍

• site_name: 文档站点的名称。
• nav: 文档的导航结构，定义了各个页面的路径和标题。

通过以上配置文件和目录结构，您可以更好地理解和使用 Kibana Datasweet Formula 插件。

kibana-datasweet-formulaThis Kibana plugin allows calculated metrics on any standard kibana visualizations.项目地址:https://gitcode.com/gh_mirrors/ki/kibana-datasweet-formula