move to emqttd-relx/priv

priv/emqttd.schema

@@ -1,556 +0,0 @@
-%%-*- mode: erlang -*-
-%% EMQ 3.0 config mapping
-
-%%--------------------------------------------------------------------
-%% Erlang Node
-%%--------------------------------------------------------------------
-
-%% @doc Node Id 
-{mapping, "node.id", "emqttd.node_id", [
-  {default, 1},
-  {datatype, integer},
-  {validators, ["range:0-255"]}
-]}.
-
-%% @doc Erlang node name
-{mapping, "node.name", "vm_args.-name", [
-  {default, "emqttd@127.0.0.1"}
-]}.
-
-%% @doc Secret cookie for distributed erlang node
-{mapping, "node.cookie", "vm_args.-setcookie", [
-  {default, "emqsecretcookie"}
-]}.
-
-%% @doc SMP Support
-{mapping, "node.smp", "vm_args.-smp", [
-  {default, auto},
-  {datatype, {enum, [enable, auto, disable]}},
-  hidden
-]}.
-
-%% @doc Enable Kernel Poll
-{mapping, "node.kernel_poll", "vm_args.+K", [
-  {default, on},
-  {datatype, flag},
-  hidden
-]}.
-
-%% @doc More information at: http://erlang.org/doc/man/erl.html
-{mapping, "node.async_threads", "vm_args.+A", [
-  {default, 64},
-  {datatype, integer},
-  {validators, ["range:0-1024"]}
-]}.
-
-%% @doc Erlang Process Limit
-{mapping, "node.process_limit", "vm_args.+P", [
-  {datatype, integer},
-  {default, 256000},
-  hidden
-]}.
-
-%% Note: OTP R15 and earlier uses -env ERL_MAX_PORTS, R16+ uses +Q
-%% @doc The number of concurrent ports/sockets
-%% Valid range is 1024-134217727
-{mapping, "node.max_ports",
-  cuttlefish:otp("R16", "vm_args.+Q", "vm_args.-env ERL_MAX_PORTS"), [
-  {default, 262144},
-  {datatype, integer},
-  {validators, ["range4ports"]}
-]}.
-
-{validator, "range4ports", "must be 1024 to 134217727",
- fun(X) -> X >= 1024 andalso X =< 134217727 end}.
-
-%% @doc http://www.erlang.org/doc/man/erl.html#%2bzdbbl
-{mapping, "node.dist_buffer_size", "vm_args.+zdbbl", [
-  {datatype, bytesize},
-  {commented, "32MB"},
-  hidden,
-  {validators, ["zdbbl_range"]}
-]}.
-
-{translation, "vm_args.+zdbbl",
- fun(Conf) ->
-  ZDBBL = cuttlefish:conf_get("vm.dist_buffer_size", Conf, undefined),
-  case ZDBBL of
-    undefined -> undefined;
-    X when is_integer(X) -> cuttlefish_util:ceiling(X / 1024); %% Bytes to Kilobytes;
-    _ -> undefined
-  end
- end
-}.
-
-{validator, "zdbbl_range", "must be between 1KB and 2097151KB",
- fun(ZDBBL) ->
-  %% 2097151KB = 2147482624
-  ZDBBL >= 1024 andalso ZDBBL =< 2147482624
- end
-}.
-
-%% @doc http://www.erlang.org/doc/man/erlang.html#system_flag-2
-{mapping, "node.fullsweep_after", "vm_args.-env ERL_FULLSWEEP_AFTER", [
-  {default, 1000},
-  {datatype, integer},
-  hidden,
-  {validators, ["positive_integer"]}
-]}.
-
-{validator, "positive_integer", "must be a positive integer",
-  fun(X) -> X >= 0 end}.
-
-%% Note: OTP R15 and earlier uses -env ERL_MAX_ETS_TABLES,
-%% R16+ uses +e
-%% @doc The ETS table limit
-{mapping, "node.max_ets_tables",
-  cuttlefish:otp("R16", "vm_args.+e", "vm_args.-env ERL_MAX_ETS_TABLES"), [
-  {default, 256000},
-  {datatype, integer},
-  hidden
-]}.
-
-%% @doc Set the location of crash dumps
-{mapping, "node.crash_dump", "vm_args.-env ERL_CRASH_DUMP", [
-  {default, "{{crash_dump}}"},
-  {datatype, file},
-  hidden
-]}.
-
-%%--------------------------------------------------------------------
-%% Log
-%%--------------------------------------------------------------------
-
-{mapping, "log.console", "lager.handlers", [
-  {default, file },
-  {datatype, {enum, [off, file, console, both]}}
-]}.
-
-{mapping, "log.console.level", "lager.handlers", [
-  {default, info},
-  {datatype, {enum, [debug, info, notice, warning, error, critical, alert, emergency, none]}}
-]}.
-
-{mapping, "log.console.file", "lager.handlers", [
-  {default, "$(platform_log_dir)/console.log"},
-  {datatype, file}
-]}.
-
-{mapping, "log.error.file", "lager.handlers", [
-  {default, "$(platform_log_dir)/error.log"},
-  {datatype, file}
-]}.
-
-{mapping, "log.error.redirect", "lager.error_logger_redirect", [
-  {default, on},
-  {datatype, flag},
-  hidden
-]}.
-
-{mapping, "log.error.messages_per_second", "lager.error_logger_hwm", [
-  {default, 1000},
-  {datatype, integer},
-  hidden
-]}.
-
-{translation,
- "lager.handlers",
- fun(Conf) ->
-    ErrorHandler = case cuttlefish:conf_get("log.error.file", Conf) of
-      undefined -> [];
-      ErrorFilename -> [{lager_file_backend, [{file, ErrorFilename},
-                                              {level, error},
-                                              {size, 10485760},
-                                              {date, "$D0"},
-                                              {count, 5}]}]
-    end,
-
-    ConsoleLogLevel = cuttlefish:conf_get("log.console.level", Conf),
-    ConsoleLogFile = cuttlefish:conf_get("log.console.file", Conf),
-
-    ConsoleHandler = {lager_console_backend, ConsoleLogLevel},
-    ConsoleFileHandler = {lager_file_backend, [{file, ConsoleLogFile},
-                                               {level, ConsoleLogLevel},
-                                               {size, 10485760},
-                                               {date, "$D0"},
-                                               {count, 5}]},
-
-    ConsoleHandlers = case cuttlefish:conf_get("log.console", Conf) of
-      off -> [];
-      file -> [ConsoleFileHandler];
-      console -> [ConsoleHandler];
-      both -> [ConsoleHandler, ConsoleFileHandler];
-      _ -> []
-    end,
-    ConsoleHandlers ++ ErrorHandler
-  end
-}.
-
-{mapping, "log.crash", "lager.crash_log", [
-  {default, on},
-  {datatype, flag}
-]}.
-
-{mapping, "log.crash.file", "lager.crash_log", [
-  {default, "$(platform_log_dir)/crash.log"},
-  {datatype, file}
-]}.
-
-{translation,
- "lager.crash_log",
- fun(Conf) ->
-     case cuttlefish:conf_get("log.crash", Conf) of
-         false -> undefined;
-         _ ->
-             cuttlefish:conf_get("log.crash.file", Conf, "./log/crash.log")
-     end
- end}.
-
-{mapping, "sasl", "sasl.sasl_error_logger", [
-  {default, off},
-  {datatype, flag},
-  hidden
-]}.
-
-%%--------------------------------------------------------------------
-%% MQTT Protocol
-%%--------------------------------------------------------------------
-
-%% @doc Set the Max ClientId Length Allowed.
-{mapping, "mqtt.max_clientid_len", "emqttd.protocol", [
-  {default, 1024},
-  {datatype, integer}
-]}.
-
-%% @doc Max Packet Size Allowed, 64K by default.
-{mapping, "mqtt.max_packet_size", "emqttd.protocol", [
-  {default, "64KB"},
-  {datatype, bytesize}
-]}.
-
-%% @doc Client Idle Timeout.
-{mapping, "mqtt.client_idle_timeout", "emqttd.protocol", [
-  {default, 30},
-  {datatype, integer}
-]}.
-
-{translation, "emqttd.protocol", fun(Conf) ->
-  [{max_clientid_len,    cuttlefish:conf_get("mqtt.max_clientid_len", Conf)},
-   {max_packet_size,     cuttlefish:conf_get("mqtt.max_packet_size", Conf)},
-   {client_idle_timeout, cuttlefish:conf_get("mqtt.client_idle_timeout", Conf)}]
-end}.
-
-%%--------------------------------------------------------------------
-%% MQTT Session
-%%--------------------------------------------------------------------
-
-%% @doc Max number of QoS 1 and 2 messages that can be “inflight” at one time.
-%% 0 means no limit
-{mapping, "mqtt.session.max_inflight", "emqttd.session", [
-  {default, 100},
-  {datatype, integer}
-]}.
-
-
-%% @doc Retry interval for redelivering QoS1/2 messages.
-{mapping, "mqtt.session.retry_interval", "emqttd.session", [
-  {default, 60},
-  {datatype, integer}
-]}.
-
-%% @doc Awaiting PUBREL Timeout
-{mapping, "mqtt.session.await_rel_timeout", "emqttd.session", [
-  {default, 30},
-  {datatype, integer}
-]}.
-
-%% @doc Max Packets that Awaiting PUBREL, 0 means no limit
-{mapping, "mqtt.session.max_awaiting_rel", "emqttd.session", [
-  {default, 0},
-  {datatype, integer}
-]}.
-
-%% @doc Statistics Collection Interval(seconds)
-{mapping, "mqtt.session.collect_interval", "emqttd.session", [
-  {default, 0},
-  {datatype, integer}
-]}.
-
-%% @doc Session expired after...
-{mapping, "mqtt.session.expired_after", "emqttd.session", [
-  {default, "2d"},
-  {datatype, {duration, s}}
-]}.
-
-{translation, "emqttd.session", fun(Conf) ->
-  [{max_inflight, cuttlefish:conf_get("mqtt.session.max_inflight", Conf)},
-   {retry_interval, cuttlefish:conf_get("mqtt.session.retry_interval", Conf)},
-   {await_rel_timeout, cuttlefish:conf_get("mqtt.session.await_rel_timeout", Conf)},
-   {max_awaiting_rel, cuttlefish:conf_get("mqtt.session.max_awaiting_rel", Conf)},
-   {collect_interval, cuttlefish:conf_get("mqtt.session.collect_interval", Conf)},
-   {expired_after, cuttlefish:conf_get("mqtt.session.expired_after", Conf)}]
-end}.
-
-%%--------------------------------------------------------------------
-%% MQTT Queue
-%%--------------------------------------------------------------------
-
-%% @doc Type: simple | priority
-{mapping, "mqtt.queue.type", "emqttd.queue", [
-  {default, simple},
-  {datatype, atom}
-]}.
-
-%% @doc Topic Priority: 0~255, Default is 0
-{mapping, "mqtt.queue.priority", "emqttd.queue", [
-  {default, ""},
-  {datatype, string},
-  hidden
-]}.
-
-%% @doc Max queue length. Enqueued messages when persistent client disconnected, or inflight window is full.
-{mapping, "mqtt.queue.max_length", "emqttd.queue", [
-  {default, infinity},
-  {datatype, [atom, integer]}
-]}.
-
-%% @doc Low-water mark of queued messages
-{mapping, "mqtt.queue.low_watermark", "emqttd.queue", [
-  {default, "20%"},
-  {datatype, string},
-  hidden
-]}.
-
-%% @doc High-water mark of queued messages
-{mapping, "mqtt.queue.high_watermark", "emqttd.queue", [
-  {default, "60%"},
-  {datatype, string},
-  hidden
-]}.
-
-%% @doc Queue Qos0 messages?
-{mapping, "mqtt.queue.qos0", "emqttd.queue", [
-  {default, true},
-  {datatype, {enum, [true, false]}}
-]}.
-
-{translation, "emqttd.queue", fun(Conf) ->
-  Parse = fun(S) ->
-			{match, [N]} = re:run(S, "^([0-9]+)%$", [{capture, all_but_first, list}]),
-			list_to_integer(N) / 100
-	      end,
-  Opts = [{type, cuttlefish:conf_get("mqtt.queue.type", Conf, simple)},
-          {max_length, cuttlefish:conf_get("mqtt.queue.max_length", Conf)},
-          {low_watermark, Parse(cuttlefish:conf_get("mqtt.queue.low_watermark", Conf))},
-          {high_watermark, Parse(cuttlefish:conf_get("mqtt.queue.high_watermark", Conf))},
-          {queue_qos0, cuttlefish:conf_get("mqtt.queue.qos0", Conf)}],
-  case cuttlefish:conf_get("mqtt.queue.priority", Conf) of
-    undefined -> Opts;
-    V -> [{priority,
-			 [begin [T, P] = string:tokens(S, "="),
-					{T, list_to_integer(P)}
-		      end || S <- string:tokens(V, ",")]}|Opts]
-  end
-end}.
-
-%%--------------------------------------------------------------------
-%% MQTT Broker
-%%--------------------------------------------------------------------
-
-{mapping, "mqtt.broker.sys_interval", "emqttd.broker_sys_interval", [
-  {default, 60},
-  {datatype, integer}
-]}.
-
-%%--------------------------------------------------------------------
-%% MQTT PubSub
-%%--------------------------------------------------------------------
-
-{mapping, "mqtt.pubsub.pool_size", "emqttd.pubsub", [
-  {default, 8},
-  {datatype, integer}
-]}.
-
-{mapping, "mqtt.pubsub.by_clientid", "emqttd.pubsub", [
-  {default, true},
-  {datatype, {enum, [true, false]}}
-]}.
-
-{mapping, "mqtt.pubsub.async", "emqttd.pubsub", [
-  {default, true},
-  {datatype, {enum, [true, false]}},
-  hidden
-]}.
-
-{translation, "emqttd.pubsub", fun(Conf) ->
-  [{pool_size, cuttlefish:conf_get("mqtt.pubsub.pool_size", Conf)},
-   {by_clientid, cuttlefish:conf_get("mqtt.pubsub.by_clientid", Conf)},
-   {async, cuttlefish:conf_get("mqtt.pubsub.async", Conf)}]
-end}.
-
-%%--------------------------------------------------------------------
-%% MQTT Listeners
-%%--------------------------------------------------------------------
-
-{mapping, "mqtt.listener.tcp", "emqttd.listeners", [
-  {default, 1883},
-  {datatype, [integer, ip]}
-]}.
-
-{mapping, "mqtt.listener.tcp.acceptors", "emqttd.listeners", [
-  {default, 8},
-  {datatype, integer}
-]}.
-
-{mapping, "mqtt.listener.tcp.max_clients", "emqttd.listeners", [
-  {default, 1024},
-  {datatype, integer}
-]}.
-
-{mapping, "mqtt.listener.ssl", "emqttd.listeners", [
-  {default, 8883},
-  {datatype, [integer, ip]}
-]}.
-
-{mapping, "mqtt.listener.ssl.acceptors", "emqttd.listeners", [
-  {default, 8},
-  {datatype, integer}
-]}.
-
-{mapping, "mqtt.listener.ssl.max_clients", "emqttd.listeners", [
-  {default, 512},
-  {datatype, integer}
-]}.
-
-{mapping, "mqtt.listener.http", "emqttd.listeners", [
-  {default, 8883},
-  {datatype, [integer, ip]}
-]}.
-
-{mapping, "mqtt.listener.http.acceptors", "emqttd.listeners", [
-  {default, 8},
-  {datatype, integer}
-]}.
-
-{mapping, "mqtt.listener.http.max_clients", "emqttd.listeners", [
-  {default, 64},
-  {datatype, integer}
-]}.
-
-{translation, "emqttd.listeners", fun(Conf) ->
-    TcpListeners = case cuttlefish:conf_get("mqtt.listener.tcp", Conf) of
-        undefined ->
-            [];
-        TcpPort ->
-            TcpOpts = [{acceptors, cuttlefish:conf_get("mqtt.listener.tcp.acceptors", Conf)},
-                       {max_clients, cuttlefish:conf_get("mqtt.listener.tcp.max_clients", Conf)}],
-            [{tcp, TcpPort, TcpOpts}]
-        end,
-    SslListeners = case cuttlefish:conf_get("mqtt.listener.ssl", Conf) of
-        undefined ->
-            [];
-        SslPort ->
-            SslOpts = [{acceptors, cuttlefish:conf_get("mqtt.listener.ssl.acceptors", Conf)},
-                       {max_clients, cuttlefish:conf_get("mqtt.listener.ssl.max_clients", Conf)}],
-            [{ssl, SslPort, SslOpts}]
-    end,
-    HttpListeners = case cuttlefish:conf_get("mqtt.listener.http", Conf) of
-        undefined ->
-            [];
-        HttPort ->
-            HttpOpts = [{acceptors, cuttlefish:conf_get("mqtt.listener.http.acceptors", Conf)},
-                        {max_clients, cuttlefish:conf_get("mqtt.listener.http.max_clients", Conf)}],
-            [{http, HttPort, HttpOpts}]
-    end,
-    TcpListeners ++ SslListeners ++ HttpListeners
-end}.
-
-%%--------------------------------------------------------------------
-%% MQTT Bridge
-%%--------------------------------------------------------------------
-
-{mapping, "mqtt.bridge.max_queue_len", "emqttd.bridge", [
-  {default, 10000},
-  {datatype, integer}
-]}.
-
-{mapping, "mqtt.bridge.ping_down_interval", "emqttd.bridge", [
-  {default, 1},
-  {datatype, integer}
-]}.
-
-{translation, "emqttd.bridge", fun(Conf) ->
-  [{max_queue_len, cuttlefish:conf_get("mqtt.bridge.max_queue_len", Conf)},
-   {ping_down_interval, cuttlefish:conf_get("mqtt.bridge.ping_down_interval", Conf)}]
-end}.
-
-%%-------------------------------------------------------------------
-%% MQTT Plugins
-%%-------------------------------------------------------------------
-
-{mapping, "mqtt.plugins.etc_dir", "emqttd.plugins_etc_dir", [
-  {datatype, string}
-]}.
-
-{mapping, "mqtt.plugins.loaded_file", "emqttd.plugins_loaded_file", [
-  {datatype, string}
-]}.
-
-%%--------------------------------------------------------------------
-%% System Monitor
-%%--------------------------------------------------------------------
-
-%% @doc Long GC, don't monitor in production mode for:
-%% https://github.com/erlang/otp/blob/feb45017da36be78d4c5784d758ede619fa7bfd3/erts/emulator/beam/erl_gc.c#L421
-{mapping, "sysmon.long_gc", "emqttd.sysmon", [
-  {default, false},
-  {datatype, {enum, [true, false]}}
-]}.
-
-%% @doc Long Schedule(ms)
-{mapping, "sysmon.long_schedule", "emqttd.sysmon", [
-  {default, 1000},
-  {datatype, integer}
-]}.
-
-%% @doc Large Heap
-{mapping, "sysmon.large_heap", "emqttd.sysmon", [
-  {default, "8MB"},
-  {datatype, bytesize}
-]}.
-
-%% @doc Monitor Busy Port
-{mapping, "sysmon.busy_port", "emqttd.sysmon", [
-  {default, false},
-  {datatype, {enum, [true, false]}}
-]}.
-
-%% @doc Monitor Busy Dist Port
-{mapping, "sysmon.busy_dist_port", "emqttd.sysmon", [
-  {default, true},
-  {datatype, {enum, [true, false]}}
-]}.
-
-{translation, "emqttd.sysmon", fun(Conf) ->
-    [{long_gc, cuttlefish:conf_get("sysmon.long_gc", Conf)},
-     {long_schedule, cuttlefish:conf_get("sysmon.long_schedule", Conf)},
-     {large_heap, cuttlefish:conf_get("sysmon.large_heap", Conf)},
-     {busy_port, cuttlefish:conf_get("sysmon.busy_port", Conf)},
-     {busy_dist_port, cuttlefish:conf_get("sysmon.busy_dist_port", Conf)}]
-end}.
-
-{mapping, "platform_etc_dir", "emqttd.platform_etc_dir", [
-  {datatype, directory},
-  {default, "./etc"}
-]}.
-
-{mapping, "platform_log_dir", "emqttd.platform_log_dir", [
-  {datatype, directory},
-  {default, "./log"}
-]}.
-
-{mapping, "platform_data_dir", "emqttd.platform_data_dir", [
-  {datatype, directory},
-  {default, "./data"}
-]}.
-