简介
在前端开发中，我们常常需要在浏览器端收集日志，以便进行调试和分析。Kerplunk-stream 是一个方便的工具，它允许您把应用程序生成的日志信息实时传输到服务器上。对于 Node.js、前端和 Electron 应用程序都非常有用。
Kerplunk-stream 允许在流上处理读取日志事件。每个事件都是一个 JavaScript 对象，包含消息、日志的级别和时间戳等信息。可以自定义您的 Kerplunk 服务器来处理这些信息，例如将其存储到 Elasticsearch、MongoDB 或其他数据库中。
安装使用
在您的项目根目录下，打开终端，执行下面命令安装 kerplunk-stream：
npm install kerplunk-stream --save
每个读取日志事件都是一个具有以下属性的对象：
- level（字符串） - 日志级别（例如，“info”或“error”）
- message（字符串） - 日志消息
- time（数字） - 日志事件时间戳
基本用法
使用 kerplunk-stream 非常简单，只需几行代码即可开始记录和转发日志。下面是一个示例：
-- -------------------- ---- -------
--- ------ - ---------------------------
------- - --------------------
---- - ----------------
--- ---- - --- --------------
--- -------- - --- ----------------------
--- -------- - --- -----------------------------
-- -------- ------ -- ---------------
-------------------------------------------------
--------------------- ------ --------- -- ---- -------
-------------
-------------------------- ------- ---- --- -
-------- -
------ --------
-------- ------------------------
----- ----------
---
---
----------------在这个示例中，我们创建了一个 Unix 套接字，然后创建了一个 Kerplunk 流，之后将其用作一个 WebSocket 流的参数。我们从标准输出中读取内容，并通过通过管道内部处理每个日志事件都包装成对象。
自定义 Kerplunk 服务器
当设置 WebSocket 流并将 JSON 格式的日志数据通过管道转发到 WebSocket 流时，我们需要创建一个定制的 Kerplunk 服务器。可以使用 kerplunk-server 模块来完成这个任务。
下面是一个简单的 Kerplunk 服务器的示例：
var kerplunkServer = require('kerplunk-server'),
memdb = require('memdb');
var db = memdb();
kerplunkServer.create(db);以上代码创建了一个使用 memdb 中间件的数据库，作为 Kerplunk 服务器的储存引擎。您可以自己使用其他中间件，例如 leveldb 或 Redis。一旦你创建了数据库，kerplunk-server 模块即可在其之上直接运行。
以下是一些常见术语：
- 通道（channel）- 日志流的名称。
- 消息（message） - 日志传输的消息。
- 格式化（formatter） - 格式化消息的函数。
- 如何存储（how） - 存储棒的数据在中间件中是如何存储的。
- 缓存（cache） - 日志事件是否缓存（determined by options.cache）。
- 时区（timezone） - Kerplunk 服务器使用的时区。
总结
Kerplunk-stream 是一款强大的前端工具，可以帮助您快速记录和分析应用程序的日志。我希望通过这您可以学习到如何安装使用 Kerplunk-stream，还有如何自定义您的 Kerplunk 服务器。无论您是开发 Node.js、前端，还是 Electron 应用程序，都可以方便地使用该工具。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066efe4c49986ca68d8aba