emq 的部署、使用及维护

本贴最后更新于 1679 天前,其中的信息可能已经物是人非


1、下载 emq 源码

emq 使用 3.0 以上版本(emq 2.X 版本称为 emqttd,3.X 版本称为 emqx),并且自己编译源码(方便做扩展性修改)。git 地址:https://github.com/emqx/emqx-rel.git

emq 的编译依赖于 Erlang 环境(emqx 依赖于 Erlang R21.2+ 版本,emqttd 依赖于 Erlang R20+ 版本)。Erlang 安装: http://www.erlang.org/

源码下载完成后,进入 emqx-rel 主文件夹,然后直接 make 编译。编译完成后的文件结构如下:
image.png

由于 emq 文件结构过于复杂,因此只介绍需要用到的部分。可执行的命令以及配置文件位于_rel/emqx 中,插件位于 deps 中。

2、emq 配置、运行和部署

进入 emqx-rel/_rel/emqx/bin 文件夹下,用 emqx start 命令即可运行 emq,用 emqx stop 课停止 emq, emqx console 进入控制台运行模式,在此模式下可看见诸多类似设备连接、服务器报错等信息。

emq 的配置文件是 emqx-rel/_rel/emqx/etc/emqx.conf,下面介绍配置文件中比较重要的部分。
node.name=emqx@192.168.4.31 服务器的节点名,需要 emqx@host 的格式,注意 host 中最好使用本机真实 ip,尤其是在集群配置中,否则会出现预期之外的错误。并且,emq 启动之后不要修改此配置,确保 emq 开启和关闭的时候此配置必须相同,否则会出现无法关闭 emqx 的错误(就算一开始写的 127.0.0.1,然后启动之后发现错了,也要先关闭 emqx 再修改配置!)。

listener.tcp.external = 0.0.0.0:1885 : emq 对外监听的 tcp 端口,默认 1883。

listener.ssl.external = 8883 : emq 监听的 ssl 端口,默认 8883。

listener.ssl.external.keyfile = etc/certs/key.pem : 服务器的私钥(关于 ssl 认证的具体介绍见另一篇文档)。

listener.ssl.external.certfile = etc/certs/cert.pem : 服务器的公钥。

listener.ssl.external.cacertfile = etc/certs/cacert.pem : ca 证书。

listener.ssl.external.verify = verify_peer : 开启双向认证。

listener.ssl.external.fail_if_no_peer_cert = true : 如果客户端证书错误,则禁止连接。

如果开启单向认证,只需要配置服务器公钥和私钥,如果开启双向认证,则需要配置 ca、开启双向认证、并禁止客户端无证书连接。

另外,在 emqx-rel/_rel/emqx/etc/acl.conf 中,有一处配置需要注意。

{allow, {user, "dashboard"}, subscribe, ["$SYS/#"]}.

{allow, {ipaddr, "127.0.0.1"}, pubsub, ["$SYS/#", "#"]}.

%%{deny, all, subscribe, ["$SYS/#", {eq, "#"}]}.

{allow, all}.

这里对 emq 客户端的权限作了一些配置,对某些 topic 禁止客户端订阅。我们需要将第三行的配置注释掉,否则客户端无法订阅 $SYS/# 的 topic(具体作用见下文)。

3、emq 集群部署

emq 提供了多种去中心化的集群部署方案:
image.png

emqx-rel/_rel/emqx/etc/emqx.conf 中可以配置集群的创建方式,在此介绍一下手动创建集群的方法。

cluster.discovery = manual : 开启手动创建集群模式。

启动两台 emqx 节点(物理节点,非逻辑节点),假设两个节点分别为 emqx@node1emqx@node2,在任意一台节点(以 node1 为例)上,执行命令:emqx-rel/_rel/emqx/bin/emqx_ctl clsuter join emqx@node2

节点退出集群:mqx-rel/_rel/emqx/bin/emqx_ctl cluster leave

4、emq 的管理和监控

emq 提供了方便用户管理监控的控制台、api 及系统消息。控制台可直接访问 http://{host}:18083,默认用户名 admin,密码 public
image.png

此处是插件功能和 emq 提供的 HTTP API 列表,可直接在控制台中进行配置和插件的开关,emq 支持插件的热加载。

除此之外,emq 提供了一些用于监控 broker 状态的系统主题 $SYS。其中,我们的上下线通知中用到了下列两个 topic:
image.png

但是此处的上线通知流程存在问题,emq broker 会在客户端尝试连接(鉴权)时进行上线通知,而不是连接成功之后通知。还有一种解决方案是用插件进行通知,但这样会使用 http 同步调用,代价较大,因此暂时还是用系统消息进行异步通知。

5、插件的编写

插件位于 emqx-rel/deps 中,其中有若干已经由官方写好的插件,可以直接修改配置文件或直接在控制台中进行配置。

如果需要自己写插件,emq 也提供了插件模板,在 emqx-rel/deps/emqx_plugin_template 中。打开 emqx-rel/deps/emqx_plugin_template/src/emqx_plugin_template.erl,其中可以看到 emq 提供了一些钩子:

    emqx:hook('client.authenticate', fun ?MODULE:on_client_authenticate/2, [Env]),
    emqx:hook('client.check_acl', fun ?MODULE:on_client_check_acl/5, [Env]),
    emqx:hook('client.connected', fun ?MODULE:on_client_connected/4, [Env]),
    emqx:hook('client.disconnected', fun ?MODULE:on_client_disconnected/3, [Env]),
    emqx:hook('client.subscribe', fun ?MODULE:on_client_subscribe/3, [Env]),
    emqx:hook('client.unsubscribe', fun ?MODULE:on_client_unsubscribe/3, [Env]),
    emqx:hook('session.created', fun ?MODULE:on_session_created/3, [Env]),
    emqx:hook('session.resumed', fun ?MODULE:on_session_resumed/3, [Env]),
    emqx:hook('session.subscribed', fun ?MODULE:on_session_subscribed/4, [Env]),
    emqx:hook('session.unsubscribed', fun ?MODULE:on_session_unsubscribed/4, [Env]),
    emqx:hook('session.terminated', fun ?MODULE:on_session_terminated/3, [Env]),
    emqx:hook('message.publish', fun ?MODULE:on_message_publish/2, [Env]),
    emqx:hook('message.deliver', fun ?MODULE:on_message_deliver/3, [Env]),
    emqx:hook('message.acked', fun ?MODULE:on_message_acked/3, [Env]),
    emqx:hook('message.dropped', fun ?MODULE:on_message_dropped/3, [Env]).

当达成这些条件事,会触发钩子函数,用户可以自己定义钩子函数,例如**目前鉴权所用到的:

on_client_authenticate(Credentials = #{client_id := ClientId, password := Password, username := Username}, _Env) ->
    io:format("Client(~s) authenticate, Password:~p ~n, Username:~p ~n", [ClientId, Password, Username]),
   inets:start(),
    {ok, {{Version, 200, ReasonPhrase}, Headers, Body}} = httpc:request(string:join(["http://www.example.com/api/mqtt/authenticate/login?username=",  binary_to_list(base64:encode(binary_to_list(Username))), "&password=",  binary_to_list(Password),  "&clientId=", binary_to_list(base64:encode(binary_to_list(ClientId)))], "")),
		if
			Body == "0" ->
			{stop, Credentials#{auth_result => success}};
		true ->
			{stop, Credentials#{auth_result => fail}}
		end.

插件编写完成后,需要到主目录 emqx-rel 中重新 make。注意,make 之后配置文件会重新生成,因此 make 之前最好备份一下配置文件。然后启动 emq,到控制台中开启插件即可。

6、管理监控 API

emq 提供了一些 api,可以获取服务器的一些信息。
image.png

首先在 App 中新增用户
image.png

image.png

然后通过 http://host:8080/{api} 访问,访问需要 http basic authentication,用刚刚创建的用户可以访问。

7、emq 使用过程中可能遇到的问题及注意事项

1)emqx start 指令后,卡住不动,没有出现 start successfully 的字样,可能是端口被其他进程占用。emq 会占用的端口如下:
image.png

这些端口都可以在配置文件中自己修改,但是只要有一个冲突就无法正常启动。

2)emqx stop 时,显示 emqx@xxx no response 字样,检查配置文件中的节点名是否正确。

3)在开启集群模式时,如果要关闭一个节点,最好先手动让该节点退出集群,否则下一次启动该节点时可能出现无法加入集群的情况(emq 会记住集群信息,重启时会自动恢复之前的集群状态,但这个过程经常会出现一些问题,所以最好的办法就是手动退出集群,然后重启之后再手动加入集群)。

4)emq 重启之后,会自动启动上一次启动过的插件,但是配置会回复初始化(除非修改配置文件)。

5)emq 的启动进程为 beam.smp,守护进程为 epmd,但是 Erlang 的进程结构比较奇怪,所以直接 kill 掉上述进程之后,emq 可能还在运行中。所以最好执行 emqx stop 指令来停止 emq。

8、部署架构
image.png

9、后记

在官方文档中有更为全面的说明和指南,本文只列出了部分实际用到的比较重要的功能。如果后续有扩展或本文中不详细之处,可参加官方文档:https://developer.emqx.io/docs/broker/v3/cn/getstarted.html

另附:插件编写指南 https://www.cnblogs.com/wunaozai/p/8067621.html

官方文档对于部分内容也并不十分详细,本文对实际中遇到的问题和注意事项作了部分补充。

  • emq
    1 引用
  • emqx
    1 引用
  • SSL

    SSL(Secure Sockets Layer 安全套接层),及其继任者传输层安全(Transport Layer Security,TLS)是为网络通信提供安全及数据完整性的一种安全协议。TLS 与 SSL 在传输层对网络连接进行加密。

    69 引用 • 190 回帖 • 501 关注
  • OpenSSL
    7 引用 • 1 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • BAE

    百度应用引擎(Baidu App Engine)提供了 PHP、Java、Python 的执行环境,以及云存储、消息服务、云数据库等全面的云服务。它可以让开发者实现自动地部署和管理应用,并且提供动态扩容和负载均衡的运行环境,让开发者不用考虑高成本的运维工作,只需专注于业务逻辑,大大降低了开发者学习和迁移的成本。

    19 引用 • 75 回帖 • 609 关注
  • 房星科技

    房星网,我们不和没有钱的程序员谈理想,我们要让程序员又有理想又有钱。我们有雄厚的房地产行业线下资源,遍布昆明全城的 100 家门店、四千地产经纪人是我们坚实的后盾。

    6 引用 • 141 回帖 • 548 关注
  • 黑曜石

    黑曜石是一款强大的知识库工具,支持本地 Markdown 文件编辑,支持双向链接和关系图。

    A second brain, for you, forever.

    9 引用 • 83 回帖
  • Kubernetes

    Kubernetes 是 Google 开源的一个容器编排引擎,它支持自动化部署、大规模可伸缩、应用容器化管理。

    108 引用 • 54 回帖
  • WordPress

    WordPress 是一个使用 PHP 语言开发的博客平台,用户可以在支持 PHP 和 MySQL 数据库的服务器上架设自己的博客。也可以把 WordPress 当作一个内容管理系统(CMS)来使用。WordPress 是一个免费的开源项目,在 GNU 通用公共许可证(GPLv2)下授权发布。

    45 引用 • 113 回帖 • 321 关注
  • Hibernate

    Hibernate 是一个开放源代码的对象关系映射框架,它对 JDBC 进行了非常轻量级的对象封装,使得 Java 程序员可以随心所欲的使用对象编程思维来操纵数据库。

    39 引用 • 103 回帖 • 676 关注
  • JetBrains

    JetBrains 是一家捷克的软件开发公司,该公司位于捷克的布拉格,并在俄国的圣彼得堡及美国麻州波士顿都设有办公室,该公司最为人所熟知的产品是 Java 编程语言开发撰写时所用的集成开发环境:IntelliJ IDEA

    18 引用 • 54 回帖
  • Sublime

    Sublime Text 是一款可以用来写代码、写文章的文本编辑器。支持代码高亮、自动完成,还支持通过插件进行扩展。

    10 引用 • 5 回帖 • 2 关注
  • WebClipper

    Web Clipper 是一款浏览器剪藏扩展,它可以帮助你把网页内容剪藏到本地。

    3 引用 • 9 回帖 • 2 关注
  • Vditor

    Vditor 是一款浏览器端的 Markdown 编辑器,支持所见即所得、即时渲染(类似 Typora)和分屏预览模式。它使用 TypeScript 实现,支持原生 JavaScript、Vue、React 和 Angular。

    308 引用 • 1658 回帖 • 1 关注
  • HBase

    HBase 是一个分布式的、面向列的开源数据库,该技术来源于 Fay Chang 所撰写的 Google 论文 “Bigtable:一个结构化数据的分布式存储系统”。就像 Bigtable 利用了 Google 文件系统所提供的分布式数据存储一样,HBase 在 Hadoop 之上提供了类似于 Bigtable 的能力。

    17 引用 • 6 回帖 • 33 关注
  • TGIF

    Thank God It's Friday! 感谢老天,总算到星期五啦!

    284 引用 • 4481 回帖 • 652 关注
  • Vue.js

    Vue.js(读音 /vju ː/,类似于 view)是一个构建数据驱动的 Web 界面库。Vue.js 的目标是通过尽可能简单的 API 实现响应的数据绑定和组合的视图组件。

    261 引用 • 662 回帖 • 2 关注
  • V2EX

    V2EX 是创意工作者们的社区。这里目前汇聚了超过 400,000 名主要来自互联网行业、游戏行业和媒体行业的创意工作者。V2EX 希望能够成为创意工作者们的生活和事业的一部分。

    17 引用 • 236 回帖 • 433 关注
  • GitLab

    GitLab 是利用 Ruby 一个开源的版本管理系统,实现一个自托管的 Git 项目仓库,可通过 Web 界面操作公开或私有项目。

    46 引用 • 72 回帖
  • 程序员

    程序员是从事程序开发、程序维护的专业人员。

    529 引用 • 3527 回帖 • 1 关注
  • 强迫症

    强迫症(OCD)属于焦虑障碍的一种类型,是一组以强迫思维和强迫行为为主要临床表现的神经精神疾病,其特点为有意识的强迫和反强迫并存,一些毫无意义、甚至违背自己意愿的想法或冲动反反复复侵入患者的日常生活。

    15 引用 • 161 回帖
  • Scala

    Scala 是一门多范式的编程语言,集成面向对象编程和函数式编程的各种特性。

    13 引用 • 11 回帖 • 101 关注
  • RabbitMQ

    RabbitMQ 是一个开源的 AMQP 实现,服务器端用 Erlang 语言编写,支持多种语言客户端,如:Python、Ruby、.NET、Java、C、PHP、ActionScript 等。用于在分布式系统中存储转发消息,在易用性、扩展性、高可用性等方面表现不俗。

    49 引用 • 60 回帖 • 395 关注
  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言,是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    3165 引用 • 8206 回帖 • 1 关注
  • WebComponents

    Web Components 是 W3C 定义的标准,它给了前端开发者扩展浏览器标签的能力,可以方便地定制可复用组件,更好的进行模块化开发,解放了前端开发者的生产力。

    1 引用 • 25 关注
  • Windows

    Microsoft Windows 是美国微软公司研发的一套操作系统,它问世于 1985 年,起初仅仅是 Microsoft-DOS 模拟环境,后续的系统版本由于微软不断的更新升级,不但易用,也慢慢的成为家家户户人们最喜爱的操作系统。

    215 引用 • 462 回帖
  • flomo

    flomo 是新一代 「卡片笔记」 ,专注在碎片化时代,促进你的记录,帮你积累更多知识资产。

    3 引用 • 74 回帖 • 2 关注
  • Postman

    Postman 是一款简单好用的 HTTP API 调试工具。

    4 引用 • 3 回帖
  • Shell

    Shell 脚本与 Windows/Dos 下的批处理相似,也就是用各类命令预先放入到一个文件中,方便一次性执行的一个程序文件,主要是方便管理员进行设置或者管理用的。但是它比 Windows 下的批处理更强大,比用其他编程程序编辑的程序效率更高,因为它使用了 Linux/Unix 下的命令。

    122 引用 • 73 回帖 • 2 关注
  • wolai

    我来 wolai:不仅仅是未来的云端笔记!

    1 引用 • 11 回帖 • 1 关注
  • GitHub

    GitHub 于 2008 年上线,目前,除了 Git 代码仓库托管及基本的 Web 管理界面以外,还提供了订阅、讨论组、文本渲染、在线文件编辑器、协作图谱(报表)、代码片段分享(Gist)等功能。正因为这些功能所提供的便利,又经过长期的积累,GitHub 的用户活跃度很高,在开源世界里享有深远的声望,并形成了社交化编程文化(Social Coding)。

    207 引用 • 2031 回帖