From b3074144cc81f1ac4e1557c1e9aeaa9eece96ce9 Mon Sep 17 00:00:00 2001 From: Thales Macedo Garitezi Date: Wed, 24 Jul 2024 16:40:30 -0300 Subject: [PATCH] chore: temporarily revert `NO_DOC` changes to fields with default value = false These will be dealt with in follow up PRs, by allowing the parent struct to be set to a special `disabled` value in such cases. --- apps/emqx/src/emqx_schema.erl | 8 ++++---- apps/emqx_conf/src/emqx_conf_schema.erl | 7 ++++++- apps/emqx_dashboard_sso/src/emqx_dashboard_sso_schema.erl | 2 +- apps/emqx_ft/src/emqx_ft_schema.erl | 2 +- apps/emqx_opentelemetry/src/emqx_otel_schema.erl | 8 +++++--- apps/emqx_prometheus/src/emqx_prometheus_schema.erl | 4 ++-- apps/emqx_psk/src/emqx_psk_schema.erl | 2 +- apps/emqx_slow_subs/src/emqx_slow_subs_schema.erl | 7 ++++--- rel/config/examples/gateway.exproto.conf.example | 1 + rel/config/examples/plugins.conf.example | 2 +- 10 files changed, 26 insertions(+), 17 deletions(-) diff --git a/apps/emqx/src/emqx_schema.erl b/apps/emqx/src/emqx_schema.erl index eb4c7cf95..827836540 100644 --- a/apps/emqx/src/emqx_schema.erl +++ b/apps/emqx/src/emqx_schema.erl @@ -388,7 +388,7 @@ fields("flapping_detect") -> boolean(), #{ default => false, - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, desc => ?DESC(flapping_detect_enable) } )}, @@ -455,7 +455,7 @@ fields("overload_protection") -> boolean(), #{ desc => ?DESC(overload_protection_enable), - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, default => false } )}, @@ -1673,7 +1673,7 @@ fields("durable_sessions") -> sc( boolean(), #{ desc => ?DESC(durable_sessions_enable), - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, default => false } )}, @@ -2426,7 +2426,7 @@ client_ssl_opts_schema(Defaults) -> boolean(), #{ default => false, - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, desc => ?DESC(client_ssl_opts_schema_enable) } )}, diff --git a/apps/emqx_conf/src/emqx_conf_schema.erl b/apps/emqx_conf/src/emqx_conf_schema.erl index a83349ff0..1ae32172b 100644 --- a/apps/emqx_conf/src/emqx_conf_schema.erl +++ b/apps/emqx_conf/src/emqx_conf_schema.erl @@ -1271,6 +1271,11 @@ log_handler_common_confs(Handler, Default) -> EnvValue = os:getenv("EMQX_DEFAULT_LOG_HANDLER"), Enable = lists:member(EnvValue, EnableValues), LevelDesc = maps:get(level_desc, Default, "common_handler_level"), + EnableImportance = + case Enable of + true -> ?IMPORTANCE_NO_DOC; + false -> ?IMPORTANCE_MEDIUM + end, [ {"level", sc( @@ -1287,7 +1292,7 @@ log_handler_common_confs(Handler, Default) -> #{ default => Enable, desc => ?DESC("common_handler_enable"), - importance => ?IMPORTANCE_NO_DOC + importance => EnableImportance } )}, {"formatter", diff --git a/apps/emqx_dashboard_sso/src/emqx_dashboard_sso_schema.erl b/apps/emqx_dashboard_sso/src/emqx_dashboard_sso_schema.erl index 314839ee4..f64c7a7df 100644 --- a/apps/emqx_dashboard_sso/src/emqx_dashboard_sso_schema.erl +++ b/apps/emqx_dashboard_sso/src/emqx_dashboard_sso_schema.erl @@ -47,7 +47,7 @@ common_backend_schema(Backend) -> mk( boolean(), #{ desc => ?DESC(backend_enable), - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, required => false, default => false } diff --git a/apps/emqx_ft/src/emqx_ft_schema.erl b/apps/emqx_ft/src/emqx_ft_schema.erl index 770b0509c..f779121d3 100644 --- a/apps/emqx_ft/src/emqx_ft_schema.erl +++ b/apps/emqx_ft/src/emqx_ft_schema.erl @@ -66,7 +66,7 @@ fields(file_transfer) -> boolean(), #{ desc => ?DESC("enable"), - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, required => false, default => false } diff --git a/apps/emqx_opentelemetry/src/emqx_otel_schema.erl b/apps/emqx_opentelemetry/src/emqx_otel_schema.erl index d4c6dca0a..a12efc7a9 100644 --- a/apps/emqx_opentelemetry/src/emqx_otel_schema.erl +++ b/apps/emqx_opentelemetry/src/emqx_otel_schema.erl @@ -72,7 +72,7 @@ fields("otel_metrics") -> boolean(), #{ default => false, - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, required => true, desc => ?DESC(enable) } @@ -105,7 +105,8 @@ fields("otel_logs") -> #{ default => false, desc => ?DESC(enable), - importance => ?IMPORTANCE_NO_DOC + %% importance => ?IMPORTANCE_NO_DOC + importance => ?IMPORTANCE_HIGH } )}, {max_queue_size, @@ -144,7 +145,8 @@ fields("otel_traces") -> #{ default => false, desc => ?DESC(enable), - importance => ?IMPORTANCE_NO_DOC + %% importance => ?IMPORTANCE_NO_DOC + importance => ?IMPORTANCE_HIGH } )}, {max_queue_size, diff --git a/apps/emqx_prometheus/src/emqx_prometheus_schema.erl b/apps/emqx_prometheus/src/emqx_prometheus_schema.erl index 09f19bdb1..6d3503a82 100644 --- a/apps/emqx_prometheus/src/emqx_prometheus_schema.erl +++ b/apps/emqx_prometheus/src/emqx_prometheus_schema.erl @@ -78,7 +78,7 @@ fields(push_gateway) -> #{ default => false, required => true, - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, desc => ?DESC(push_gateway_enable) } )}, @@ -230,7 +230,7 @@ fields(legacy_deprecated_setting) -> #{ default => false, required => true, - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, desc => ?DESC(legacy_enable) } )}, diff --git a/apps/emqx_psk/src/emqx_psk_schema.erl b/apps/emqx_psk/src/emqx_psk_schema.erl index 286877d99..800845923 100644 --- a/apps/emqx_psk/src/emqx_psk_schema.erl +++ b/apps/emqx_psk/src/emqx_psk_schema.erl @@ -42,7 +42,7 @@ fields() -> [ {enable, ?HOCON(boolean(), #{ - importance => ?IMPORTANCE_NO_DOC, + %% importance => ?IMPORTANCE_NO_DOC, default => false, require => true, desc => ?DESC(enable) diff --git a/apps/emqx_slow_subs/src/emqx_slow_subs_schema.erl b/apps/emqx_slow_subs/src/emqx_slow_subs_schema.erl index febb0af0a..517457930 100644 --- a/apps/emqx_slow_subs/src/emqx_slow_subs_schema.erl +++ b/apps/emqx_slow_subs/src/emqx_slow_subs_schema.erl @@ -27,7 +27,8 @@ roots() -> fields("slow_subs") -> [ - {enable, sc(boolean(), false, enable, ?IMPORTANCE_NO_DOC)}, + %% {enable, sc(boolean(), false, enable, ?IMPORTANCE_NO_DOC)}, + {enable, sc(boolean(), false, enable)}, {threshold, sc( %% not used in a `receive ... after' block, just timestamp comparison @@ -67,5 +68,5 @@ desc(_) -> sc(Type, Default, Desc) -> ?HOCON(Type, #{default => Default, desc => ?DESC(Desc)}). -sc(Type, Default, Desc, Importance) -> - ?HOCON(Type, #{default => Default, desc => ?DESC(Desc), importance => Importance}). +%% sc(Type, Default, Desc, Importance) -> +%% ?HOCON(Type, #{default => Default, desc => ?DESC(Desc), importance => Importance}). diff --git a/rel/config/examples/gateway.exproto.conf.example b/rel/config/examples/gateway.exproto.conf.example index 303bd2872..fcedb944b 100644 --- a/rel/config/examples/gateway.exproto.conf.example +++ b/rel/config/examples/gateway.exproto.conf.example @@ -16,6 +16,7 @@ gateway.exproto { ## Configurations for request to ConnectionHandler service handler { address = "http://127.0.0.1:9001" + ssl_options {enable = false} } listeners.tcp.default { diff --git a/rel/config/examples/plugins.conf.example b/rel/config/examples/plugins.conf.example index 9388f4f24..b7673036e 100644 --- a/rel/config/examples/plugins.conf.example +++ b/rel/config/examples/plugins.conf.example @@ -10,7 +10,7 @@ plugins { ## Note: name and version should be what it is in the plugin application name_vsn = "my_acl-0.1.0", }, - {name_vsn = "my_rule-0.1.1"} + {name_vsn = "my_rule-0.1.1", enable = false} ] ## The installation directory for the external plugins