ELK 是 ElasticSearch + Logstash + Kibana 这套组合工具的简称，是一个常用的日志系统。

  • ElasticSearch：是一款开源的基于 Lucene 之上实现的一个分布式搜索引擎，也是一个存储引擎（例如：日志），它的特点有：分布式、零配置、自动发现、索引自动分片、索引副本机制、Restful 风格的接口、多数据源和自动搜索负载等。
  • Logstash：是一款开源的日志收集工具，它可以对日志进行收集、分析、过滤，并将其存储（例如：ElasticSearch）起来供以后使用。
  • Kibana：是一款开源的可视化工具，可以为 ElasticSearch 提供的日志分析友好的 Web 界面，可以汇总、分析和搜索重要的数据日志。

6.3.1 安装 ELK

我们使用 Docker 安装 ELK，运行如下命令：

  1. $ docker run -p 5601:5601 \
  2.     -p 9200:9200 \
  3.     -p 5044:5044 \
  4.     -p 15044:15044/udp \
  5.     -it --name elk sebp/elk

进入容器：

  1. $ docker exec -it elk /bin/bash

运行以下命令设置 logstash 的 input 和 output：

  1. # /opt/logstash/bin/logstash --path.data /tmp/logstash/data \
  2.   -e 'input { udp { codec => "json" port => 15044 } } output { elasticsearch { hosts => ["localhost"] } }'

这里我们启动一个 15044 的 UDP 端口，用来接收通过 UDP 发送到 Logstash 的日志。

浏览器打开 localhost:5601，如下所示：

ELK - 图1

目前还没有指定 index（ElasticSearch 的 index 类似于 MySQL/MongoDB 中的 database），即日志来源。下面我们尝试向 ELK 中写入一些日志。

6.3.2 使用 ELK

这里仍然以使用 koa-await-breakpoint 为例，来演示如何将日志发送到 ELK。

app.js

  1. const koaAwaitBreakpoint = require('koa-await-breakpoint')({
  2.   name: 'api',
  3.   files: ['./routes/*.js'],
  4.   store: require('./logger')
  5. })
  7. const Paloma = require('paloma')
  8. const app = new Paloma()
  10. app.use(koaAwaitBreakpoint)
  11. app.route({ method: 'POST', path: '/users', controller: require('./routes/user').createUser })
  13. app.listen(3000)

logger.js

  1. const Logstash = require('logstash-client')
  3. const logstash = new Logstash({
  4.   type: 'udp',
  5.   host: 'localhost',
  6.   port: 15044
  7. })
  9. module.exports = {
  10.   save (log) {
  11.     if (log.error) {
  12.       log.errMsg = log.error.message
  13.       log.errStack = log.error.stack
  14.     }
  15.     logstash.send(log)
  16.   }
  17. }

routes/user.js

  1. const Mongolass = require('mongolass')
  2. const mongolass = new Mongolass('mongodb://localhost:27017/test')
  3. const User = mongolass.model('User')
  4. const Post = mongolass.model('Post')
  5. const Comment = mongolass.model('Comment')
  7. exports.createUser = async function (ctx) {
  8.   const name = ctx.query.name || 'default'
  9.   const age = +ctx.query.age || 18
  10.   await createUser(name, age)
  11.   ctx.status = 204
  12. }
  14. async function createUser (name, age) {
  15.   const user = (await User.create({
  16.     name,
  17.     age
  18.   })).ops[0]
  19.   await createPost(user)
  20. }
  22. async function createPost (user) {
  23.   const post = (await Post.create({
  24.     uid: user._id,
  25.     title: 'post',
  26.     content: 'post'
  27.   })).ops[0]
  29.   await createComment(user, post)
  30. }
  32. async function createComment (user, post) {
  33.   await Comment.create({
  34.     userId: user._id,
  35.     postId: post._id,
  36.     content: 'comment'
  37.   })
  38. }

运行：

  1. $ curl -XPOST localhost:3000/users

此时刷新 Kibana，如下所示：

ELK - 图2

在初次使用 Kibana 时，需要配置 Kibana 从 ElasticSearch 的哪些 index 中搜索日志，我们在 Index pattern 处填 logstash-*，然后单击 Next step 按钮，在 Time Filter field name 中选择 timestamp，单击 Create index pattern 完成配置。

注意：我们选择 timestamp 而不是默认的 @timestamp，是因为在 koa-await-breakpoint 的日志中有 timestamp 字段。

单击左侧目录的 Discover，我们发现已经有日志了。分别单击左侧出现的 Available Fields 的 fn、type、step、take，然后按 step 升序展示，如下所示：

ELK - 图3

是不是一目了然！我们把每个请求的每一步的函数及其执行时间都记录下来了。

修改 routes/users.js 的 createComment，throw 一个 new Error('test')。重启程序并发起一个请求，ELK 显示如下：

ELK - 图4

小提示：在实际应用中会有非常多的日志，我们可以通过 requestId 找到一个请求的所有日志，在 7.2 小节会讲解。

ELK 非常强大，基本能满足所有日志查询需求，Kibana 的查询使用 lucene 语法，用 10 分钟左右就能大体上手。Kibana 还能创建各种仪表盘和聚合图表，读者可自行尝试。

6.3.3 参考链接

上一节：6.2 async_hooks

下一节：6.4 OpenTracing + Jaeger