From 3438570fc92bb39feb97b893d4465b1950056be3 Mon Sep 17 00:00:00 2001
From: Shawn <506895667@qq.com>
Date: Tue, 12 Apr 2022 13:50:24 +0800
Subject: [PATCH] fix(log): format the message id to hexstring before printing

---
 src/emqx.appup.src   | 18 ++++++++++++++++++
 src/emqx_message.erl |  3 ++-
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/src/emqx.appup.src b/src/emqx.appup.src
index 18c3fb04d..fe9c71cb9 100644
--- a/src/emqx.appup.src
+++ b/src/emqx.appup.src
@@ -3,6 +3,7 @@
 {VSN,
  [
    {"4.2.0", [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {add_module, emqx_congestion},
      {load_module, emqx_alarm, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
@@ -30,6 +31,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {"4.2.1", [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {add_module, emqx_congestion},
      {load_module, emqx_alarm, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
@@ -56,6 +58,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.[23]">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {add_module, emqx_congestion},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_alarm, brutal_purge, soft_purge, []},
@@ -80,6 +83,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.4">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_session, brutal_purge, soft_purge, []},
@@ -103,6 +107,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.5">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_session, brutal_purge, soft_purge, []},
@@ -126,6 +131,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.[6-7]">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_connection, brutal_purge, soft_purge, []},
@@ -143,6 +149,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.8">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_connection, brutal_purge, soft_purge, []},
@@ -155,6 +162,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.9">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_connection, brutal_purge, soft_purge, []},
@@ -166,6 +174,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.10">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_app, brutal_purge, soft_purge, []},
@@ -177,6 +186,7 @@
  ],
  [
    {"4.2.0", [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_shared_sub, brutal_purge, soft_purge, []},
      {load_module, emqx_os_mon, brutal_purge, soft_purge, []},
      {load_module, emqx_alarm, brutal_purge, soft_purge, []},
@@ -204,6 +214,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {"4.2.1", [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_shared_sub, brutal_purge, soft_purge, []},
      {load_module, emqx_os_mon, brutal_purge, soft_purge, []},
      {load_module, emqx_limiter, brutal_purge, soft_purge, []},
@@ -230,6 +241,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.[23]">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_shared_sub, brutal_purge, soft_purge, []},
      {load_module, emqx_os_mon, brutal_purge, soft_purge, []},
      {update, emqx_connection, {advanced, []}},
@@ -254,6 +266,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.4">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_congestion, brutal_purge, soft_purge, []},
@@ -277,6 +290,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.5">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_session, brutal_purge, soft_purge, []},
@@ -300,6 +314,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.[6-7]">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_connection, brutal_purge, soft_purge, []},
@@ -317,6 +332,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.8">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_connection, brutal_purge, soft_purge, []},
@@ -329,6 +345,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.9">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_connection, brutal_purge, soft_purge, []},
@@ -340,6 +357,7 @@
      {load_module, emqx_plugins, brutal_purge, soft_purge, []}
    ]},
    {<<"4.2.10">>, [
+     {load_module, emqx_message, brutal_purge, soft_purge, []},
      {load_module, emqx_channel, brutal_purge, soft_purge, []},
      {load_module, emqx_frame, brutal_purge, soft_purge, []},
      {load_module, emqx_app, brutal_purge, soft_purge, []},
diff --git a/src/emqx_message.erl b/src/emqx_message.erl
index decbb0c18..7c626fa94 100644
--- a/src/emqx_message.erl
+++ b/src/emqx_message.erl
@@ -298,7 +298,8 @@ elapsed(Since) ->
 
 format(#message{id = Id, qos = QoS, topic = Topic, from = From, flags = Flags, headers = Headers}) ->
     io_lib:format("Message(Id=~s, QoS=~w, Topic=~s, From=~p, Flags=~s, Headers=~s)",
-                  [Id, QoS, Topic, From, format(flags, Flags), format(headers, Headers)]).
+                  [emqx_guid:to_hexstr(Id), QoS, Topic, From, format(flags, Flags),
+                   format(headers, Headers)]).
 
 format(flags, Flags) ->
     io_lib:format("~p", [[Flag || {Flag, true} <- maps:to_list(Flags)]]);