Merge pull request #7038 from zmstone/chore-rename-emqx-no-space-source-code
chore: EMQ X -> EMQX in source code
This commit is contained in:
commit
2a6d11c7f1
|
@ -14,8 +14,8 @@
|
|||
%% limitations under the License.
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
-ifndef(EMQ_X_HRL).
|
||||
-define(EMQ_X_HRL, true).
|
||||
-ifndef(EMQX_HRL).
|
||||
-define(EMQX_HRL, true).
|
||||
|
||||
%% Shard
|
||||
%%--------------------------------------------------------------------
|
||||
|
|
|
@ -14,8 +14,8 @@
|
|||
%% limitations under the License.
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
-ifndef(EMQ_X_MQTT_HRL).
|
||||
-define(EMQ_X_MQTT_HRL, true).
|
||||
-ifndef(EMQX_MQTT_HRL).
|
||||
-define(EMQX_MQTT_HRL, true).
|
||||
|
||||
-define(UINT_MAX, 16#FFFFFFFF).
|
||||
|
||||
|
|
|
@ -14,8 +14,8 @@
|
|||
%% limitations under the License.
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
-ifndef(EMQ_X_PLACEHOLDER_HRL).
|
||||
-define(EMQ_X_PLACEHOLDER_HRL, true).
|
||||
-ifndef(EMQX_PLACEHOLDER_HRL).
|
||||
-define(EMQX_PLACEHOLDER_HRL, true).
|
||||
|
||||
-define(PH(Type), <<"${", Type/binary, "}">> ).
|
||||
|
||||
|
|
|
@ -25,15 +25,15 @@
|
|||
|
||||
-include("emqx_release.hrl").
|
||||
|
||||
%% @doc Return EMQ X description.
|
||||
%% @doc Return EMQX description.
|
||||
description() ->
|
||||
case os:getenv("EMQX_DESCRIPTION") of
|
||||
false -> "EMQ X Community Edition";
|
||||
"" -> "EMQ X Community Edition";
|
||||
false -> "EMQX Community Edition";
|
||||
"" -> "EMQX Community Edition";
|
||||
Str -> string:strip(Str, both, $\n)
|
||||
end.
|
||||
|
||||
%% @doc Return EMQ X edition info.
|
||||
%% @doc Return EMQX edition info.
|
||||
%% Read info from persistent_term at runtime.
|
||||
%% Or meck this function to run tests for another eidtion.
|
||||
-spec edition() -> ce | ee | edge.
|
||||
|
@ -41,7 +41,7 @@ edition() ->
|
|||
try persistent_term:get(emqx_edition)
|
||||
catch error : badarg -> get_edition() end.
|
||||
|
||||
%% @private initiate EMQ X edition info in persistent_term.
|
||||
%% @private initiate EMQX edition info in persistent_term.
|
||||
put_edition() ->
|
||||
ok = put_edition(get_edition()).
|
||||
|
||||
|
|
|
@ -119,7 +119,7 @@ For per-listener overrides see <code>authentication</code>
|
|||
in listener configs
|
||||
<br>
|
||||
<br>
|
||||
EMQ X can be configured with:
|
||||
EMQX can be configured with:
|
||||
<br>
|
||||
<ul>
|
||||
<li><code>[]</code>: The default value, it allows *ALL* logins</li>
|
||||
|
@ -134,7 +134,7 @@ per the configured order, until an 'allow' or 'deny' decision can be made.
|
|||
If there is no decision after a full chain exhaustion, the login is rejected.
|
||||
""")}
|
||||
%% NOTE: authorization schema here is only to keep emqx app prue
|
||||
%% the full schema for EMQ X node is injected in emqx_conf_schema.
|
||||
%% the full schema for EMQX node is injected in emqx_conf_schema.
|
||||
, {"authorization",
|
||||
sc(ref("authorization"),
|
||||
#{})}
|
||||
|
@ -1200,7 +1200,7 @@ common_ssl_opts_schema(Defaults) ->
|
|||
"""Trusted PEM format CA certificates bundle file.<br>
|
||||
The certificates in this file are used to verify the TLS peer's certificates.
|
||||
Append new certificates to the file if new CAs are to be trusted.
|
||||
There is no need to restart EMQ X to have the updated file loaded, because
|
||||
There is no need to restart EMQX to have the updated file loaded, because
|
||||
the system regularly checks if file has been updated (and reload).<br>
|
||||
NOTE: invalidating (deleting) a certificate from the file will not affect
|
||||
already established connections.
|
||||
|
@ -1400,7 +1400,7 @@ Selecting a good cipher suite is critical for the
|
|||
application's data security, confidentiality and performance.
|
||||
|
||||
The names should be in OpenSSL string format (not RFC format).
|
||||
All default values and examples provided by EMQ X config
|
||||
All default values and examples provided by EMQX config
|
||||
documentation are all in OpenSSL format.<br>
|
||||
|
||||
NOTE: Certain cipher suites are only compatible with
|
||||
|
|
|
@ -14,7 +14,7 @@
|
|||
%% limitations under the License.
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
%% The proper types extension for EMQ X
|
||||
%% The proper types extension for EMQX
|
||||
|
||||
-module(emqx_proper_types).
|
||||
|
||||
|
|
|
@ -48,7 +48,7 @@ config_refs(Modules) ->
|
|||
|
||||
%% authn is a core functionality however implemented outside of emqx app
|
||||
%% in emqx_schema, 'authentication' is a map() type which is to allow
|
||||
%% EMQ X more pluggable.
|
||||
%% EMQX more pluggable.
|
||||
root_type() ->
|
||||
hoconsc:array(authenticator_type()).
|
||||
|
||||
|
|
|
@ -96,11 +96,11 @@ fields(file) ->
|
|||
, {path, #{type => string(),
|
||||
desc => """
|
||||
Path to the file which contains the ACL rules.<br>
|
||||
If the file provisioned before starting EMQ X node,
|
||||
it can be placed anywhere as long as EMQ X has read access to it.
|
||||
If the file provisioned before starting EMQX node,
|
||||
it can be placed anywhere as long as EMQX has read access to it.
|
||||
|
||||
In case the rule-set is created from EMQ X dashboard or management API,
|
||||
the file will be placed in `authz` sub directory inside EMQ X's `data_dir`,
|
||||
In case the rule-set is created from EMQX dashboard or management API,
|
||||
the file will be placed in `authz` sub directory inside EMQX's `data_dir`,
|
||||
and the new rules will override all rules from the old config file.
|
||||
"""
|
||||
}}
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
|
||||
-ifndef(EMQ_X_CONF_HRL).
|
||||
-define(EMQ_X_CONF_HRL, true).
|
||||
-ifndef(EMQX_CONF_HRL).
|
||||
-define(EMQX_CONF_HRL, true).
|
||||
|
||||
-define(CLUSTER_RPC_SHARD, emqx_cluster_rpc_shard).
|
||||
|
||||
|
|
|
@ -140,7 +140,7 @@ dump_schema(Dir) ->
|
|||
-spec gen_doc(file:name_all()) -> ok.
|
||||
gen_doc(File) ->
|
||||
Version = emqx_release:version(),
|
||||
Title = "# EMQ X " ++ Version ++ " Configuration",
|
||||
Title = "# EMQX " ++ Version ++ " Configuration",
|
||||
BodyFile = filename:join([code:lib_dir(emqx_conf), "etc", "emqx_conf.md"]),
|
||||
{ok, Body} = file:read_file(BodyFile),
|
||||
Doc = hocon_schema_md:gen(emqx_conf_schema, #{title => Title, body => Body}),
|
||||
|
|
|
@ -41,7 +41,7 @@
|
|||
|
||||
%% Static apps which merge their configs into the merged emqx.conf
|
||||
%% The list can not be made a dynamic read at run-time as it is used
|
||||
%% by nodetool to generate app.<time>.config before EMQ X is started
|
||||
%% by nodetool to generate app.<time>.config before EMQX is started
|
||||
-define(MERGED_CONFIGS,
|
||||
[ emqx_bridge_schema
|
||||
, emqx_retainer_schema
|
||||
|
@ -78,7 +78,7 @@ roots() ->
|
|||
})}
|
||||
, {"cluster",
|
||||
sc(hoconsc:ref("cluster"),
|
||||
#{ desc => "EMQ X nodes can form a cluster to scale up the total capacity.<br>"
|
||||
#{ desc => "EMQX nodes can form a cluster to scale up the total capacity.<br>"
|
||||
"Here holds the configs to instruct how individual nodes "
|
||||
"can discover each other."
|
||||
})}
|
||||
|
@ -89,7 +89,7 @@ roots() ->
|
|||
})}
|
||||
, {"rpc",
|
||||
sc(hoconsc:ref("rpc"),
|
||||
#{ desc => "EMQ X uses a library called <code>gen_rpc</code> for "
|
||||
#{ desc => "EMQX uses a library called <code>gen_rpc</code> for "
|
||||
"inter-broker communication.<br/>Most of the time the default config "
|
||||
"should work, but in case you need to do performance "
|
||||
"fine-turning or experiment a bit, this is where to look."
|
||||
|
@ -916,13 +916,13 @@ emqx_schema_high_prio_roots() ->
|
|||
sc(hoconsc:ref("authorization"),
|
||||
#{ desc => """
|
||||
Authorization a.k.a ACL.<br>
|
||||
In EMQ X, MQTT client access control is extremely flexible.<br>
|
||||
In EMQX, MQTT client access control is extremely flexible.<br>
|
||||
An out of the box set of authorization data sources are supported.
|
||||
For example,<br>
|
||||
'file' source is to support concise and yet generic ACL rules in a file;<br>
|
||||
'built-in-database' source can be used to store per-client customizable rule sets,
|
||||
natively in the EMQ X node;<br>
|
||||
'http' source to make EMQ X call an external HTTP API to make the decision;<br>
|
||||
natively in the EMQX node;<br>
|
||||
'http' source to make EMQX call an external HTTP API to make the decision;<br>
|
||||
'PostgreSQL' etc. to look up clients or rules from external databases;<br>
|
||||
""" })},
|
||||
lists:keyreplace("authorization", 1, Roots, Authz).
|
||||
|
|
|
@ -40,7 +40,7 @@ start_listeners() ->
|
|||
Authorization = {?MODULE, authorize},
|
||||
GlobalSpec = #{
|
||||
openapi => "3.0.0",
|
||||
info => #{title => "EMQ X API", version => "5.0.0"},
|
||||
info => #{title => "EMQX API", version => "5.0.0"},
|
||||
servers => [#{url => ?BASE_PATH}],
|
||||
components => #{
|
||||
schemas => #{},
|
||||
|
|
|
@ -101,7 +101,7 @@ do_sign(Username, Password) ->
|
|||
<<"alg">> => <<"HS256">>
|
||||
},
|
||||
JWT = #{
|
||||
<<"iss">> => <<"EMQ X">>,
|
||||
<<"iss">> => <<"EMQX">>,
|
||||
<<"exp">> => ExpTime
|
||||
},
|
||||
Signed = jose_jwt:sign(JWK, JWS, JWT),
|
||||
|
|
|
@ -739,7 +739,7 @@ common_client_props() ->
|
|||
"packet">>})}
|
||||
, {recv_oct,
|
||||
mk(integer(),
|
||||
#{ desc => <<"Number of bytes received by EMQ X Broker">>})}
|
||||
#{ desc => <<"Number of bytes received by EMQX Broker">>})}
|
||||
, {recv_cnt,
|
||||
mk(integer(),
|
||||
#{ desc => <<"Number of socket packets received">>})}
|
||||
|
|
|
@ -207,7 +207,7 @@ The indicator can be set to:
|
|||
, desc =>
|
||||
"The Default QoS Level indicator for publish request.<br>
|
||||
This option specifies the QoS level for the CoAP Client when publishing a
|
||||
message to EMQ X PUB/SUB system, if the publish request is not carried `qos`
|
||||
message to EMQX PUB/SUB system, if the publish request is not carried `qos`
|
||||
option. The indicator can be set to:
|
||||
- qos0, qos1, qos2: Fixed default QoS level
|
||||
- coap: Dynamic QoS level by the message type of publish request
|
||||
|
@ -255,7 +255,7 @@ beyond this time window are temporarily stored in memory."
|
|||
sc(hoconsc:union([always, contains_object_list]),
|
||||
#{ default => "contains_object_list"
|
||||
, desc =>
|
||||
"Policy for publishing UPDATE event message to EMQ X.<br>
|
||||
"Policy for publishing UPDATE event message to EMQX.<br>
|
||||
- always: send update events as long as the UPDATE request is received.
|
||||
- contains_object_list: send update events only if the UPDATE request carries any Object List."
|
||||
})}
|
||||
|
|
|
@ -26,7 +26,7 @@
|
|||
|
||||
-include_lib("emqx/include/logger.hrl").
|
||||
|
||||
%% @doc EMQ X boot entrypoint.
|
||||
%% @doc EMQX boot entrypoint.
|
||||
start() ->
|
||||
case os:type() of
|
||||
{win32, nt} -> ok;
|
||||
|
|
|
@ -38,7 +38,7 @@ schema("/alarms") ->
|
|||
#{
|
||||
'operationId' => alarms,
|
||||
get => #{
|
||||
description => <<"EMQ X alarms">>,
|
||||
description => <<"EMQX alarms">>,
|
||||
parameters => [
|
||||
hoconsc:ref(emqx_dashboard_swagger, page),
|
||||
hoconsc:ref(emqx_dashboard_swagger, limit),
|
||||
|
|
|
@ -324,7 +324,7 @@ fields(client) ->
|
|||
{'recv_msg.qos2', hoconsc:mk(integer(), #{desc =>
|
||||
<<"Number of PUBLISH QoS2 packets received">>})},
|
||||
{recv_oct, hoconsc:mk(integer(), #{desc =>
|
||||
<<"Number of bytes received by EMQ X Broker (the same below)">>})},
|
||||
<<"Number of bytes received by EMQX Broker (the same below)">>})},
|
||||
{recv_pkt, hoconsc:mk(integer(), #{desc => <<"Number of MQTT packets received">>})},
|
||||
{reductions, hoconsc:mk(integer(), #{desc => <<"Erlang reduction">>})},
|
||||
{send_cnt, hoconsc:mk(integer(), #{desc => <<"Number of TCP packets sent">>})},
|
||||
|
|
|
@ -48,8 +48,8 @@ properties() ->
|
|||
[
|
||||
{'actions.failure', integer, <<"Number of failure executions of the rule engine action">>},
|
||||
{'actions.success', integer, <<"Number of successful executions of the rule engine action">>},
|
||||
{'bytes.received', integer, <<"Number of bytes received by EMQ X Broker">>},
|
||||
{'bytes.sent', integer, <<"Number of bytes sent by EMQ X Broker on this connection">>},
|
||||
{'bytes.received', integer, <<"Number of bytes received by EMQX Broker">>},
|
||||
{'bytes.sent', integer, <<"Number of bytes sent by EMQX Broker on this connection">>},
|
||||
{'client.auth.anonymous', integer, <<"Number of clients who log in anonymously">>},
|
||||
{'client.authenticate', integer, <<"Number of client authentications">>},
|
||||
{'client.check_authz', integer, <<"Number of Authorization rule checks">>},
|
||||
|
@ -66,9 +66,9 @@ properties() ->
|
|||
{'delivery.dropped.queue_full', integer, <<"Number of messages with a non-zero QoS that were dropped because the message queue was full when sending">>},
|
||||
{'delivery.dropped.too_large', integer, <<"The number of messages that were dropped because the length exceeded the limit when sending">>},
|
||||
{'messages.acked', integer, <<"Number of received PUBACK and PUBREC packet">>},
|
||||
{'messages.delayed', integer, <<"Number of delay- published messages stored by EMQ X Broker">>},
|
||||
{'messages.delivered', integer, <<"Number of messages forwarded to the subscription process internally by EMQ X Broker">>},
|
||||
{'messages.dropped', integer, <<"Total number of messages dropped by EMQ X Broker before forwarding to the subscription process">>},
|
||||
{'messages.delayed', integer, <<"Number of delay- published messages stored by EMQX Broker">>},
|
||||
{'messages.delivered', integer, <<"Number of messages forwarded to the subscription process internally by EMQX Broker">>},
|
||||
{'messages.dropped', integer, <<"Total number of messages dropped by EMQX Broker before forwarding to the subscription process">>},
|
||||
{'messages.dropped.await_pubrel_timeout', integer, <<"Number of messages dropped due to waiting PUBREL timeout">>},
|
||||
{'messages.dropped.no_subscribers', integer, <<"Number of messages dropped due to no subscribers">>},
|
||||
{'messages.forward', integer, <<"Number of messages forwarded to other nodes">>},
|
||||
|
@ -80,7 +80,7 @@ properties() ->
|
|||
{'messages.qos2.received', integer, <<"Number of QoS 2 messages received from clients">>},
|
||||
{'messages.qos2.sent', integer, <<"Number of QoS 2 messages sent to clients">>},
|
||||
{'messages.received', integer, <<"Number of messages received from the client, equal to the sum of messages.qos0.received\fmessages.qos1.received and messages.qos2.received">>},
|
||||
{'messages.retained', integer, <<"Number of retained messages stored by EMQ X Broker">>},
|
||||
{'messages.retained', integer, <<"Number of retained messages stored by EMQX Broker">>},
|
||||
{'messages.sent', integer, <<"Number of messages sent to the client, equal to the sum of messages.qos0.sent\fmessages.qos1.sent and messages.qos2.sent">>},
|
||||
{'packets.auth.received', integer, <<"Number of received AUTH packet">>},
|
||||
{'packets.auth.sent', integer, <<"Number of sent AUTH packet">>},
|
||||
|
@ -133,7 +133,7 @@ properties() ->
|
|||
metrics_api() ->
|
||||
Metadata = #{
|
||||
get => #{
|
||||
description => <<"EMQ X metrics">>,
|
||||
description => <<"EMQX metrics">>,
|
||||
parameters => [#{
|
||||
name => aggregate,
|
||||
in => query,
|
||||
|
|
|
@ -53,14 +53,14 @@ properties() ->
|
|||
{memory_total, string, <<"VM allocated system memory">>},
|
||||
{memory_used, string, <<"VM occupied system memory">>},
|
||||
{node_status, string, <<"Node status">>},
|
||||
{otp_release, string, <<"Erlang/OTP version used by EMQ X Broker">>},
|
||||
{otp_release, string, <<"Erlang/OTP version used by EMQX Broker">>},
|
||||
{process_available, integer, <<"Number of available processes">>},
|
||||
{process_used, integer, <<"Number of used processes">>},
|
||||
{uptime, integer, <<"EMQ X Broker runtime, millisecond">>},
|
||||
{version, string, <<"EMQ X Broker version">>},
|
||||
{sys_path, string, <<"EMQ X system file location">>},
|
||||
{log_path, string, <<"EMQ X log file location">>},
|
||||
{config_path, string, <<"EMQ X config file location">>},
|
||||
{uptime, integer, <<"EMQX Broker runtime, millisecond">>},
|
||||
{version, string, <<"EMQX Broker version">>},
|
||||
{sys_path, string, <<"EMQX system file location">>},
|
||||
{log_path, string, <<"EMQX log file location">>},
|
||||
{config_path, string, <<"EMQX config file location">>},
|
||||
{role, string, <<"Node role">>}
|
||||
]).
|
||||
|
||||
|
@ -76,9 +76,9 @@ parameters() ->
|
|||
nodes_api() ->
|
||||
Metadata = #{
|
||||
get => #{
|
||||
description => <<"List EMQ X nodes">>,
|
||||
description => <<"List EMQX nodes">>,
|
||||
responses => #{
|
||||
<<"200">> => object_array_schema(properties(), <<"List EMQ X Nodes">>)
|
||||
<<"200">> => object_array_schema(properties(), <<"List EMQX Nodes">>)
|
||||
}
|
||||
}
|
||||
},
|
||||
|
@ -91,7 +91,7 @@ node_api() ->
|
|||
parameters => parameters(),
|
||||
responses => #{
|
||||
<<"400">> => error_schema(<<"Node error">>, ['SOURCE_ERROR']),
|
||||
<<"200">> => object_schema(properties(), <<"Get EMQ X Nodes info by name">>)}}},
|
||||
<<"200">> => object_schema(properties(), <<"Get EMQX Nodes info by name">>)}}},
|
||||
{"/nodes/:node_name", Metadata, node}.
|
||||
|
||||
node_metrics_api() ->
|
||||
|
@ -102,7 +102,7 @@ node_metrics_api() ->
|
|||
responses => #{
|
||||
<<"400">> => error_schema(<<"Node error">>, ['SOURCE_ERROR']),
|
||||
%% TODO: Node Metrics Schema
|
||||
<<"200">> => schema(metrics, <<"Get EMQ X Node Metrics">>)}}},
|
||||
<<"200">> => schema(metrics, <<"Get EMQX Node Metrics">>)}}},
|
||||
{"/nodes/:node_name/metrics", Metadata, node_metrics}.
|
||||
|
||||
node_stats_api() ->
|
||||
|
@ -113,7 +113,7 @@ node_stats_api() ->
|
|||
responses => #{
|
||||
<<"400">> => error_schema(<<"Node error">>, ['SOURCE_ERROR']),
|
||||
%% TODO: Node Stats Schema
|
||||
<<"200">> => schema(stat, <<"Get EMQ X Node Stats">>)}}},
|
||||
<<"200">> => schema(stat, <<"Get EMQX Node Stats">>)}}},
|
||||
{"/nodes/:node_name/stats", Metadata, node_stats}.
|
||||
|
||||
%%%==============================================================================================
|
||||
|
|
|
@ -52,7 +52,7 @@ properties() ->
|
|||
routes_api() ->
|
||||
Metadata = #{
|
||||
get => #{
|
||||
description => <<"EMQ X routes">>,
|
||||
description => <<"EMQX routes">>,
|
||||
parameters => [topic_param(query) , node_param()] ++ page_params(),
|
||||
responses => #{
|
||||
<<"200">> => object_array_schema(properties(), <<"List route info">>),
|
||||
|
@ -65,7 +65,7 @@ routes_api() ->
|
|||
route_api() ->
|
||||
Metadata = #{
|
||||
get => #{
|
||||
description => <<"EMQ X routes">>,
|
||||
description => <<"EMQX routes">>,
|
||||
parameters => [topic_param(path)],
|
||||
responses => #{
|
||||
<<"200">> =>
|
||||
|
|
|
@ -42,7 +42,7 @@ paths() ->
|
|||
schema("/stats") ->
|
||||
#{ 'operationId' => list
|
||||
, get =>
|
||||
#{ description => <<"EMQ X stats">>
|
||||
#{ description => <<"EMQX stats">>
|
||||
, tags => [<<"stats">>]
|
||||
, parameters => [ref(aggregate)]
|
||||
, responses =>
|
||||
|
|
|
@ -85,13 +85,13 @@ fields(status) ->
|
|||
fields(telemetry) ->
|
||||
[ { emqx_version
|
||||
, mk( string()
|
||||
, #{ desc => <<"EMQ X Version">>
|
||||
, #{ desc => <<"EMQX Version">>
|
||||
, example => <<"5.0.0-beta.3-32d1547c">>
|
||||
})
|
||||
}
|
||||
, { license
|
||||
, mk( map()
|
||||
, #{ desc => <<"EMQ X License">>
|
||||
, #{ desc => <<"EMQX License">>
|
||||
, example => #{edition => <<"community">>}
|
||||
})
|
||||
}
|
||||
|
@ -115,50 +115,50 @@ fields(telemetry) ->
|
|||
}
|
||||
, { up_time
|
||||
, mk( integer()
|
||||
, #{ desc => <<"EMQ X Runtime">>
|
||||
, #{ desc => <<"EMQX Runtime">>
|
||||
, example => 20220113
|
||||
})
|
||||
}
|
||||
, { uuid
|
||||
, mk( string()
|
||||
, #{ desc => <<"EMQ X UUID">>
|
||||
, #{ desc => <<"EMQX UUID">>
|
||||
, example => <<"AAAAAAAA-BBBB-CCCC-2022-DDDDEEEEFFF">>
|
||||
})
|
||||
}
|
||||
, { nodes_uuid
|
||||
, mk( array(binary())
|
||||
, #{ desc => <<"EMQ X Cluster Nodes UUID">>
|
||||
, #{ desc => <<"EMQX Cluster Nodes UUID">>
|
||||
, example => [ <<"AAAAAAAA-BBBB-CCCC-2022-DDDDEEEEFFF">>
|
||||
, <<"ZZZZZZZZ-CCCC-BBBB-2022-DDDDEEEEFFF">>]
|
||||
})
|
||||
}
|
||||
, { active_plugins
|
||||
, mk( array(binary())
|
||||
, #{ desc => <<"EMQ X Active Plugins">>
|
||||
, #{ desc => <<"EMQX Active Plugins">>
|
||||
, example => [<<"Plugin A">>, <<"Plugin B">>]
|
||||
})
|
||||
}
|
||||
, { active_modules
|
||||
, mk( array(binary())
|
||||
, #{ desc => <<"EMQ X Active Modules">>
|
||||
, #{ desc => <<"EMQX Active Modules">>
|
||||
, example => [<<"Module A">>, <<"Module B">>]
|
||||
})
|
||||
}
|
||||
, { num_clients
|
||||
, mk( integer()
|
||||
, #{ desc => <<"EMQ X Current Connections">>
|
||||
, #{ desc => <<"EMQX Current Connections">>
|
||||
, example => 20220113
|
||||
})
|
||||
}
|
||||
, { messages_received
|
||||
, mk( integer()
|
||||
, #{ desc => <<"EMQ X Current Received Message">>
|
||||
, #{ desc => <<"EMQX Current Received Message">>
|
||||
, example => 2022
|
||||
})
|
||||
}
|
||||
, { messages_sent
|
||||
, mk( integer()
|
||||
, #{ desc => <<"EMQ X Current Sent Message">>
|
||||
, #{ desc => <<"EMQX Current Sent Message">>
|
||||
, example => 2022
|
||||
})
|
||||
}
|
||||
|
|
|
@ -45,7 +45,7 @@
|
|||
%%
|
||||
%% For SSL files in the input Option, it can either be a file path
|
||||
%% or a map like `#{filename := FileName, file := Content}`.
|
||||
%% In case it's a map, the file is saved in EMQ X's `data_dir'
|
||||
%% In case it's a map, the file is saved in EMQX's `data_dir'
|
||||
%% (unless `SubDir' is an absolute path).
|
||||
%% NOTE: This function is now deprecated, use emqx_tls_lib:ensure_ssl_files/2 instead.
|
||||
-spec save_files_return_opts(opts_input(), atom() | string() | binary(),
|
||||
|
@ -60,7 +60,7 @@ save_files_return_opts(Options, SubDir, ResId) ->
|
|||
%%
|
||||
%% For SSL files in the input Option, it can either be a file path
|
||||
%% or a map like `#{filename := FileName, file := Content}`.
|
||||
%% In case it's a map, the file is saved in EMQ X's `data_dir'
|
||||
%% In case it's a map, the file is saved in EMQX's `data_dir'
|
||||
%% (unless `SubDir' is an absolute path).
|
||||
%% NOTE: This function is now deprecated, use emqx_tls_lib:ensure_ssl_files/2 instead.
|
||||
-spec save_files_return_opts(opts_input(), file:name_all()) -> opts().
|
||||
|
|
|
@ -33,9 +33,9 @@ roots() -> [?CONF_ROOT].
|
|||
fields(?CONF_ROOT) ->
|
||||
#{fields => root_fields(),
|
||||
desc => """
|
||||
Manage EMQ X plugins.
|
||||
Manage EMQX plugins.
|
||||
<br>
|
||||
Plugins can be pre-built as a part of EMQ X package,
|
||||
Plugins can be pre-built as a part of EMQX package,
|
||||
or installed as a standalone package in a location specified by
|
||||
<code>install_dir</code> config key
|
||||
<br>
|
||||
|
@ -85,5 +85,5 @@ The plugin beam files and configuration files should reside in
|
|||
the sub-directory named as <code>emqx_foo_bar-0.1.0</code>.
|
||||
<br>
|
||||
NOTE: For security reasons, this directory should **NOT** be writable
|
||||
by anyone expect for <code>emqx</code> (or any user which runs EMQ X)
|
||||
by anyone expect for <code>emqx</code> (or any user which runs EMQX)
|
||||
""".
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
%%--------------------------------------------------------------------
|
||||
%% Copyright (c) 2022 EMQ Technologies Co., Ltd. All Rights Reserved.
|
||||
%%
|
||||
%% @doc EMQ X License Management Application.
|
||||
%% @doc EMQX License Management Application.
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
-module(emqx_license_app).
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
%%--------------------------------------------------------------------
|
||||
%% Copyright (c) 2022 EMQ Technologies Co., Ltd. All Rights Reserved.
|
||||
%%
|
||||
%% @doc EMQ X License Management.
|
||||
%% @doc EMQX License Management.
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
-module(emqx_license_parser).
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
%%--------------------------------------------------------------------
|
||||
%% Copyright (c) 2022 EMQ Technologies Co., Ltd. All Rights Reserved.
|
||||
%%
|
||||
%% @doc EMQ X License Management Supervisor.
|
||||
%% @doc EMQX License Management Supervisor.
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
-module(emqx_license_sup).
|
||||
|
|
Loading…
Reference in New Issue