npm 包 chitin 使用教程

阅读时长 5 分钟读完

简介

chitin 是一个由腾讯开源的用于前端性能指标上报的工具。它可以捕获关键性能指标,如页面加载时间、白屏时间、首屏时间等,通过自定义的上报方式将数据发送给监控平台。本文将详细解读 chitin 的使用方法,帮助读者更好地掌握前端性能监控技术。

安装

使用 npm 进行全局安装:

安装完毕后,可以使用命令 chitin -v 查看当前版本号。

配置方法

API 配置

首先需要在代码中引入 chitin:

在需要上报性能数据的位置调用 chitin.report 方法,将数据传递给监控平台:

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

其中,data 中的 app_idpage_id 需要根据实际情况进行填写。sampling 表示取样率,取值范围为 0~1,表示上报比例。如果取值为 1,表示全部上报。dataextra 中的内容可以根据实际需求自定义,例如:

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

配置文件

在项目根目录下新建一个名为 chitin.js 的文件,内容如下:

其中,app_id 表示你的应用 ID;url 表示上报地址;sampling 表示取样率;extra 可以自定义。在代码中引入 chitin:

调用 chitin.init 方法,将配置文件传递给 chitin:

在需要上报性能数据的位置调用 chitin.report 方法:

示例

以下是一个完整的示例:

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

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

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

结语

本文对 chitin 的使用方法进行了详细介绍,并提供了配置方法和示例代码。希望读者能够通过学习本文更好地掌握前端性能监控技术,提升自己的技术能力。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055ea181e8991b448dbf82

纠错
反馈