作者:Abhinav Dhasmana翻译:疯狂的技术宅
原文:https://blog.bitsrc.io/settin...
未经允许严禁转载
设置正确的日志记录基础结构可帮助我们查找发生的问题、调试和监视应用程序。从最基本的角度来看,我们应该从基础架构中得到以下内容:
- 能够在我们的日志中自由搜索文本
- 能够搜索特定的 api 日志
- 能够根据所有 API 的
statusCode
进行搜索 - 随着我们向日志中添加更多的数据,系统应该是可扩展的
架构
提示:复用 JavaScript 组件
使用Bit(Github)在不同项目之间共享和重用 JavaScript 组件。团队协作共享组件可以更快地构建应用程序。让 Bit 承担繁重的工作,可以使你可以轻松地发布、安装和更新各个组件,而不会产生任何开销。 在此处了解更多信息。
本地设置
我们将用 Docker 来管理服务。
弹性搜寻
使用以下命令启动并运行 ElasticSearch
docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" --name myES docker.elastic.co/elasticsearch/elasticsearch:7.4.1
可以通过以下命令检查你的容器是否已启动并运行
curl -X GET "localhost:9200/_cat/nodes?v&pretty"
Kibana
可以用另一个 docker run 命令启动 Kibana 并使其运行。
docker run —-link myES:elasticsearch -p 5601:5601 kibana:7.4.1
请注意,我们正在使用 --link
命令链接 kibana 和弹性搜索服务器
如果转到 http://localhost:5601/app/kibana
,将会看到我们的 kibana 仪表板。
现在,可以使用 kibana 对我们的弹性搜索集群运行所有查询。我们可以导航到
http://localhost:5601/app/kibana#/dev_tools/console?_g=()
并运行我们之前运行的查询(稍微冗长一些)
Fluentd
Fluentd 是对所有数据进行格式化的地方。
让我们首先构建我们的 Dockerfile。它有两件事:
- 安装必要的软件包
- 将配置文件复制到 docker 文件中
适用于 fluentd 的 Dockerfile:
FROM fluent/fluentd:latest
MAINTAINER Abhinav Dhasmana
USER root
RUN apk add --no-cache --update --virtual .build-deps \
sudo build-base ruby-dev \
&& sudo gem install fluent-plugin-elasticsearch \
&& sudo gem install fluent-plugin-record-modifier \
&& sudo gem install fluent-plugin-concat \
&& sudo gem install fluent-plugin-multi-format-parser \
&& sudo gem sources --clear-all \
&& apk del .build-deps \
&& rm -rf /home/fluent/.gem/ruby/2.5.0/cache/*.gem
COPY fluent.conf /fluentd/etc/
fluent 的配置文件:
# Recieve events over http from port 9880
# Recieve events from 24224/tcp
# We need to massage the data before if goes into the ES
# We parse the input with key "log" (https://docs.fluentd.org/filter/parser)
@type parser
key_name log
# Keep the original key value pair in the result
reserve_data true
# Use apache2 parser plugin to parse the data
@type multi_format
format apache2
format json
time_key timestamp
format none
# Fluentd will decide what to do here if the event is matched
# In our case, we want all the data to be matched hence **
# We want all the data to be copied to elasticsearch using inbuilt
# copy output plugin https://docs.fluentd.org/output/copy
@type copy
# We want to store our data to elastic search using out_elasticsearch plugin
# https://docs.fluentd.org/output/elasticsearch. See Dockerfile for installation
@type elasticsearch
time_key timestamp_ms
host 0.0.0.0
port 9200
# Use conventional index name format (logstash-%Y.%m.%d)
logstash_format true
# We will use this when kibana reads logs from ES
logstash_prefix fluentd
logstash_dateformat %Y-%m-%d
flush_interval 1s
reload_connections false
reconnect_on_error true
reload_on_failure true
让我们使这台 Docker 机器跑起来
docker build -t abhinavdhasmana/fluentd .docker run -p 9880:9880 --network host abhinavdhasmana/fluentd
Node.js 应用
我已经创建了一个用于演示的小型 Node.js 程序,你可以在 https://github.com/abhinavdha... 中找到。这是一个用 Express Generator 创建的小型 Express 应用。它用 morgan 生成 apache 格式的日志。你也可以用自己的应用。只要输出保持不变,我们的基础架构就不会在意。让我们构建并运行 docker 映像。
docker build -t abhinavdhasmana/logging .
当然,我们可以通过下面给出的单个 docker compose 文件来获取所有 docker 容器。
为 EFK 设置撰写的 docker compose文件:
version: "3"
services:
fluentd:
build: "./fluentd"
ports:
- "9880:9880"
- "24224:24224"
network_mode: "host"
web:
build: .
ports:
- "3000:3000"
links:
- fluentd
logging:
driver: "fluentd"
options:
fluentd-address: localhost:24224
elasticsearch:
image: elasticsearch:7.4.1
ports:
- "9200:9200"
- "9300:9300"
environment:
- discovery.type=single-node
kibana:
image: kibana:7.4.1
links:
- "elasticsearch"
ports:
- "5601:5601"
就是这样而已。我们的基础架构已准备就绪。现在可以通过访问 http://localhost:3000
来生成一些日志。
现在,我们再次转到 kibana 仪表板,并定义要使用的索引:
注意,在我们的 fluent.conf
中提到了 logstash_prefix fluentd
,因此我们在这里使用相同的字符串。接下来是一些基本的 kibana 设置。
弹性搜索使用动态映射来猜测其索引字段的 type
。下面的截图显示了这些:
让我们检查一下如何满足开始时提到的要求:
- 能够在日志中自由文本搜索: 在 ES 和 kibana 的帮助下,我们可以在任何字段上进行搜索以获得结果。
- 能够搜索特定的api日志: 在 kibana 左侧的 “Available fields” 部分中,我们可以看到字段
path
。对其应用过滤器可以查找我们感兴趣的 API。 - 能够根据所有API的
statusCode
进行搜索: 与上述相同。使用code
字段并应用过滤器。 - 随着向日志中添加更多的数据,系统应该是可扩展的: 我们使用以下环境变量
discovery.type = single-node
在单节点模式下开始了弹性搜索。可以从集群模式开始,添加更多节点,或者在我们选择的任何云提供商上使用托管解决方案。我已经尝试过了 AWS,并且易于设置。 AWS 还免费提供 Elasticsearch 的托管 kibana 实例。
本文首发微信公众号:前端先锋
欢迎扫描二维码关注公众号,每天都给你推送新鲜的前端技术文章
欢迎继续阅读本专栏其它高赞文章:
- 深入理解Shadow DOM v1
- 一步步教你用 WebVR 实现虚拟现实游戏
- 13个帮你提高开发效率的现代CSS框架
- 快速上手BootstrapVue
- JavaScript引擎是如何工作的?从调用栈到Promise你需要知道的一切
- WebSocket实战:在 Node 和 React 之间进行实时通信
- 关于 Git 的 20 个面试题
- 深入解析 Node.js 的 console.log
- Node.js 究竟是什么?
- 30分钟用Node.js构建一个API服务器
- Javascript的对象拷贝
- 程序员30岁前月薪达不到30K,该何去何从
- 14个最好的 JavaScript 数据可视化库
- 8 个给前端的顶级 VS Code 扩展插件
- Node.js 多线程完全指南
- 把HTML转成PDF的4个方案及实现