前言
在开发 Web 应用程序时，日志记录是一个关键领域。我们需要查看错误、告警、信息和其他请求等详细信息，以便迅速诊断问题。现在，有许多日志记录库可以帮助我们完成此项工作，其中一个非常有用的库是 @jeremistadler/express-elasticsearch-logger。
该库提供了一个插件，能够将 Web 应用程序中的请求和错误数据记录到 Elasticsearch。这个插件支持快速检索和过滤请求日志，并能够在需要时生成警报和通知。本文将为大家详细介绍这个 npm 包的使用教程。
安装
使用 npm 命令可以很容易地安装 @jeremistadler/express-elasticsearch-logger：
npm install --save @jeremistadler/express-elasticsearch-logger
使用示例
下面的示例演示了如何在 Express 应用程序中使用该库：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- ------ - ------------------------------------------------------ ----- --- - --------- ---------------- ------ -------- ----- ----------------------- --- ------------ -------- ----- ---- - --------------- -------- -- ---------------- -------- -- - -------------------- --- --------- -- ---- ------- --
在这个例子中，我们加载了 express 包和 @jeremistadler/express-elasticsearch-logger 包，并使用 express 创建了一个简单的 Web 应用程序。应用程序将记录所有请求和错误数据到 Elasticsearch，这些数据存储在名为 myapp 的索引中。
API
该库提供了一个单独的 API，用于配置和驱动记录数据到 Elasticsearch。下面是一些常用选项的详细说明：
index
Elasticsearch 的索引名称，默认情况下是 express-elasticsearch-logger。
node
Elasticsearch 的节点 URL。必须是有效的 URL 格式，例如 http://localhost:9200。
type
记录数据的文档类型，默认值是 request。
level
记录数据的日志级别。支持级别有 error、warn、info 和 debug，默认值是 error。
requestFields
要记录的请求参数和响应字段名称列表。默认值为：
-- -------------------- ---- ------- - ----- ------------------- ------- ------------- ---- ------------------ -------------- --------- ----------- --------------- ---------- ------------------------- -------- ---------------------- ----------- ----------------- ------------- --------------- -------------- -------------------- -
errorFields
要记录的错误字段列表。默认值为：
{
error: 'err.message',
stack: 'err.stack'
}ignoreRoutes
忽略某些路由的 URL。默认情况下，所有 URL 都将记录日志。
filter
一个函数，用于过滤要记录的数据。该函数接收一个请求对象，并返回一个布尔值，指示该请求是否应该被记录。
指导意义
在这篇文章中，我们介绍了如何使用 @jeremistadler/express-elasticsearch-logger 将请求和错误数据记录到 Elasticsearch 中。此库是一个非常有用的工具，它可以帮助我们迅速找到应用程序中的问题，并生成警报和通知。
随着 Web 应用程序的增长和扩展，日志记录将变得越来越重要。因此，了解如何使用工具来记录和分析日志数据是一个重要的技能，它可以大大提高开发者的效率和生产力。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bc3967216659e2442a5