yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: move some prometheus docs from schema desc to code comments

This commit is contained in:
Zaiming (Stone) Shi 2023-06-25 23:05:04 +02:00
parent 07c80f4031
commit 92ed7d7639
3 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
apps/emqx_prometheus/src/emqx_prometheus_schema.erl
View File

@ -94,6 +94,7 @@ fields("prometheus") ->
desc => ?DESC(vm_dist_collector)
}
)},
%% Mnesia metrics mainly using mnesia:system_info/1
{mnesia_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
@ -104,6 +105,7 @@ fields("prometheus") ->
desc => ?DESC(mnesia_collector)
}
)},
%% Collects Erlang VM metrics using erlang:statistics/1.
{vm_statistics_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
@ -114,6 +116,7 @@ fields("prometheus") ->
desc => ?DESC(vm_statistics_collector)
}
)},
%% Collects Erlang VM metrics using erlang:system_info/1.
{vm_system_info_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
@ -124,6 +127,8 @@ fields("prometheus") ->
desc => ?DESC(vm_system_info_collector)
}
)},
%% Collects information about memory dynamically allocated by the Erlang VM using erlang:memory/0,
%% it also provides basic (D)ETS statistics.
{vm_memory_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
@ -134,6 +139,7 @@ fields("prometheus") ->
desc => ?DESC(vm_memory_collector)
}
)},
%% Collects microstate accounting metrics using erlang:statistics(microstate_accounting).
{vm_msacc_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),

10
rel/i18n/emqx_prometheus_schema.hocon
View File

@ -18,7 +18,7 @@ For example, when the EMQX node name is <code>emqx@127.0.0.1</code> then the <co
Default value is: <code>${name}/instance/${name}~${host}</code>"""
mnesia_collector.desc:
"""Enable or disable Mnesia collector, collects Mnesia metrics mainly using mnesia:system_info/1 ."""
"""Enable or disable Mnesia metrics collector"""
prometheus.desc:
"""EMQX's Prometheus scraping endpoint is enabled by default without authentication.
@ -35,15 +35,15 @@ vm_dist_collector.desc:
"""Enable or disable VM distribution collector, collects information about the sockets and processes involved in the Erlang distribution mechanism."""
vm_memory_collector.desc:
"""Enable or disable VM memory collector, collects information about memory dynamically allocated by the Erlang emulator using erlang:memory/0 , also provides basic (D)ETS statistics ."""
"""Enable or disable VM memory metrics collector."""
vm_msacc_collector.desc:
"""Enable or disable VM msacc collector, collects microstate accounting metrics using erlang:statistics(microstate_accounting) ."""
"""Enable or disable VM microstate accounting metrics collector."""
vm_statistics_collector.desc:
"""Enable or disable VM statistics collector, collects Erlang VM metrics using erlang:statistics/1 ."""
"""Enable or disable VM statistics collector."""
vm_system_info_collector.desc:
"""Enable or disable VM system info collector, collects Erlang VM metrics using erlang:system_info/1 ."""
"""Enable or disable VM system info collector."""
}

2
rel/i18n/emqx_retainer_schema.hocon
View File

@ -38,7 +38,7 @@ msg_clear_interval.desc:
msg_expiry_interval.desc:
"""Message retention time. This config is only applicable for messages without the Message Expiry Interval message property.
0 means message will never expir."""
0 means message will never expire."""
stop_publish_clear_msg.desc:
"""When the retained flag of the `PUBLISH` message is set and Payload is empty,