emqx_prometheus_schema.hocon 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. emqx_prometheus_schema {
  2. enable.desc:
  3. """Turn Prometheus data pushing on or off"""
  4. headers.desc:
  5. """An HTTP Headers when pushing to Push Gateway.<br/>
  6. For example, <code> { Authorization = "some-authz-tokens"}</code>"""
  7. interval.desc:
  8. """Data reporting interval"""
  9. job_name.desc:
  10. """Job Name that is pushed to the Push Gateway. Available variables:<br/>
  11. - ${name}: Name of EMQX node.<br/>
  12. - ${host}: Host name of EMQX node.<br/>
  13. 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/>
  14. Default value is: <code>${name}/instance/${name}~${host}</code>"""
  15. mnesia_collector.desc:
  16. """Enable or disable Mnesia metrics collector"""
  17. prometheus.desc:
  18. """EMQX's Prometheus scraping endpoint is enabled by default without authentication.
  19. You can inspect it with a `curl` command like this: `curl -f "127.0.0.1:18083/api/v5/prometheus/stats"`<br/>
  20. The 'enable' flag is used to turn on and off for the push-gateway integration."""
  21. prometheus.label:
  22. """Prometheus"""
  23. push_gateway_server.desc:
  24. """URL of Prometheus server. Pushgateway is optional, should not be configured if prometheus is to scrape EMQX."""
  25. vm_dist_collector.desc:
  26. """Enable or disable VM distribution collector, collects information about the sockets and processes involved in the Erlang distribution mechanism."""
  27. vm_memory_collector.desc:
  28. """Enable or disable VM memory metrics collector."""
  29. vm_msacc_collector.desc:
  30. """Enable or disable VM microstate accounting metrics collector."""
  31. vm_statistics_collector.desc:
  32. """Enable or disable VM statistics collector."""
  33. vm_system_info_collector.desc:
  34. """Enable or disable VM system info collector."""
  35. }