npm 包 import-kibana-dashboard 使用教程

Kibana Dashboard 是 ELK Stack 的重要组成部分之一。它可以帮助我们实时监控日志数据并快速定位异常问题。但是如果要手动创建一个完整的 Dashboard 是非常困难的,很多公司都采用了内部工具来自动生成 Kibana Dashboard。而 import-kibana-dashboard 正是一个为了方便 Kibana Dashboard 的生成而生的工具。

在本文中,我们将会学习如何使用 import-kibana-dashboard,他提供的几个重要功能,并给出一个用例来展示如何快速地生成一个 Kibana Dashboard。

import-kibana-dashboard 介绍

import-kibana-dashboard 是一个使用 Node.js 编写的命令行工具,通过读取 JSON 格式的配置文件生成一个 Kibana Dashboard。当我们使用这个工具时,需要先提供 ELand Kibana 的 URL,然后通过一些必备配置信息,生成一个 JSON 文件。

这个 JSON 文件可以直接上传至 Kibana 并使用。

import-kibana-dashboard 的功能

import-kibana-dashboard 提供了多个生成 Kibana Dashboard 的配置选项。这些选项包括源索引、过滤器、时间范围、时间字段等等。下面是一些重要的配置选项:

  • indexPattern:指向 Elasticsearch 的索引名称,Kibana 利用它来搜索并过滤 Elasticsearch 的数据。

  • timeFieldName:时间戳用于过滤 Elasticsearch 数据。

  • filters: 一个对象数组,每个对象都描述了一个 filter,可以用来过滤 Elasticsearch 数据。

  • query:一个简单的 Elasticsearch 查询。

  • panelsJSON:一个对象数组,每个对象都描述了要创建的 Kibana 可视化图表和面板。

  • timeRange:时间范围,格式为 YYYY/MM/DD。

import-kibana-dashboard 的安装

使用 import-kibana-dashboard 之前,需要先安装它。使用 npm 可以轻松地完成这个过程:

--- ------- -- -----------------------

Kibana Dashboard 使用示例

在这个示例中,我们将会使用 import-kibana-dashboard 生成一个日志监控的 Kibana Dashboard。

我们的数据源是一个 Elasticsearch 索引,它有多个字段,例如:timestamp, source, severity, message。我们的目标是创建一个 Kibana Dashboard ,其中包含三个可视化面板:

  • 表格,展示按来源分组的事件数。

  • 条形图,按严重程度分组的日志计数。

  • 时间线图,展示最近 24 小时的日志事件数。

第一步:创建仪表盘 JSON 文件

在安装了 import-kibana-dashboard 之后,使用下面的命令创建一个仪表盘 JSON 文件:

----------------------- -
  -------- --------------------- -
  --------------- ---------- -
  ------------ --------- -
  ------------- ------------- -
  ---------------- --- ----------

其中, --es_url 是 Elasticsearch 的 URL, --indes_pattern 是 Elasticsearch 索引的名称, --time_field 是时间戳, --panels_json 是我们上面提到的可视化面板 JSON 文件。

第二步:创建可视化面板 JSON 文件

在第一步中,我们创建了一个仪表盘 JSON 文件,但是还没有包含任何可视化面板。面板通常是一个带有可视化图表的小部件,可用于向业务用户展示数据。在我们的示例中,我们创建了三个可视化面板。下面是表格面板的 JSON 文件示例:

-
  ----- --------------
  ------- --------
  -------- ---- ---------
  --------- --
  --------- --
  ---------- -
    ---- --
    ---- --
    ---- ---
    ---- -
  --
  ---------- -
    ------------ ------
    ----------- ------
    ----------- -----
    ------------------ -
      --
      ---
      ---
      ---
      ---
    --
    --------- ---
    ------------ ------
  --
  ---------- ---
  ---------- -
    -
      -------- ---------
      -------- ---------
      -------- -----
      ------------- -----
      ----------- -----
      ---------------- -----
    --
    -
      -------- ---------
      -------- ---------
      -------- -----
      ------------- ------
      ----------- -----
      ---------------- ------
    -
  --
  --------------- -
    -------- -------------
    -------- -
      --------------- -
        -------- ----------------- -- ---------------
      -
    --
    --------- --
  -
-

可以看到,这个 JSON 文件包括整个表格面板的全部参数,包括标题、大小、位置、属性和过滤器等等。其他两个面板的 JSON 文件可以在这里获取 https://github.com/grafana/grafana/blob/master/public/app/plugins/datasource/elasticsearch/migrations/v6/panels_v6.ts。

第三步:上传到 Kibana 并使用

完成上述步骤之后,我们就可以将生成的 JSON 文件上传至 Kibana 中,并将其设置为默认的 Dashboard。

在 Kibana 中,你可以通过页面的左侧导航栏访问到自己创建的 Dashboard。

总结

使用 import-kibana-dashboard 可以轻松自动生成 Kibana Dashboard,非常适合那些希望省去手动创建 Dashboard 的人员。在这篇文章中,我们介绍了 import-kibana-dashboard 工具和它提供的重要配置选项,然后展示了一个使用实例。

在实际工作中,每个企业的需求都是不同的,可以根据 import-kibana-dashboard 工具提供的参数自定义生成仪表盘的部分内容,这也是 import-kibana-dashboard 工具的优势所在。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005670081e8991b448e3438


猜你喜欢

  • npm 包 passport-steam-thetown 使用教程

    前言 在前端开发中,用户登录授权是一个必不可少的功能。而通过 Steam 账号进行登录授权则是越来越普遍的方式。passport-steam-thetown 是一个基于 Node.js 平台的 Ste...

    3 年前
  • npm 包 serverless-stack-output 使用教程

    在 Serverless 架构中,经常需要将资源创建的输出值(如 API 网关 URL、数据库地址、S3 存储桶名称等)传递给其他函数或服务。serverless-stack-output 是一个 N...

    3 年前
  • npm 包 groupcenter-modal-slip-frontend 使用教程

    简介 npm是Node.js的包管理器,通过npm,可以安装并管理各种前端和后端所需的第三方包。groupcenter-modal-slip-frontend是一款基于Vue.js封装的、用于移动端滑...

    3 年前
  • npm 包 @mlogan1313/react-bootstrap-table 使用教程

    前言 React 作为一款流行的 JavaScript 库,被广泛应用于前端开发中。当我们在 React 项目中需要使用表格组件时,通常需要借助第三方库来实现。而 @mlogan1313/react-...

    3 年前
  • npm 包 generator-koa-start 使用教程

    什么是 generator-koa-start geneartor-koa-start 是一个基于 Yeoman 的 Koajs 脚手架生成器,可以快速生成一个带有基本配置的 Koajs 项目骨架。

    3 年前
  • npm 包 dxexcel-collab 使用教程

    简介 dxexcel-collab 是一个基于 JavaScript 的 npm 包,可以实现 Excel 表格的在线协作编辑。具有前端展示友好、操作简单的特点。 安装 使用 npm 安装 --- -...

    3 年前
  • npm 包 ember-cli-deploy-index-json 使用教程

    在前端开发中,使用 ember-cli-deploy-index-json npm 包可以方便地将 index.html 文件部署到远端服务器,并自动更新文件版本号。

    3 年前
  • npm 包 esp3 使用教程

    在前端开发中,我们经常需要使用各种 npm 包来帮助我们实现特定的功能。其中,esp3 是一个非常实用的 npm 包,它提供了一系列用于处理和解析 EnOcean Sensor Profile 3 (...

    3 年前
  • md-date-time-picker-ilkkah 使用教程

    在前端开发中,时间选择控件是一个非常常见的需求。而 md-date-time-picker-ilkkah 是一个优秀的 npm 包,它提供了一个美观的时间选择器,且支持多语言。

    3 年前
  • npm 包 ctrldo_vmg 使用教程

    什么是 ctrldo_vmg? ctrldo_vmg 是一个方便快捷的前端工具集合,它通过 npm 包的方式提供了一系列针对前端开发的各种实用工具、插件和代码库,可以大大提高前端开发的效率和质量。

    3 年前
  • npm 包 anywhere-auth 使用教程

    简介 在现代 web 应用中,我们通常需要实现用户身份验证和会话管理等功能。为了避免重复造轮子,我们可以使用第三方的身份认证包来加速开发。npm 包 anywhere-auth 是一个轻量级的身份认证...

    3 年前
  • npm 包 domain-gfx 使用教程

    简介 domain-gfx 是一个基于 Canvas 的轻量级绘图库,提供了一系列绘图功能,如图形、文本、动画等,具有易用性和高性能优势。本篇文章将深入介绍如何在前端应用中使用 domain-gfx ...

    3 年前
  • npm 包 webxr-test 使用教程

    什么是 webxr-test? webxr-test 是一个用于测试 WebXR 应用程序兼容性的 npm 包,它提供了一些常见的 WebXR 功能测试。 如何安装 webxr-test? 要使用 w...

    3 年前
  • npm 包 generator-cwds-api 使用教程

    在前端开发中,我们经常需要构建 API 服务以及相关的代码结构。generator-cwds-api 是一个非常实用的 npm 包,可以帮助我们快速生成项目所需要的代码结构和文件。

    3 年前
  • NPM 包 stfnh-starwars-names 使用教程

    简介 stfnh-starwars-names 是一个 npm 包,可以用于获取 Star Wars 系列电影中的角色名字。该包可以用于你的前端项目,让你的项目更加有趣。

    3 年前
  • npm 包 @rh389/rn-apple-healthkit 使用教程

    简介 @rh389/rn-apple-healthkit 是一个 npm 包,提供了在 React Native 应用中使用 Apple HealthKit 的功能。

    3 年前
  • npm 包 ta-react-polymorphic-copyright-notice 使用教程

    简介 在前端开发中,使用 npm 包是一种非常常见的方式,可以大大提高开发效率,避免重复造轮子。其中,ta-react-polymorphic-copyright-notice 是一个非常有用的 np...

    3 年前
  • npm 包 ta-react-copyright-notice 使用教程

    在前端开发中,作者信息和版权声明是非常重要的一部分,而在 React 这样的 UI 库中,我们通常使用组件来实现复用和灵活性。在这篇文章中,我们将介绍一款名为 ta-react-copyright-n...

    3 年前
  • 使用 npm 包 jsoak 进行 JavaScript 测试

    什么是 jsoak jsoak 是一个 JavaScript 测试框架,可以在浏览器和 Node.js 中使用。它提供了多个测试工具和测试示例,使得开发者可以快速、方便地进行 JavaScript 程...

    3 年前
  • npm 包 nodelib-mpe 使用教程

    前言 nodelib-mpe 是一个基于 Node.js 的文件和文件夹处理工具集,提供了许多不同的 API 帮助你处理文件和文件夹的路径、过滤、排序、搜索以及排除等操作。

    3 年前

相关推荐

    暂无文章