npm 包 @arco-cloud/logging 使用教程

阅读时长 4 分钟读完

前言

在前端开发中,日志往往是开发过程中必不可少的一部分。日志可以帮助开发者在开发过程中了解代码运行状态,及时发现问题并解决。而在云原生的开发中,日志的产生和收集更是变得非常重要。因此,@arco-cloud/logging 这款 npm 包应运而生。本篇文章将详细介绍如何使用这款 npm 包。

什么是 @arco-cloud/logging

@arco-cloud/logging 是由阿尔科 (ARCO) 开发的一款前端日志框架,它提供了嵌入式日志收集器和云端存储、可视化查看工具。通过 @arco-cloud/logging 这款 npm 包,你可以轻松地收集你的应用程序运行时产生的日志数据。同时,利用 ARCO 提供的 Web 界面,您可以轻松地查看和分析来自所有应用程序的日志数据。

安装 @arco-cloud/logging

在使用 @arco-cloud/logging 之前,需要先安装它。安装方法很简单,只需在您的项目文件夹下使用以下命令即可:

当然,在使用 @arco-cloud/logging 之前,您还需要先申请 ARCO 账号,并且创建一个项目。在创建项目时,您会得到一个 Project ID,将它记录下来,后面会用到。

使用 @arco-cloud/logging

接下来,让我们看一下如何使用 @arco-cloud/logging

配置 @arco-cloud/logging

在使用 @arco-cloud/logging 前,您需要在您的项目中进行一些配置。

Logging.config 同时可以接受以下配置项:

参数名 默认值 说明
buffer_length 100 日志缓存队列长度,达到队列长度限制后,将触发发送事件
buffer_time 10 日志缓存队列时间,达到规定的时间后,将触发发送事件
max_retry_times 3 日志发送失败后,最多重试发送次数
retry_interval 1000 日志发送失败后,两次重试之间的间隔时间

SSL 连接可以使用 secure: true 参数进行开启。

发送日志

@arco-cloud/logging 集成了日志级别 DEBUGINFOWARNINGERRORCRITICAL

以下是一些常用的日志发送用例:

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

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

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

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

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

您也可以配置日志的标签、参数、堆栈跟踪等内容:

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

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

日志查看

通过 ARCO 平台上提供的 日志管理 界面,您可以轻松查看和分析所有应用程序的日志数据。以下是 ARCO 平台 日志管理 界面的示例:

总结

在本篇文章中,我们介绍了 @arco-cloud/logging 这款前端日志框架,并详细介绍了如何使用它。它可以极大地方便您在开发过程中收集日志,并且还可以利用 ARCO 平台提供的日志管理界面,轻松地查看和分析所有应用程序的日志数据。我们相信在将来,@arco-cloud/logging 这款 npm 包将会被越来越多的前端开发者所使用。

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