npm包 gitbook-plugin-devops-analytics 使用教程

阅读时长 3 分钟读完

随着 DevOps 方法论在软件开发中越来越受欢迎,对于 DevOps 实践的分析、评估、监控等方面的需求也越来越强烈。针对这一需求,本文作者基于知名的文档网站生成工具 Gitbook,开发了一个插件 gitbook-plugin-devops-analytics,提供 DevOps 实践中的指标收集、展示与分析功能。本文将详细介绍该插件的使用方法及示例。

安装

要使用该插件,需要在安装 Gitbook 的基础上安装 gitbook-plugin-devops-analytics。可以使用以下命令进行安装:

配置

安装完成后,在 Gitbook 的配置文件 book.json 中添加插件相关配置项:

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

其中各个配置项的含义如下:

  • server:收集数据的服务器地址
  • projectId:当前应用的项目ID
  • authToken:服务器认证用的Token
  • version:当前应用版本
  • collectInterval:数据收集的时间间隔

需要根据实际情况修改对应的配置项。

使用

配置完成后,在 Gitbook 中编写文章时,可以通过使用插件提供的特殊代码语法,在文章中采集数据。比如:

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

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

--- ------ --

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

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

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

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

http://<your-server-address>/analytics/projects/<your-project-id>

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

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

-- --

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

- ------------------------------------------------------------------------------ --------
------------------------------------------------------------------------------------------------------------------------
纠错
反馈