log.rabbit => log.exchange

We already have log.file, log.syslog. "rabbit" is not really
a logging mechanism.

(cherry picked from commit ccfc92d1da)

docs/rabbitmq.conf.example

@@ -674,13 +674,13 @@
 ##
 # log.dir = /var/log/rabbitmq
 
-## Logging to rabbit amq.rabbitmq.log exchange (can be true or false)
+## Logging to the amq.rabbitmq.log exchange (can be true or false)
 ##
-# log.rabbit = false
+# log.exchange = false
 
-## Loglevel to log to amq.rabbitmq.log exchange
+## Log level to use when logging to the amq.rabbitmq.log exchange
 ##
-# log.rabbit.level = info
+# log.exchange.level = info
 
 ## Logging to console (can be true or false)
 ##

priv/schema/rabbit.schema

@@ -1047,10 +1047,10 @@ end}.
     {datatype, {enum, [debug, info, notice, warning, error, critical, alert, emergency, none]}}
 ]}.
 
-{mapping, "log.rabbit", "rabbit.log.rabbit.enabled", [
+{mapping, "log.exchange", "rabbit.log.exchange.enabled", [
     {datatype, {enum, [true, false]}}
 ]}.
-{mapping, "log.rabbit.level", "rabbit.log.rabbit.level", [
+{mapping, "log.exchange.level", "rabbit.log.exchange.level", [
     {datatype, {enum, [debug, info, notice, warning, error, critical, alert, emergency, none]}}
 ]}.
 

src/lager_exchange_backend.erl

@@ -24,7 +24,7 @@
 %%                             `time [ severity ] message'</li>
 %% </ul>
 
--module(lager_rabbit_backend).
+-module(lager_exchange_backend).
 
 -behaviour(gen_event).
 
@@ -56,7 +56,7 @@
 -define(DEPRECATED(_Msg), ok).
 -else.
 -define(DEPRECATED(Msg),
-        io:format(user, "WARNING: This is a deprecated lager_rabbit_backend configuration. Please use \"~w\" instead.~n", [Msg])).
+        io:format(user, "WARNING: This is a deprecated lager_exchange_backend configuration. Please use \"~w\" instead.~n", [Msg])).
 -endif.
 
 -define(LOG_EXCH_NAME, <<"amq.rabbitmq.log">>).
@@ -92,7 +92,7 @@ init(Level) when is_atom(Level) ->
     ?DEPRECATED([{level, Level}]),
     init([{level, Level}]);
 init(Other) ->
-    {error, {fatal, {bad_lager_rabbit_backend_config, Other}}}.
+    {error, {fatal, {bad_lager_exchange_backend_config, Other}}}.
 
 validate_options([]) -> true;
 validate_options([{level, L}|T]) when is_atom(L) ->
@@ -107,7 +107,7 @@ validate_options([{formatter, M}|T]) when is_atom(M) ->
 validate_options([{formatter_config, C}|T]) when is_list(C) ->
     validate_options(T);
 validate_options([H|_]) ->
-    throw({error, {fatal, {bad_lager_rabbit_backend_config, H}}}).
+    throw({error, {fatal, {bad_lager_exchange_backend_config, H}}}).
 
 get_option(K, Options, Default) ->
    case lists:keyfind(K, 1, Options) of
@@ -216,7 +216,7 @@ console_config_validation_test_() ->
     [
      ?_assertEqual(true, validate_options(Good)),
      ?_assertThrow({error, {fatal, {bad_level, foo}}}, validate_options(Bad1)),
-     ?_assertThrow({error, {fatal, {bad_lager_rabbit_backend_config, {larval, info}}}}, validate_options(Bad2)),
+     ?_assertThrow({error, {fatal, {bad_lager_exchange_backend_config, {larval, info}}}}, validate_options(Bad2)),
      ?_assertEqual(true, validate_options(AllGood))
     ].
 -endif.

src/rabbit_lager.erl

@@ -263,7 +263,7 @@ generate_lager_handlers(LogHandlersConfig) ->
                     generate_handler(Backend, HandlerConfig)
             end;
         ({Other, HandlerConfig}) when
-              Other =:= console; Other =:= syslog; Other =:= rabbit ->
+              Other =:= console; Other =:= syslog; Other =:= exchange ->
             case proplists:get_value(enabled, HandlerConfig, false) of
                 false -> [];
                 true  ->
@@ -274,10 +274,10 @@ generate_lager_handlers(LogHandlersConfig) ->
     end,
     LogHandlersConfig).
 
-lager_backend(file) -> lager_file_backend;
+lager_backend(file)     -> lager_file_backend;
-lager_backend(console) -> lager_console_backend;
+lager_backend(console)  -> lager_console_backend;
-lager_backend(syslog) -> lager_syslog_backend;
+lager_backend(syslog)   -> lager_syslog_backend;
-lager_backend(rabbit) -> lager_rabbit_backend.
+lager_backend(exchange) -> lager_exchange_backend.
 
 generate_handler(Backend, HandlerConfig) ->
     [{Backend,
@@ -292,7 +292,7 @@ default_handler_config(lager_syslog_backend) ->
 default_handler_config(lager_console_backend) ->
     [{level, default_config_value(level)},
      {formatter_config, default_config_value(formatter_config)}];
-default_handler_config(lager_rabbit_backend) ->
+default_handler_config(lager_exchange_backend) ->
     [{level, default_config_value(level)},
      {formatter_config, default_config_value(formatter_config)}];
 default_handler_config(lager_file_backend) ->

test/config_schema_SUITE_data/rabbit.snippets

@@ -493,10 +493,10 @@ credential_validator.regexp = ^abc\\d+",
    log.console.level = debug",
   [{rabbit,[{log, [{console, [{enabled, true}, {level, debug}]}]}]}],
   []},
- {log_debug_rabbit,
+ {log_debug_exchange,
-  "log.rabbit = true
+  "log.exchange = true
-   log.rabbit.level = debug",
+   log.exchange.level = debug",
-  [{rabbit,[{log, [{rabbit, [{enabled, true}, {level, debug}]}]}]}],
+  [{rabbit,[{log, [{exchange, [{enabled, true}, {level, debug}]}]}]}],
   []},
  {log_debug_syslog,
   "log.syslog = true

test/unit_log_config_SUITE.erl

@@ -29,7 +29,7 @@ all() ->
     config_file_handler_level,
     config_file_handler_rotation,
     config_console_handler,
-    config_rabbit_handler,
+    config_exchange_handler,
     config_syslog_handler,
     config_syslog_handler_options,
     config_multiple_handlers,
@@ -83,7 +83,7 @@ sink_file_rewrites_file_backends(_) ->
         {lager_file_backend, [{file, "lager_file.log"}, {level, error}]},
         {lager_file_backend, [{file, "lager_file_1.log"}, {level, error}]},
         {lager_console_backend, [{level, info}]},
-        {lager_rabbit_backend, [{level, info}]}
+        {lager_exchange_backend, [{level, info}]}
     ],
     application:set_env(lager, handlers, LagerHandlers),
     rabbit_lager:configure_lager(),
@@ -110,7 +110,7 @@ sink_rewrite_sinks() ->
                      {level, warning},
                      {size, 0}]},
             {lager_console_backend, [{level, warning}]},
-            {lager_rabbit_backend, [{level, warning}]}
+            {lager_exchange_backend, [{level, warning}]}
         ]},
          {rabbit_handlers,[
             {lager_file_backend,
@@ -120,7 +120,7 @@ sink_rewrite_sinks() ->
                      {level, warning},
                      {size, 0}]},
             {lager_console_backend, [{level, warning}]},
-            {lager_rabbit_backend, [{level, warning}]}
+            {lager_exchange_backend, [{level, warning}]}
         ]}]},
      {rabbit_log_lager_event,
         [{handlers,[{lager_forwarder_backend,[lager_event,inherit]}]},
@@ -138,9 +138,9 @@ sink_rewrite_sinks() ->
 
 sink_handlers_merged_with_lager_extra_sinks_handlers(_) ->
     application:set_env(rabbit, log, [
-        {file,    [{file, "rabbit_file.log"}, {level, debug}]},
+        {file,     [{file, "rabbit_file.log"}, {level, debug}]},
-        {console, [{enabled, true}, {level, error}]},
+        {console,  [{enabled, true}, {level, error}]},
-        {rabbit,  [{enabled, true}, {level, error}]},
+        {exchange, [{enabled, true}, {level, error}]},
         {categories, [
             {connection, [{level, debug}]},
             {channel, [{level, warning}, {file, "channel_log.log"}]}
@@ -156,7 +156,7 @@ sink_handlers_merged_with_lager_extra_sinks_handlers(_) ->
         {rabbit_log_channel_lager_event,
             [{handlers,
                 [{lager_console_backend, [{level, debug}]},
-                 {lager_rabbit_backend, [{level, debug}]},
+                 {lager_exchange_backend, [{level, debug}]},
                  {lager_file_backend, [{level, error},
                                        {file, "channel_lager.log"}]}]}]}],
 
@@ -171,7 +171,7 @@ sink_handlers_merged_with_lager_extra_sinks_handlers(_) ->
             [{handlers,[
                 {lager_console_backend, [{level, error},
                                          {formatter_config, formatter_config()}]},
-                {lager_rabbit_backend, [{level, error},
+                {lager_exchange_backend, [{level, error},
                                         {formatter_config, formatter_config()}]},
                 {lager_file_backend,
                     [{date, ""},
@@ -180,14 +180,14 @@ sink_handlers_merged_with_lager_extra_sinks_handlers(_) ->
                      {level, warning},
                      {size, 0}]},
                 {lager_console_backend, [{level, debug}]},
-                {lager_rabbit_backend, [{level, debug}]},
+                {lager_exchange_backend, [{level, debug}]},
                 {lager_file_backend, [{level, error},
                                       {file, "channel_lager.log"}]}
                 ]},
              {rabbit_handlers,[
                 {lager_console_backend, [{level, error},
                                          {formatter_config, formatter_config()}]},
-                {lager_rabbit_backend, [{level, error},
+                {lager_exchange_backend, [{level, error},
                                         {formatter_config, formatter_config()}]},
                 {lager_file_backend,
                     [{date, ""},
@@ -222,15 +222,15 @@ config_handlers_merged_with_lager_handlers(_) ->
     application:set_env(rabbit, log, [
         {file,    [{file, "rabbit_file.log"}, {level, debug}]},
         {console, [{enabled, true}, {level, error}]},
-        {rabbit,  [{enabled, true}, {level, error}]},
+        {exchange,  [{enabled, true}, {level, error}]},
         {syslog,  [{enabled, true}]}
     ]),
 
     LagerHandlers = [
         {lager_file_backend, [{file, "lager_file.log"}, {level, info}]},
         {lager_console_backend, [{level, info}]},
-        {lager_rabbit_backend, [{level, info}]},
+        {lager_exchange_backend, [{level, info}]},
-        {lager_rabbit_backend, [{level, info}]}
+        {lager_exchange_backend, [{level, info}]}
     ],
     application:set_env(lager, handlers, LagerHandlers),
     rabbit_lager:configure_lager(),
@@ -296,7 +296,7 @@ config_sink_file(_) ->
 
     application:set_env(rabbit, log, [
         {console, [{enabled, true}]},
-        {rabbit, [{enabled, true}]},
+        {exchange, [{enabled, true}]},
         {file, [{level, error}]},
         {categories, [
             {connection, [{file, "connection.log"}, {level, warning}]}
@@ -317,7 +317,7 @@ config_sink_file_override_config_handler_file(_) ->
     application:set_env(rabbit, log, [
         {file, [{file, NonDefaultLogFile}, {level, error}]},
         {console, [{enabled, true}]},
-        {rabbit, [{enabled, true}]},
+        {exchange, [{enabled, true}]},
         {categories, [
             {connection, [{file, "connection.log"}, {level, warning}]}
         ]}
@@ -339,7 +339,7 @@ file_sinks() ->
         [{handlers,[
             {lager_console_backend, [{level, warning},
                                      {formatter_config, formatter_config()}]},
-            {lager_rabbit_backend, [{level, warning},
+            {lager_exchange_backend, [{level, warning},
                                     {formatter_config, formatter_config()}]},
             {lager_file_backend,
                 [{date, ""},
@@ -350,7 +350,7 @@ file_sinks() ->
          {rabbit_handlers,[
             {lager_console_backend, [{level, warning},
                                      {formatter_config, formatter_config()}]},
-            {lager_rabbit_backend, [{level, warning},
+            {lager_exchange_backend, [{level, warning},
                                     {formatter_config, formatter_config()}]},
             {lager_file_backend,
                 [{date, ""},
@@ -385,8 +385,8 @@ config_multiple_handlers(_) ->
         {file, [{file, false}]},
         %% Enable console output
         {console, [{enabled, true}]},
-        %% Enable rabbit output
+        %% Enable exchange output
-        {rabbit, [{enabled, true}]},
+        {exchange, [{enabled, true}]},
         %% Enable a syslog output
         {syslog, [{enabled, true}, {level, error}]}]),
 
@@ -416,17 +416,17 @@ config_console_handler(_) ->
     ?assertEqual(ExpectedHandlers, sort_handlers(application:get_env(lager, handlers, undefined))),
     ?assertEqual(ExpectedHandlers, sort_handlers(application:get_env(lager, rabbit_handlers, undefined))).
 
-config_rabbit_handler(_) ->
+config_exchange_handler(_) ->
     DefaultLogFile = "rabbit_default.log",
     application:set_env(rabbit, lager_default_file, DefaultLogFile),
-    application:set_env(rabbit, log, [{rabbit, [{enabled, true}]}]),
+    application:set_env(rabbit, log, [{exchange, [{enabled, true}]}]),
 
     rabbit_lager:configure_lager(),
 
     FileHandlers = default_expected_handlers(DefaultLogFile),
-    RabbitHandlers = expected_rabbit_handler(),
+    ExchangeHandlers = expected_rabbit_handler(),
 
-    ExpectedHandlers = sort_handlers(FileHandlers ++ RabbitHandlers),
+    ExpectedHandlers = sort_handlers(FileHandlers ++ ExchangeHandlers),
 
     ?assertEqual(ExpectedHandlers, sort_handlers(application:get_env(lager, handlers, undefined))),
     ?assertEqual(ExpectedHandlers, sort_handlers(application:get_env(lager, rabbit_handlers, undefined))).
@@ -442,7 +442,7 @@ expected_rabbit_handler() ->
     expected_rabbit_handler(info).
 
 expected_rabbit_handler(Level) ->
-    [{lager_rabbit_backend, [{level, Level},
+    [{lager_exchange_backend, [{level, Level},
                              {formatter_config, formatter_config()}]}].
 
 config_syslog_handler(_) ->