Monitor

Update Prometheus config

put/prometheus

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/prometheus
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Request body

push_gateway_serverstring required

URL of Prometheus server

intervalstring required

Data reporting interval

headersobject[]

A list of HTTP Headers when pushing to Push Gateway.<br/><br/>For example, <code> { Authorization = "some-authz-tokens"}</code>

job_namestring required

Job Name that is pushed to the Push Gateway. Available variables:<br/><br/>- ${name}: Name of EMQX node.<br/><br/>- ${host}: Host name of EMQX node.<br/><br/>For example, when the EMQX node name is <code>emqx@127.0.0.1</code> then the <code>name</code> variable takes value <code>emqx</code> and the <code>host</code> variable takes value <code>127.0.0.1</code>.<br/><br/><br/>Default value is: <code>${name}/instance/${name}~${host}</code><br/>

enableboolean required

Turn Prometheus data pushing on or off

vm_dist_collector'enabled' | 'disabled' required

Enable or disable VM distribution collector, collects information about the sockets and processes involved in the Erlang distribution mechanism.

mnesia_collector'enabled' | 'disabled' required

Enable or disable Mnesia collector, collects Mnesia metrics mainly using mnesia:system_info/1 .

vm_statistics_collector'enabled' | 'disabled' required

Enable or disable VM statistics collector, collects Erlang VM metrics using erlang:statistics/1 .

vm_system_info_collector'enabled' | 'disabled' required

Enable or disable VM system info collector, collects Erlang VM metrics using erlang:system_info/1 .

vm_memory_collector'enabled' | 'disabled' required

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 .

vm_msacc_collector'enabled' | 'disabled' required

Enable or disable VM msacc collector, collects microstate accounting metrics using erlang:statistics(microstate_accounting) .

Example request

{
  "interval": "32s",
  "headers": [
    {}
  ]
}

Response

push_gateway_serverstring required

URL of Prometheus server

intervalstring required

Data reporting interval

headersobject[]

A list of HTTP Headers when pushing to Push Gateway.<br/><br/>For example, <code> { Authorization = "some-authz-tokens"}</code>

job_namestring required

Job Name that is pushed to the Push Gateway. Available variables:<br/><br/>- ${name}: Name of EMQX node.<br/><br/>- ${host}: Host name of EMQX node.<br/><br/>For example, when the EMQX node name is <code>emqx@127.0.0.1</code> then the <code>name</code> variable takes value <code>emqx</code> and the <code>host</code> variable takes value <code>127.0.0.1</code>.<br/><br/><br/>Default value is: <code>${name}/instance/${name}~${host}</code><br/>

enableboolean required

Turn Prometheus data pushing on or off

vm_dist_collector'enabled' | 'disabled' required

Enable or disable VM distribution collector, collects information about the sockets and processes involved in the Erlang distribution mechanism.

mnesia_collector'enabled' | 'disabled' required

Enable or disable Mnesia collector, collects Mnesia metrics mainly using mnesia:system_info/1 .

vm_statistics_collector'enabled' | 'disabled' required

Enable or disable VM statistics collector, collects Erlang VM metrics using erlang:statistics/1 .

vm_system_info_collector'enabled' | 'disabled' required

Enable or disable VM system info collector, collects Erlang VM metrics using erlang:system_info/1 .

vm_memory_collector'enabled' | 'disabled' required

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 .

vm_msacc_collector'enabled' | 'disabled' required

Enable or disable VM msacc collector, collects microstate accounting metrics using erlang:statistics(microstate_accounting) .

Example response

{
  "interval": "32s",
  "headers": [
    {}
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.