emqx/apps/emqx_prometheus/src/emqx_prometheus_schema.erl

164 lines
4.8 KiB
Erlang

%%--------------------------------------------------------------------
%% Copyright (c) 2020-2023 EMQ Technologies Co., Ltd. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%--------------------------------------------------------------------
-module(emqx_prometheus_schema).
-include_lib("hocon/include/hoconsc.hrl").
-include_lib("typerefl/include/types.hrl").
-behaviour(hocon_schema).
-export([
namespace/0,
roots/0,
fields/1,
desc/1,
translation/1,
convert_headers/1
]).
namespace() -> "prometheus".
roots() -> [{"prometheus", ?HOCON(?R_REF("prometheus"), #{translate_to => ["prometheus"]})}].
fields("prometheus") ->
[
{push_gateway_server,
?HOCON(
string(),
#{
default => "http://127.0.0.1:9091",
required => true,
desc => ?DESC(push_gateway_server)
}
)},
{interval,
?HOCON(
emqx_schema:duration_ms(),
#{
default => "15s",
required => true,
desc => ?DESC(interval)
}
)},
{headers,
?HOCON(
list({string(), string()}),
#{
default => #{},
required => false,
converter => fun ?MODULE:convert_headers/1,
desc => ?DESC(headers)
}
)},
{job_name,
?HOCON(
binary(),
#{
default => <<"${name}/instance/${name}~${host}">>,
required => true,
desc => ?DESC(job_name)
}
)},
{enable,
?HOCON(
boolean(),
#{
default => false,
required => true,
desc => ?DESC(enable)
}
)},
{vm_dist_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
#{
default => enabled,
required => true,
hidden => true,
desc => ?DESC(vm_dist_collector)
}
)},
{mnesia_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
#{
default => enabled,
required => true,
hidden => true,
desc => ?DESC(mnesia_collector)
}
)},
{vm_statistics_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
#{
default => enabled,
required => true,
hidden => true,
desc => ?DESC(vm_statistics_collector)
}
)},
{vm_system_info_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
#{
default => enabled,
required => true,
hidden => true,
desc => ?DESC(vm_system_info_collector)
}
)},
{vm_memory_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
#{
default => enabled,
required => true,
hidden => true,
desc => ?DESC(vm_memory_collector)
}
)},
{vm_msacc_collector,
?HOCON(
hoconsc:enum([enabled, disabled]),
#{
default => enabled,
required => true,
hidden => true,
desc => ?DESC(vm_msacc_collector)
}
)}
].
desc("prometheus") -> ?DESC(prometheus);
desc(_) -> undefined.
convert_headers(Headers) when is_map(Headers) ->
maps:fold(
fun(K, V, Acc) ->
[{binary_to_list(K), binary_to_list(V)} | Acc]
end,
[],
Headers
);
convert_headers(Headers) when is_list(Headers) ->
Headers.
%% for CI test, CI don't load the whole emqx_conf_schema.
translation(Name) ->
emqx_conf_schema:translation(Name).