root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Remove upgrade-specific log file 

This category should be unused with the decommissioning of the old
upgrade subsystem (in favor of the feature flags subsystem). It means:
1. The upgrade log file will not be created by default anymore.
2. The `$RABBITMQ_UPGRADE_LOG` environment variable is now unsupported.

The configuration variables remain to avoid breaking an existing and
working configuration.
This commit is contained in:
Jean-Sébastien Pédron 2022-08-04 16:41:07 +02:00
parent 46ebd07f5c
commit 4b132daaba
No known key found for this signature in database
GPG Key ID: 39E99761A5FD94CC
6 changed files with 25 additions and 356 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
deps/rabbit/src/rabbit_log_upgrade.erl vendored
View File

@ -1,122 +0,0 @@
%% This Source Code Form is subject to the terms of the Mozilla Public
%% License, v. 2.0. If a copy of the MPL was not distributed with this
%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
%%
%% Copyright (c) 2021 VMware, Inc. or its affiliates. All rights reserved.
%%
%% @doc Compatibility module for the old Lager-based logging API.
-module(rabbit_log_upgrade).
-export([debug/1, debug/2, debug/3,
info/1, info/2, info/3,
notice/1, notice/2, notice/3,
warning/1, warning/2, warning/3,
error/1, error/2, error/3,
critical/1, critical/2, critical/3,
alert/1, alert/2, alert/3,
emergency/1, emergency/2, emergency/3,
none/1, none/2, none/3]).
-include_lib("rabbit_common/include/logging.hrl").
-compile({no_auto_import, [error/2, error/3]}).
%%----------------------------------------------------------------------------
-spec debug(string()) -> 'ok'.
debug(Format) -> debug(Format, []).
-spec debug(string(), [any()]) -> 'ok'.
debug(Format, Args) -> debug(self(), Format, Args).
-spec debug(pid() | [tuple()], string(), [any()]) -> 'ok'.
debug(Pid, Format, Args) ->
logger:debug(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec info(string()) -> 'ok'.
info(Format) -> info(Format, []).
-spec info(string(), [any()]) -> 'ok'.
info(Format, Args) -> info(self(), Format, Args).
-spec info(pid() | [tuple()], string(), [any()]) -> 'ok'.
info(Pid, Format, Args) ->
logger:info(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec notice(string()) -> 'ok'.
notice(Format) -> notice(Format, []).
-spec notice(string(), [any()]) -> 'ok'.
notice(Format, Args) -> notice(self(), Format, Args).
-spec notice(pid() | [tuple()], string(), [any()]) -> 'ok'.
notice(Pid, Format, Args) ->
logger:notice(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec warning(string()) -> 'ok'.
warning(Format) -> warning(Format, []).
-spec warning(string(), [any()]) -> 'ok'.
warning(Format, Args) -> warning(self(), Format, Args).
-spec warning(pid() | [tuple()], string(), [any()]) -> 'ok'.
warning(Pid, Format, Args) ->
logger:warning(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec error(string()) -> 'ok'.
error(Format) -> error(Format, []).
-spec error(string(), [any()]) -> 'ok'.
error(Format, Args) -> error(self(), Format, Args).
-spec error(pid() | [tuple()], string(), [any()]) -> 'ok'.
error(Pid, Format, Args) ->
logger:error(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec critical(string()) -> 'ok'.
critical(Format) -> critical(Format, []).
-spec critical(string(), [any()]) -> 'ok'.
critical(Format, Args) -> critical(self(), Format, Args).
-spec critical(pid() | [tuple()], string(), [any()]) -> 'ok'.
critical(Pid, Format, Args) ->
logger:critical(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec alert(string()) -> 'ok'.
alert(Format) -> alert(Format, []).
-spec alert(string(), [any()]) -> 'ok'.
alert(Format, Args) -> alert(self(), Format, Args).
-spec alert(pid() | [tuple()], string(), [any()]) -> 'ok'.
alert(Pid, Format, Args) ->
logger:alert(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec emergency(string()) -> 'ok'.
emergency(Format) -> emergency(Format, []).
-spec emergency(string(), [any()]) -> 'ok'.
emergency(Format, Args) -> emergency(self(), Format, Args).
-spec emergency(pid() | [tuple()], string(), [any()]) -> 'ok'.
emergency(Pid, Format, Args) ->
logger:emergency(Format, Args, #{pid => Pid,
domain => ?RMQLOG_DOMAIN_UPGRADE}).
-spec none(string()) -> 'ok'.
none(_Format) -> ok.
-spec none(string(), [any()]) -> 'ok'.
none(_Format, _Args) -> ok.
-spec none(pid() | [tuple()], string(), [any()]) -> 'ok'.
none(_Pid, _Format, _Args) -> ok.

35
deps/rabbit/src/rabbit_prelaunch_logging.erl vendored
View File

@ -986,9 +986,7 @@ normalize_per_cat_log_config([], LogConfig, _) ->
log_config(). log_config().
handle_default_and_overridden_outputs(LogConfig, Context) -> handle_default_and_overridden_outputs(LogConfig, Context) ->
LogConfig1 = handle_default_main_output(LogConfig, Context), handle_default_main_output(LogConfig, Context).
LogConfig2 = handle_default_upgrade_cat_output(LogConfig1, Context),
LogConfig2.
-spec handle_default_main_output(log_config(), rabbit_env:context()) -> -spec handle_default_main_output(log_config(), rabbit_env:context()) ->
log_config(). log_config().
@ -1026,37 +1024,6 @@ handle_default_main_output(
outputs => Outputs1}} outputs => Outputs1}}
end. end.
-spec handle_default_upgrade_cat_output(log_config(), rabbit_env:context()) ->
log_config().
handle_default_upgrade_cat_output(
#{per_category := PerCatConfig} = LogConfig,
#{upgrade_log_file := UpgLogFile} = Context) ->
UpgCatConfig = case PerCatConfig of
#{upgrade := CatConfig} -> CatConfig;
_ -> #{outputs => []}
end,
#{outputs := Outputs} = UpgCatConfig,
NoOutputsConfigured = Outputs =:= [],
Overridden = rabbit_env:has_var_been_overridden(
Context, upgrade_log_file),
Outputs1 = if
NoOutputsConfigured orelse Overridden ->
Output0 = log_file_var_to_output(UpgLogFile),
Output1 = keep_log_level_from_equivalent_output(
Output0, Outputs),
[Output1];
true ->
Outputs
end,
case Outputs1 of
Outputs -> LogConfig;
_ -> LogConfig#{
per_category => PerCatConfig#{
upgrade => UpgCatConfig#{
outputs => Outputs1}}}
end.
-spec log_file_var_to_output(file:filename() | string()) -> -spec log_file_var_to_output(file:filename() | string()) ->
logger:handler_config(). logger:handler_config().

166
deps/rabbit/test/logging_SUITE.erl vendored
View File

@ -208,38 +208,19 @@ logging_with_default_config_works(Config) ->
module := rabbit_logger_std_h, module := rabbit_logger_std_h,
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, stop}}, filters := [{progress_reports, {_, stop}},
{rmqlog_filter, {_, #{global := info, {rmqlog_filter, {_, #{global := info}}}],
upgrade := none}}}],
formatter := {rabbit_logger_text_fmt, _}, formatter := {rabbit_logger_text_fmt, _},
config := #{type := file, config := #{type := file,
file := MainFile}}, file := MainFile}},
MainFileHandler), MainFileHandler),
UpgradeFileHandler = get_handler_by_id(Handlers, rmq_1_file_2),
UpgradeFile = upgrade_log_file_in_context(Context),
?assertNotEqual(undefined, UpgradeFileHandler),
?assertMatch(
#{level := info,
module := rabbit_logger_std_h,
filter_default := stop,
filters := [{rmqlog_filter, {_, #{upgrade := info}}}],
formatter := {rabbit_logger_text_fmt, _},
config := #{type := file,
file := UpgradeFile}},
UpgradeFileHandler),
?assert(ping_log(rmq_1_file_1, info)), ?assert(ping_log(rmq_1_file_1, info)),
?assert(ping_log(rmq_1_file_1, info, ?assert(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})), #{domain => ?RMQLOG_DOMAIN_GLOBAL})),
?assert(ping_log(rmq_1_file_1, info, ?assert(ping_log(rmq_1_file_1, info,
#{domain => ['3rd_party']})), #{domain => ['3rd_party']})),
?assertNot(ping_log(rmq_1_file_1, info, ?assert(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})), #{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assert(ping_log(rmq_1_file_2, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assertNot(ping_log(rmq_1_file_2, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})),
ok. ok.
setting_log_levels_in_env_works(Config) -> setting_log_levels_in_env_works(Config) ->
@ -265,26 +246,12 @@ setting_log_levels_in_env_works(Config) ->
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, stop}}, filters := [{progress_reports, {_, stop}},
{rmqlog_filter, {_, #{global := GlobalLevel, {rmqlog_filter, {_, #{global := GlobalLevel,
prelaunch := PrelaunchLevel, prelaunch := PrelaunchLevel}}}],
upgrade := none}}}],
formatter := {rabbit_logger_text_fmt, _}, formatter := {rabbit_logger_text_fmt, _},
config := #{type := file, config := #{type := file,
file := MainFile}}, file := MainFile}},
MainFileHandler), MainFileHandler),
UpgradeFileHandler = get_handler_by_id(Handlers, rmq_1_file_2),
UpgradeFile = upgrade_log_file_in_context(Context),
?assertNotEqual(undefined, UpgradeFileHandler),
?assertMatch(
#{level := info,
module := rabbit_logger_std_h,
filter_default := stop,
filters := [{rmqlog_filter, {_, #{upgrade := info}}}],
formatter := {rabbit_logger_text_fmt, _},
config := #{type := file,
file := UpgradeFile}},
UpgradeFileHandler),
?assertNot(ping_log(rmq_1_file_1, info)), ?assertNot(ping_log(rmq_1_file_1, info)),
?assertNot(ping_log(rmq_1_file_1, info, ?assertNot(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})), #{domain => ?RMQLOG_DOMAIN_GLOBAL})),
@ -304,13 +271,8 @@ setting_log_levels_in_env_works(Config) ->
#{domain => ?RMQLOG_DOMAIN_PRELAUNCH})), #{domain => ?RMQLOG_DOMAIN_PRELAUNCH})),
?assert(ping_log(rmq_1_file_1, GlobalLevel, ?assert(ping_log(rmq_1_file_1, GlobalLevel,
#{domain => ['3rd_party']})), #{domain => ['3rd_party']})),
?assertNot(ping_log(rmq_1_file_1, GlobalLevel, ?assert(ping_log(rmq_1_file_1, GlobalLevel,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})), #{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assert(ping_log(rmq_1_file_2, GlobalLevel,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assertNot(ping_log(rmq_1_file_2, GlobalLevel,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})),
ok. ok.
setting_log_levels_in_config_works(Config) -> setting_log_levels_in_config_works(Config) ->
@ -338,26 +300,12 @@ setting_log_levels_in_config_works(Config) ->
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, stop}}, filters := [{progress_reports, {_, stop}},
{rmqlog_filter, {_, #{global := GlobalLevel, {rmqlog_filter, {_, #{global := GlobalLevel,
prelaunch := PrelaunchLevel, prelaunch := PrelaunchLevel}}}],
upgrade := none}}}],
formatter := {rabbit_logger_text_fmt, _}, formatter := {rabbit_logger_text_fmt, _},
config := #{type := file, config := #{type := file,
file := MainFile}}, file := MainFile}},
MainFileHandler), MainFileHandler),
UpgradeFileHandler = get_handler_by_id(Handlers, rmq_1_file_2),
UpgradeFile = upgrade_log_file_in_context(Context),
?assertNotEqual(undefined, UpgradeFileHandler),
?assertMatch(
#{level := info,
module := rabbit_logger_std_h,
filter_default := stop,
filters := [{rmqlog_filter, {_, #{upgrade := info}}}],
formatter := {rabbit_logger_text_fmt, _},
config := #{type := file,
file := UpgradeFile}},
UpgradeFileHandler),
?assertNot(ping_log(rmq_1_file_1, info)), ?assertNot(ping_log(rmq_1_file_1, info)),
?assertNot(ping_log(rmq_1_file_1, info, ?assertNot(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})), #{domain => ?RMQLOG_DOMAIN_GLOBAL})),
@ -377,13 +325,8 @@ setting_log_levels_in_config_works(Config) ->
#{domain => ?RMQLOG_DOMAIN_PRELAUNCH})), #{domain => ?RMQLOG_DOMAIN_PRELAUNCH})),
?assert(ping_log(rmq_1_file_1, GlobalLevel, ?assert(ping_log(rmq_1_file_1, GlobalLevel,
#{domain => ['3rd_party']})), #{domain => ['3rd_party']})),
?assertNot(ping_log(rmq_1_file_1, GlobalLevel, ?assert(ping_log(rmq_1_file_1, GlobalLevel,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})), #{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assert(ping_log(rmq_1_file_2, GlobalLevel,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assertNot(ping_log(rmq_1_file_2, GlobalLevel,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})),
ok. ok.
setting_log_rotation_in_config_works(Config) -> setting_log_rotation_in_config_works(Config) ->
@ -500,31 +443,17 @@ setting_log_levels_in_config_with_output_overridden_in_env_works(Config) ->
module := rabbit_logger_std_h, module := rabbit_logger_std_h,
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, log}}, filters := [{progress_reports, {_, log}},
{rmqlog_filter, {_, #{global := debug, {rmqlog_filter, {_, #{global := debug}}}],
upgrade := none}}}],
formatter := {rabbit_logger_text_fmt, _}, formatter := {rabbit_logger_text_fmt, _},
config := #{type := standard_io}}, config := #{type := standard_io}},
StddevHandler), StddevHandler),
UpgradeFileHandler = get_handler_by_id(Handlers, rmq_1_file_1),
UpgradeFile = upgrade_log_file_in_context(Context),
?assertNotEqual(undefined, UpgradeFileHandler),
?assertMatch(
#{level := info,
module := rabbit_logger_std_h,
filter_default := stop,
filters := [{rmqlog_filter, {_, #{upgrade := info}}}],
formatter := {rabbit_logger_text_fmt, _},
config := #{type := file,
file := UpgradeFile}},
UpgradeFileHandler),
?assert(ping_log(rmq_1_stdout, debug, Config)), ?assert(ping_log(rmq_1_stdout, debug, Config)),
?assert(ping_log(rmq_1_stdout, debug, ?assert(ping_log(rmq_1_stdout, debug,
#{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config)), #{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config)),
?assert(ping_log(rmq_1_stdout, debug, ?assert(ping_log(rmq_1_stdout, debug,
#{domain => ['3rd_party']}, Config)), #{domain => ['3rd_party']}, Config)),
?assertNot(ping_log(rmq_1_stdout, debug, ?assert(ping_log(rmq_1_stdout, debug,
#{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config)), #{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config)),
ok. ok.
@ -726,8 +655,7 @@ formatting_as_json_works(_, Context) ->
module := rabbit_logger_std_h, module := rabbit_logger_std_h,
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, stop}}, filters := [{progress_reports, {_, stop}},
{rmqlog_filter, {_, #{global := info, {rmqlog_filter, {_, #{global := info}}}],
upgrade := none}}}],
formatter := {rabbit_logger_json_fmt, _}, formatter := {rabbit_logger_json_fmt, _},
config := #{type := file, config := #{type := file,
file := MainFile}}, file := MainFile}},
@ -915,37 +843,18 @@ logging_to_stddev_works(Stddev, Id, Config, Context) ->
module := rabbit_logger_std_h, module := rabbit_logger_std_h,
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, stop}}, filters := [{progress_reports, {_, stop}},
{rmqlog_filter, {_, #{global := info, {rmqlog_filter, {_, #{global := info}}}],
upgrade := none}}}],
formatter := {rabbit_logger_text_fmt, _}, formatter := {rabbit_logger_text_fmt, _},
config := #{type := Stddev}}, config := #{type := Stddev}},
StddevHandler), StddevHandler),
UpgradeFileHandler = get_handler_by_id(Handlers, rmq_1_file_1),
UpgradeFile = upgrade_log_file_in_context(Context),
?assertNotEqual(undefined, UpgradeFileHandler),
?assertMatch(
#{level := info,
module := rabbit_logger_std_h,
filter_default := stop,
filters := [{rmqlog_filter, {_, #{upgrade := info}}}],
formatter := {rabbit_logger_text_fmt, _},
config := #{type := file,
file := UpgradeFile}},
UpgradeFileHandler),
?assert(ping_log(Id, info, Config)), ?assert(ping_log(Id, info, Config)),
?assert(ping_log(Id, info, ?assert(ping_log(Id, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config)), #{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config)),
?assert(ping_log(Id, info, ?assert(ping_log(Id, info,
#{domain => ['3rd_party']}, Config)), #{domain => ['3rd_party']}, Config)),
?assertNot(ping_log(Id, info, ?assert(ping_log(Id, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config)), #{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config)),
?assert(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assertNot(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})),
ok. ok.
formatting_with_colors_works(Config) -> formatting_with_colors_works(Config) ->
@ -1008,27 +917,13 @@ logging_to_exchange_works(Config) ->
module := rabbit_logger_exchange_h, module := rabbit_logger_exchange_h,
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, stop}}, filters := [{progress_reports, {_, stop}},
{rmqlog_filter, {_, #{global := info, {rmqlog_filter, {_, #{global := info}}}],
upgrade := none}}}],
formatter := {rabbit_logger_text_fmt, _}, formatter := {rabbit_logger_text_fmt, _},
config := #{exchange := _}}, config := #{exchange := _}},
ExchangeHandler), ExchangeHandler),
#{config := #{config :=
#{exchange := #resource{name = XName} = Exchange}} = ExchangeHandler, #{exchange := #resource{name = XName} = Exchange}} = ExchangeHandler,
UpgradeFileHandler = get_handler_by_id(Handlers, rmq_1_file_2),
UpgradeFile = upgrade_log_file_in_context(Context),
?assertNotEqual(undefined, UpgradeFileHandler),
?assertMatch(
#{level := info,
module := rabbit_logger_std_h,
filter_default := stop,
filters := [{rmqlog_filter, {_, #{upgrade := info}}}],
formatter := {rabbit_logger_text_fmt, _},
config := #{type := file,
file := UpgradeFile}},
UpgradeFileHandler),
%% Wait for the expected exchange to be automatically declared. %% Wait for the expected exchange to be automatically declared.
lists:any( lists:any(
fun(_) -> fun(_) ->
@ -1063,14 +958,9 @@ logging_to_exchange_works(Config) ->
#{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config1)), #{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config1)),
?assert(ping_log(rmq_1_exchange, info, ?assert(ping_log(rmq_1_exchange, info,
#{domain => ['3rd_party']}, Config1)), #{domain => ['3rd_party']}, Config1)),
?assertNot(ping_log(rmq_1_exchange, info, ?assert(ping_log(rmq_1_exchange, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config1)), #{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config1)),
?assert(ping_log(rmq_1_file_2, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config)),
?assertNot(ping_log(rmq_1_file_2, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config)),
%% increase log level %% increase log level
ok = rabbit_ct_broker_helpers:rpc( ok = rabbit_ct_broker_helpers:rpc(
Config, 0, Config, 0,
@ -1151,37 +1041,18 @@ logging_to_syslog_works(Config) ->
module := syslog_logger_h, module := syslog_logger_h,
filter_default := log, filter_default := log,
filters := [{progress_reports, {_, stop}}, filters := [{progress_reports, {_, stop}},
{rmqlog_filter, {_, #{global := info, {rmqlog_filter, {_, #{global := info}}}],
upgrade := none}}}],
formatter := {rabbit_logger_text_fmt, _}, formatter := {rabbit_logger_text_fmt, _},
config := #{}}, config := #{}},
SyslogHandler), SyslogHandler),
UpgradeFileHandler = get_handler_by_id(Handlers, rmq_1_file_1),
UpgradeFile = upgrade_log_file_in_context(Context),
?assertNotEqual(undefined, UpgradeFileHandler),
?assertMatch(
#{level := info,
module := rabbit_logger_std_h,
filter_default := stop,
filters := [{rmqlog_filter, {_, #{upgrade := info}}}],
formatter := {rabbit_logger_text_fmt, _},
config := #{type := file,
file := UpgradeFile}},
UpgradeFileHandler),
?assert(ping_log(rmq_1_syslog, info, Config)), ?assert(ping_log(rmq_1_syslog, info, Config)),
?assert(ping_log(rmq_1_syslog, info, ?assert(ping_log(rmq_1_syslog, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config)), #{domain => ?RMQLOG_DOMAIN_GLOBAL}, Config)),
?assert(ping_log(rmq_1_syslog, info, ?assert(ping_log(rmq_1_syslog, info,
#{domain => ['3rd_party']}, Config)), #{domain => ['3rd_party']}, Config)),
?assertNot(ping_log(rmq_1_syslog, info, ?assert(ping_log(rmq_1_syslog, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config)), #{domain => ?RMQLOG_DOMAIN_UPGRADE}, Config)),
?assert(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_UPGRADE})),
?assertNot(ping_log(rmq_1_file_1, info,
#{domain => ?RMQLOG_DOMAIN_GLOBAL})),
ok. ok.
%% ------------------------------------------------------------------- %% -------------------------------------------------------------------
@ -1191,24 +1062,17 @@ logging_to_syslog_works(Config) ->
default_context(Config) -> default_context(Config) ->
LogBaseDir = ?config(log_base_dir, Config), LogBaseDir = ?config(log_base_dir, Config),
MainFile = "rabbit.log", MainFile = "rabbit.log",
UpgradeFile = "rabbit_upgrade.log",
#{log_base_dir => LogBaseDir, #{log_base_dir => LogBaseDir,
main_log_file => MainFile, main_log_file => MainFile,
upgrade_log_file => UpgradeFile,
log_levels => undefined, log_levels => undefined,
var_origins => #{log_base_dir => default, var_origins => #{log_base_dir => default,
main_log_file => default, main_log_file => default,
upgrade_log_file => default,
log_levels => default}}. log_levels => default}}.
main_log_file_in_context(#{log_base_dir := LogBaseDir, main_log_file_in_context(#{log_base_dir := LogBaseDir,
main_log_file := MainLogFile}) -> main_log_file := MainLogFile}) ->
filename:join(LogBaseDir, MainLogFile). filename:join(LogBaseDir, MainLogFile).
upgrade_log_file_in_context(#{log_base_dir := LogBaseDir,
upgrade_log_file := UpgradeLogFile}) ->
filename:join(LogBaseDir, UpgradeLogFile).
log_file_in_context(#{log_base_dir := LogBaseDir}, FileName) -> log_file_in_context(#{log_base_dir := LogBaseDir}, FileName) ->
filename:join(LogBaseDir, FileName). filename:join(LogBaseDir, FileName).

18
deps/rabbit_common/src/rabbit_env.erl vendored
View File

@ -79,7 +79,6 @@
"RABBITMQ_PRODUCT_VERSION", "RABBITMQ_PRODUCT_VERSION",
"RABBITMQ_QUORUM_DIR", "RABBITMQ_QUORUM_DIR",
"RABBITMQ_STREAM_DIR", "RABBITMQ_STREAM_DIR",
"RABBITMQ_UPGRADE_LOG",
"RABBITMQ_USE_LONGNAME", "RABBITMQ_USE_LONGNAME",
"SYS_PREFIX" "SYS_PREFIX"
]). ]).
@ -142,7 +141,6 @@ get_context_after_reloading_env(Context) ->
fun advanced_config_file/1, fun advanced_config_file/1,
fun log_base_dir/1, fun log_base_dir/1,
fun main_log_file/1, fun main_log_file/1,
fun upgrade_log_file/1,
fun mnesia_base_dir/1, fun mnesia_base_dir/1,
fun mnesia_dir/1, fun mnesia_dir/1,
fun quorum_queue_dir/1, fun quorum_queue_dir/1,
@ -624,10 +622,6 @@ get_default_advanced_config_file(#{config_base_dir := ConfigBaseDir}) ->
%% Main log file %% Main log file
%% Default: ${RABBITMQ_LOG_BASE}/${RABBITMQ_NODENAME}.log %% Default: ${RABBITMQ_LOG_BASE}/${RABBITMQ_NODENAME}.log
%% %%
%% RABBITMQ_UPDATE_LOG
%% Upgrade-procesure-specific log file
%% Default: ${RABBITMQ_LOG_BASE}/${RABBITMQ_NODENAME}_upgrade.log
%%
%% RABBITMQ_LOG %% RABBITMQ_LOG
%% Log level; overrides the configuration file value %% Log level; overrides the configuration file value
%% Default: (undefined) %% Default: (undefined)
@ -733,18 +727,6 @@ main_log_file(#{nodename := Nodename,
update_context(Context, main_log_file, File, environment) update_context(Context, main_log_file, File, environment)
end. end.
upgrade_log_file(#{nodename := Nodename,
log_base_dir := LogBaseDir} = Context) ->
case get_prefixed_env_var("RABBITMQ_UPGRADE_LOG") of
false ->
UpgradeLogFileName = atom_to_list(Nodename) ++ "_upgrade.log",
File = normalize_path(LogBaseDir, UpgradeLogFileName),
update_context(Context, upgrade_log_file, File, default);
Value ->
File = normalize_path(Value),
update_context(Context, upgrade_log_file, File, environment)
end.
dbg_config() -> dbg_config() ->
{Mods, Output} = get_dbg_config(), {Mods, Output} = get_dbg_config(),
#{dbg_output => Output, #{dbg_output => Output,

28
deps/rabbit_common/test/rabbit_env_SUITE.erl vendored
View File

@ -53,7 +53,6 @@
check_RABBITMQ_PRODUCT_VERSION/1, check_RABBITMQ_PRODUCT_VERSION/1,
check_RABBITMQ_QUORUM_DIR/1, check_RABBITMQ_QUORUM_DIR/1,
check_RABBITMQ_STREAM_DIR/1, check_RABBITMQ_STREAM_DIR/1,
check_RABBITMQ_UPGRADE_LOG/1,
check_RABBITMQ_USE_LOGNAME/1, check_RABBITMQ_USE_LOGNAME/1,
check_value_is_yes/1, check_value_is_yes/1,
check_log_process_env/1, check_log_process_env/1,
@ -97,7 +96,6 @@ all() ->
check_RABBITMQ_PRODUCT_NAME, check_RABBITMQ_PRODUCT_NAME,
check_RABBITMQ_PRODUCT_VERSION, check_RABBITMQ_PRODUCT_VERSION,
check_RABBITMQ_QUORUM_DIR, check_RABBITMQ_QUORUM_DIR,
check_RABBITMQ_UPGRADE_LOG,
check_RABBITMQ_USE_LOGNAME, check_RABBITMQ_USE_LOGNAME,
check_value_is_yes, check_value_is_yes,
check_log_process_env, check_log_process_env,
@ -205,8 +203,7 @@ check_default_values(_) ->
product_version => default, product_version => default,
quorum_queue_dir => default, quorum_queue_dir => default,
rabbitmq_home => default, rabbitmq_home => default,
stream_queue_dir => default, stream_queue_dir => default
upgrade_log_file => default
}, },
?assertEqual( ?assertEqual(
@ -256,8 +253,6 @@ check_default_values(_) ->
"/var/lib/rabbitmq/mnesia/" ++ NodeS ++ "/stream", "/var/lib/rabbitmq/mnesia/" ++ NodeS ++ "/stream",
split_nodename => rabbit_nodes_common:parts(Node), split_nodename => rabbit_nodes_common:parts(Node),
sys_prefix => "", sys_prefix => "",
upgrade_log_file =>
"/var/log/rabbitmq/" ++ NodeS ++ "_upgrade.log",
var_origins => Origins#{sys_prefix => default}}, var_origins => Origins#{sys_prefix => default}},
UnixContext), UnixContext),
@ -309,8 +304,6 @@ check_default_values(_) ->
stream_queue_dir => stream_queue_dir =>
"%APPDATA%/RabbitMQ/db/" ++ NodeS ++ "-mnesia/stream", "%APPDATA%/RabbitMQ/db/" ++ NodeS ++ "-mnesia/stream",
split_nodename => rabbit_nodes_common:parts(Node), split_nodename => rabbit_nodes_common:parts(Node),
upgrade_log_file =>
"%APPDATA%/RabbitMQ/log/" ++ NodeS ++ "_upgrade.log",
var_origins => Origins#{rabbitmq_base => default}}, var_origins => Origins#{rabbitmq_base => default}},
Win32Context). Win32Context).
@ -430,8 +423,7 @@ check_values_from_reachable_remote_node(Config) ->
product_version => default, product_version => default,
quorum_queue_dir => default, quorum_queue_dir => default,
rabbitmq_home => default, rabbitmq_home => default,
stream_queue_dir => default, stream_queue_dir => default
upgrade_log_file => default
}, },
?assertEqual( ?assertEqual(
@ -478,8 +470,6 @@ check_values_from_reachable_remote_node(Config) ->
stream_queue_dir => MnesiaDir ++ "/stream", stream_queue_dir => MnesiaDir ++ "/stream",
split_nodename => rabbit_nodes_common:parts(Node), split_nodename => rabbit_nodes_common:parts(Node),
sys_prefix => "", sys_prefix => "",
upgrade_log_file =>
"/var/log/rabbitmq/" ++ NodeS ++ "_upgrade.log",
var_origins => Origins#{sys_prefix => default}}, var_origins => Origins#{sys_prefix => default}},
UnixContext) UnixContext)
@ -555,8 +545,7 @@ check_values_from_offline_remote_node(_) ->
product_version => default, product_version => default,
quorum_queue_dir => default, quorum_queue_dir => default,
rabbitmq_home => default, rabbitmq_home => default,
stream_queue_dir => default, stream_queue_dir => default
upgrade_log_file => default
}, },
?assertEqual( ?assertEqual(
@ -603,8 +592,6 @@ check_values_from_offline_remote_node(_) ->
stream_queue_dir => undefined, stream_queue_dir => undefined,
split_nodename => rabbit_nodes_common:parts(Node), split_nodename => rabbit_nodes_common:parts(Node),
sys_prefix => "", sys_prefix => "",
upgrade_log_file =>
"/var/log/rabbitmq/" ++ NodeS ++ "_upgrade.log",
var_origins => Origins#{sys_prefix => default}}, var_origins => Origins#{sys_prefix => default}},
UnixContext). UnixContext).
@ -907,15 +894,6 @@ check_RABBITMQ_LOGS(_) ->
Value1, Value1, Value1, Value1,
Value2, Value2). Value2, Value2).
check_RABBITMQ_UPGRADE_LOG(_) ->
Value1 = random_string(),
Value2 = random_string(),
check_prefixed_variable("RABBITMQ_UPGRADE_LOG",
upgrade_log_file,
'_',
Value1, Value1,
Value2, Value2).
check_RABBITMQ_MNESIA_BASE(_) -> check_RABBITMQ_MNESIA_BASE(_) ->
Value1 = random_string(), Value1 = random_string(),
Value2 = random_string(), Value2 = random_string(),

4
deps/rabbitmq_cli/test/diagnostics/log_location_command_test.exs vendored
View File

@ -64,7 +64,7 @@ defmodule LogLocationCommandTest do
test "run: shows all log locations", context do test "run: shows all log locations", context do
# This assumes default configuration # This assumes default configuration
[logfile, upgrade_log_file | _] = @command.run([], Map.merge(context[:opts], %{all: true})) [logfile | _] = @command.run([], Map.merge(context[:opts], %{all: true}))
log_message = "checking the default log file when checking all" log_message = "checking the default log file when checking all"
:rpc.call(get_rabbit_hostname(), :rabbit_log, :error, [to_charlist(log_message)]) :rpc.call(get_rabbit_hostname(), :rabbit_log, :error, [to_charlist(log_message)])
@ -79,6 +79,6 @@ defmodule LogLocationCommandTest do
[] []
]) ])
wait_for_log_message(log_message_upgrade, upgrade_log_file) wait_for_log_message(log_message_upgrade, logfile)
end end
end end