RepoMirrors
/
haproxy
mirror of http://git.haproxy.org/git/haproxy.git/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
haproxy/addons/promex/README

415 lines
20 KiB
Plaintext
Raw Normal View History

CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
PROMEX: A Prometheus exporter for HAProxy
-------------------------------------------
Prometheus is a monitoring and alerting system. More and more people use it to
monitor their environment (this is written February 2019). It collects metrics
from monitored targets by scraping metrics HTTP endpoints on these targets. For
DOC: assorted typo fixes in the documentation This is the fourth round of cleanups in various docs
2020-03-14 12:47:28 +00:00
HAProxy, The Prometheus team officially supports an exporter written in Go
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
(https://github.com/prometheus/haproxy_exporter). But it requires an extra
software to deploy and monitor. PROMEX, on its side, is a built-in Prometheus
exporter for HAProxy. It was developed as a service and is directly available in
HAProxy, like the stats applet.
However, PROMEX is not built by default with HAProxy. It is provided as an extra
DOC: assorted typo fixes in the documentation This is the fourth round of cleanups in various docs
2020-03-14 12:47:28 +00:00
component for everyone want to use it. So you need to explicitly build HAProxy
BUILD: makefile: add a "USE_PROMEX" variable to ease building prometheus-exporter The Prometheus exporter has gained in popularity and deserves to be easier to build. Let's add a standard "USE_PROMEX" variable to enable it without having to modify EXTRA_OBJS nor fiddling with the build path. The readme was updated to reflect this.
2021-04-02 13:31:10 +00:00
with the PROMEX service, setting the Makefile variable "USE_PROMEX" to "1". For
instance:
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
BUILD: makefile: add a "USE_PROMEX" variable to ease building prometheus-exporter The Prometheus exporter has gained in popularity and deserves to be easier to build. Let's add a standard "USE_PROMEX" variable to enable it without having to modify EXTRA_OBJS nor fiddling with the build path. The readme was updated to reflect this.
2021-04-02 13:31:10 +00:00
> make TARGET=linux-glibc USE_PROMEX=1
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
if HAProxy provides the PROMEX service, the following build option will be
reported by the command "haproxy -vv":
Built with the Prometheus exporter as a service
To be used, it must be enabled in the configuration with an "http-request" rule
and the corresponding HTTP proxy must enable the HTX support. For instance:
frontend test
mode http
...
http-request use-service prometheus-exporter if { path /metrics }
...
This service has been developed as a third-party component because it could
become obsolete, depending on how much time Prometheus will remain heavily
used. This is said with no ulterior motive of course. Prometheus is a great
software and I hope all the well for it. But we involve in a environment moving
quickly and a solution may be obvious today could be deprecated the next
year. And because PROMEX is not integrated by default into the HAProxy codebase,
it will need some interest to be actively supported. All contribution of any
kind are welcome.
You must also be careful if you use with huge configurations. Unlike the stats
applet, all metrics are not grouped by service (proxy, listener or server). With
PROMEX, all lines for a given metric are provided as one single group. So
instead of collecting all metrics for a proxy before moving to the next one, we
must loop on all proxies for each metric. Same for the servers. Thus, it will
DOC: assorted typo fixes in the documentation This is the fourth round of cleanups in various docs
2020-03-14 12:47:28 +00:00
spend much more resources to produce the Prometheus metrics than the CSV export
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
through the stats page. To give a comparison order, quick benchmarks shown that
a PROMEX dump is 5x slower and 20x more verbose than a CSV export.
MINOR: contrib/prometheus-exporter: filter exported metrics by scope Now, the prometheus exporter parses the HTTP query-string to filter or to adapt the exported metrics. In this first version, it is only possible select the scopes of metrics to export. To do so, one or more parameters with "scope" as name must be passed in the query-string, with one of those values: global, frontend, backend, server or '*' (means all). A scope parameter with no value means to filter out all scopes (nothing is returned). The scope parameters are parsed in their appearance order in the query-string. So an empty scope will reset all scopes already parsed. But it can be overridden by following scope parameters in the query-string. By default everything is exported. The filtering can also be done on prometheus scraping configuration, but general aim is to optimise the source of data to improve load and scraping time. This is particularly true for huge configuration with thousands of backends and servers. Also note that this configuration was possible on the previous official haproxy exporter but with even more parameters to select the needed metrics. Here we thought it was sufficient to simply avoid a given type of metric. However, more filters are still possible. Thanks to William Dauchy. This patch is based on his work.
2019-11-18 13:47:08 +00:00
metrics filtering
-------------------
It is possible to dynamically select the metrics to export if you don't use all
of them passing parameters in the query-string.
* Filtering on scopes
The metrics may be filtered by scopes. Multiple parameters with "scope" as name
may be passed in the query-string to filter exported metrics, with one of those
values: global, frontend, backend, server or '*' (means all). A scope parameter
with no value means to filter out all scopes (nothing is returned). The scope
parameters are parsed in their appearance order in the query-string. So an empty
scope will reset all scopes already parsed. But it can be overridden by
following scope parameters in the query-string. By default everything is
exported. Here are examples:
/metrics?scope=server # ==> server metrics will be exported
/metrics?scope=frontend&scope=backend # ==> Frontend and backend metrics will be exported
MEDIUM: contrib/prometheus-exporter: add listen stats this was a missing piece for a while now even though it was planned. This patch adds listen stats. Nothing in particular but we make use of the status helper previously added. `promex_st_metrics` diff also looks scary, but I had to realign all lines. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-14 22:22:56 +00:00
/metrics?scope=listener # ==> listener metrics will be exported
MINOR: contrib/prometheus-exporter: filter exported metrics by scope Now, the prometheus exporter parses the HTTP query-string to filter or to adapt the exported metrics. In this first version, it is only possible select the scopes of metrics to export. To do so, one or more parameters with "scope" as name must be passed in the query-string, with one of those values: global, frontend, backend, server or '*' (means all). A scope parameter with no value means to filter out all scopes (nothing is returned). The scope parameters are parsed in their appearance order in the query-string. So an empty scope will reset all scopes already parsed. But it can be overridden by following scope parameters in the query-string. By default everything is exported. The filtering can also be done on prometheus scraping configuration, but general aim is to optimise the source of data to improve load and scraping time. This is particularly true for huge configuration with thousands of backends and servers. Also note that this configuration was possible on the previous official haproxy exporter but with even more parameters to select the needed metrics. Here we thought it was sufficient to simply avoid a given type of metric. However, more filters are still possible. Thanks to William Dauchy. This patch is based on his work.
2019-11-18 13:47:08 +00:00
/metrics?scope=*&scope= # ==> no metrics will be exported
/metrics?scope=&scope=global # ==> global metrics will be exported
MEDIUM: contrib/prometheus-exporter: export base stick table stats I saw some people falling back to unix socket to collect some data they could not find in prometheus exporter. One of them is base info from stick tables (used/size). I do not plan to extend it more for now; keys are quite a mess to handle. This should resolve github issue #1008. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-07 19:42:38 +00:00
/metrics?scope=sticktable # ==> stick tables metrics will be exported
MINOR: contrib/prometheus-exporter: filter exported metrics by scope Now, the prometheus exporter parses the HTTP query-string to filter or to adapt the exported metrics. In this first version, it is only possible select the scopes of metrics to export. To do so, one or more parameters with "scope" as name must be passed in the query-string, with one of those values: global, frontend, backend, server or '*' (means all). A scope parameter with no value means to filter out all scopes (nothing is returned). The scope parameters are parsed in their appearance order in the query-string. So an empty scope will reset all scopes already parsed. But it can be overridden by following scope parameters in the query-string. By default everything is exported. The filtering can also be done on prometheus scraping configuration, but general aim is to optimise the source of data to improve load and scraping time. This is particularly true for huge configuration with thousands of backends and servers. Also note that this configuration was possible on the previous official haproxy exporter but with even more parameters to select the needed metrics. Here we thought it was sufficient to simply avoid a given type of metric. However, more filters are still possible. Thanks to William Dauchy. This patch is based on his work.
2019-11-18 13:47:08 +00:00
MEDIUM: promex: Add support for filters on metric names It is now possible to filter the metrics on their name, by listing explicitly metrics to dump or on the opposite to exclude only some metrics from the dump. To do so, a comma-separated list of metrics must be specified. If a name is preceded by a minus (-), the metric is excluded from the dump. If at least one metric is specified to be explicitly dumped, all metrics are no longer dumped, but only those explicitly listed. The list is specified via one or more "metrics" parameters in the uri query-string. For insance: # Dumped all metrics, except "haproxy_server_check_status" /metrics?metrics=-haproxy_server_check_status # Only dump frontends, backends and servers status /metrics?metrics=haproxy_frontend_status,haproxy_backend_status,haproxy_server_status Included and Excluded metrics can be mixed. Only the intersection will be dumped. This patch should fix the issue #770.
2024-01-31 16:15:49 +00:00
* Filtering on metrics name
It is possible to filter metrics dumped by the exporter. To to so, multiple
"metrics" parameters may be passed to specify all metrics to include or exclude,
as a comma-separated list of filter. By default, there is no filter and all
metrics are dumped. By specifying at least one metric to be included in the
CLEANUP: assorted typo fixes in the code and comments This is 39th iteration of typo fixes The naming issue on the argument called "unsued" instead of "unused" in two functions from resolvers and stick-tables was put into a second patch so that it can be omitted if it were to cause backport issues.
2024-02-22 09:12:27 +00:00
dump, this disables the default behavior and only explicitly mentioned metrics
MEDIUM: promex: Add support for filters on metric names It is now possible to filter the metrics on their name, by listing explicitly metrics to dump or on the opposite to exclude only some metrics from the dump. To do so, a comma-separated list of metrics must be specified. If a name is preceded by a minus (-), the metric is excluded from the dump. If at least one metric is specified to be explicitly dumped, all metrics are no longer dumped, but only those explicitly listed. The list is specified via one or more "metrics" parameters in the uri query-string. For insance: # Dumped all metrics, except "haproxy_server_check_status" /metrics?metrics=-haproxy_server_check_status # Only dump frontends, backends and servers status /metrics?metrics=haproxy_frontend_status,haproxy_backend_status,haproxy_server_status Included and Excluded metrics can be mixed. Only the intersection will be dumped. This patch should fix the issue #770.
2024-01-31 16:15:49 +00:00
are dumped. To include a metric, its name must be specified. To exclude it, its
CLEANUP: assorted typo fixes in the code and comments This is 39th iteration of typo fixes The naming issue on the argument called "unsued" instead of "unused" in two functions from resolvers and stick-tables was put into a second patch so that it can be omitted if it were to cause backport issues.
2024-02-22 09:12:27 +00:00
name must be preceded by a minus character ('-'). Here are examples:
MEDIUM: promex: Add support for filters on metric names It is now possible to filter the metrics on their name, by listing explicitly metrics to dump or on the opposite to exclude only some metrics from the dump. To do so, a comma-separated list of metrics must be specified. If a name is preceded by a minus (-), the metric is excluded from the dump. If at least one metric is specified to be explicitly dumped, all metrics are no longer dumped, but only those explicitly listed. The list is specified via one or more "metrics" parameters in the uri query-string. For insance: # Dumped all metrics, except "haproxy_server_check_status" /metrics?metrics=-haproxy_server_check_status # Only dump frontends, backends and servers status /metrics?metrics=haproxy_frontend_status,haproxy_backend_status,haproxy_server_status Included and Excluded metrics can be mixed. Only the intersection will be dumped. This patch should fix the issue #770.
2024-01-31 16:15:49 +00:00
# Dumped all metrics, except "haproxy_server_check_status"
/metrics?metrics=-haproxy_server_check_status
# Only dump frontends, backends and servers status
/metrics?metrics=haproxy_frontend_status,haproxy_backend_status,haproxy_server_status
DOC: promex: Add documentation about extra-counters Now the feature is fully implementated, the README is updated accordingly.
2024-01-29 15:55:01 +00:00
* Dump extra counters
Internally, some modules can register to frontends, backends, servers or
listeners to export extra counters. For instance, some multiplexers do so on
frontends or backends. To display extra counters for all regiestered modules,
"extra-counters" parameter must be pass. It can be cumulated with "scope"
parameters:
/metrics?extra-counters # ==> export all extra counters in
# addition to main ones, for all
# scopes
/metrics?scope=frontend&extra-counters # ==> export extra counters for
# frontends
There are extra counters are only for frontends, backends, servers and
listeners.
MAJOR: contrib/prometheus-exporter: move health check status to labels this patch is a breaking change between v2.3 and v2.4: we move from using gauge value for health check states to labels values. The diff is quite small thanks to the preparation work from Christopher to allow more flexibility in labels, see commit 5a2f938732126f43bbf4cea5482c01552b0d0314 ("MEDIUM: contrib/prometheus-exporter: Use dynamic labels instead of static ones") this is a follow up of commit c6464591a365bfcf509b322bdaa4d608c9395d75 ("MAJOR: contrib/prometheus-exporter: move ftd/bkd/srv states to labels"). The main goal being to be better aligned with prometheus use cases in terms of queries. More specifically to health checks, Pierre C. mentioned the possible quirks he had to put in place in order to make use of those metrics through prometheus: <aggregator_function> by(proxy, check_status) (count_values by(proxy, instance) ("check_status", haproxy_server_check_status)) I am perfectly aware this introduces a lot more metrics but I don't see how we can improve the usability without it. The main issue remains in the cardinality of the states which are > 20. Prometheus recommends to stay below a cardinality of 10 for a given metric but I consider our case very specific, because highly linked to the level of precision haproxy exposes. Even before this patch I saw several large production setup (a few hundreds of MB in output) which are making use of the scope parameter to simply ignore the server metrics, so that the scrapping can be faster, and memory consumed on client side not too high. So I believe we should eventually continue in that direction and offer more granularity of filtering of the output. That being said it is already possible to filter out the data on prometheus client side. this is related to github issue #1029 Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:11:51 +00:00
* How do I prevent my prometheus instance to explode?
** Filtering on servers state
MINOR: contrib/prometheus-exporter: Add a param to ignore servers in maintenance By passing the parameter "no-maint" in the query-string, it is now possible to ignore servers in maintenance. It means that the metrics for servers in this state will not be exported.
2019-11-19 13:18:24 +00:00
It is possible to exclude from returned metrics all servers in maintenance mode
passing the parameter "no-maint" in the query-string. This parameter may help to
solve performance issues of configuration that use the server templates to
manage dynamic provisionning. Note there is no consistency check on the servers
state. So, if the state of a server changes while the exporter is running, only
a part of the metrics for this server will be dumped.
MINOR: contrib/prometheus-exporter: filter exported metrics by scope Now, the prometheus exporter parses the HTTP query-string to filter or to adapt the exported metrics. In this first version, it is only possible select the scopes of metrics to export. To do so, one or more parameters with "scope" as name must be passed in the query-string, with one of those values: global, frontend, backend, server or '*' (means all). A scope parameter with no value means to filter out all scopes (nothing is returned). The scope parameters are parsed in their appearance order in the query-string. So an empty scope will reset all scopes already parsed. But it can be overridden by following scope parameters in the query-string. By default everything is exported. The filtering can also be done on prometheus scraping configuration, but general aim is to optimise the source of data to improve load and scraping time. This is particularly true for huge configuration with thousands of backends and servers. Also note that this configuration was possible on the previous official haproxy exporter but with even more parameters to select the needed metrics. Here we thought it was sufficient to simply avoid a given type of metric. However, more filters are still possible. Thanks to William Dauchy. This patch is based on his work.
2019-11-18 13:47:08 +00:00
MAJOR: contrib/prometheus-exporter: move health check status to labels this patch is a breaking change between v2.3 and v2.4: we move from using gauge value for health check states to labels values. The diff is quite small thanks to the preparation work from Christopher to allow more flexibility in labels, see commit 5a2f938732126f43bbf4cea5482c01552b0d0314 ("MEDIUM: contrib/prometheus-exporter: Use dynamic labels instead of static ones") this is a follow up of commit c6464591a365bfcf509b322bdaa4d608c9395d75 ("MAJOR: contrib/prometheus-exporter: move ftd/bkd/srv states to labels"). The main goal being to be better aligned with prometheus use cases in terms of queries. More specifically to health checks, Pierre C. mentioned the possible quirks he had to put in place in order to make use of those metrics through prometheus: <aggregator_function> by(proxy, check_status) (count_values by(proxy, instance) ("check_status", haproxy_server_check_status)) I am perfectly aware this introduces a lot more metrics but I don't see how we can improve the usability without it. The main issue remains in the cardinality of the states which are > 20. Prometheus recommends to stay below a cardinality of 10 for a given metric but I consider our case very specific, because highly linked to the level of precision haproxy exposes. Even before this patch I saw several large production setup (a few hundreds of MB in output) which are making use of the scope parameter to simply ignore the server metrics, so that the scrapping can be faster, and memory consumed on client side not too high. So I believe we should eventually continue in that direction and offer more granularity of filtering of the output. That being said it is already possible to filter out the data on prometheus client side. this is related to github issue #1029 Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:11:51 +00:00
prometheus example config:
For server-template users:
- <job>
params:
no-maint:
- empty
** Scrap server health checks only
All health checks status are dump through `state` label values. If you want to
scrap server health check status but prevent all server metrics to be saved,
except the server_check_status, you may configure prometheus that way:
- <job>
metric_relabel_configs:
- source_labels: ['__name__']
MEDIUM: contrib/prometheus-exporter: add listen stats this was a missing piece for a while now even though it was planned. This patch adds listen stats. Nothing in particular but we make use of the status helper previously added. `promex_st_metrics` diff also looks scary, but I had to realign all lines. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-14 22:22:56 +00:00
regex: 'haproxy_(process_|frontend_|listener_|backend_|server_check_status).*'
MAJOR: contrib/prometheus-exporter: move health check status to labels this patch is a breaking change between v2.3 and v2.4: we move from using gauge value for health check states to labels values. The diff is quite small thanks to the preparation work from Christopher to allow more flexibility in labels, see commit 5a2f938732126f43bbf4cea5482c01552b0d0314 ("MEDIUM: contrib/prometheus-exporter: Use dynamic labels instead of static ones") this is a follow up of commit c6464591a365bfcf509b322bdaa4d608c9395d75 ("MAJOR: contrib/prometheus-exporter: move ftd/bkd/srv states to labels"). The main goal being to be better aligned with prometheus use cases in terms of queries. More specifically to health checks, Pierre C. mentioned the possible quirks he had to put in place in order to make use of those metrics through prometheus: <aggregator_function> by(proxy, check_status) (count_values by(proxy, instance) ("check_status", haproxy_server_check_status)) I am perfectly aware this introduces a lot more metrics but I don't see how we can improve the usability without it. The main issue remains in the cardinality of the states which are > 20. Prometheus recommends to stay below a cardinality of 10 for a given metric but I consider our case very specific, because highly linked to the level of precision haproxy exposes. Even before this patch I saw several large production setup (a few hundreds of MB in output) which are making use of the scope parameter to simply ignore the server metrics, so that the scrapping can be faster, and memory consumed on client side not too high. So I believe we should eventually continue in that direction and offer more granularity of filtering of the output. That being said it is already possible to filter out the data on prometheus client side. this is related to github issue #1029 Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:11:51 +00:00
action: keep
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
Exported metrics
------------------
DOC: promex: Add documentation about extra-counters Now the feature is fully implementated, the README is updated accordingly.
2024-01-29 15:55:01 +00:00
See prometheus export for the description of each field. Only main metrics are
listed below. Metrics from extra counters are not listed.
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
* Globals metrics
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
+------------------------------------------------+
| Metric name |
+------------------------------------------------+
| haproxy_process_nbthread |
| haproxy_process_nbproc |
| haproxy_process_relative_process_id |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_process_uptime_seconds |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_process_pool_failures_total |
| haproxy_process_max_fds |
| haproxy_process_max_sockets |
| haproxy_process_max_connections |
| haproxy_process_hard_max_connections |
| haproxy_process_current_connections |
| haproxy_process_connections_total |
| haproxy_process_requests_total |
| haproxy_process_max_ssl_connections |
| haproxy_process_current_ssl_connections |
| haproxy_process_ssl_connections_total |
| haproxy_process_max_pipes |
| haproxy_process_pipes_used_total |
| haproxy_process_pipes_free_total |
| haproxy_process_current_connection_rate |
| haproxy_process_limit_connection_rate |
| haproxy_process_max_connection_rate |
| haproxy_process_current_session_rate |
| haproxy_process_limit_session_rate |
| haproxy_process_max_session_rate |
| haproxy_process_current_ssl_rate |
| haproxy_process_limit_ssl_rate |
| haproxy_process_max_ssl_rate |
| haproxy_process_current_frontend_ssl_key_rate |
| haproxy_process_max_frontend_ssl_key_rate |
| haproxy_process_frontend_ssl_reuse |
| haproxy_process_current_backend_ssl_key_rate |
| haproxy_process_max_backend_ssl_key_rate |
| haproxy_process_ssl_cache_lookups_total |
| haproxy_process_ssl_cache_misses_total |
| haproxy_process_http_comp_bytes_in_total |
| haproxy_process_http_comp_bytes_out_total |
| haproxy_process_limit_http_comp |
| haproxy_process_current_zlib_memory |
| haproxy_process_max_zlib_memory |
| haproxy_process_current_tasks |
| haproxy_process_current_run_queue |
| haproxy_process_idle_time_percent |
| haproxy_process_stopping |
| haproxy_process_jobs |
| haproxy_process_unstoppable_jobs |
| haproxy_process_listeners |
| haproxy_process_active_peers |
| haproxy_process_connected_peers |
| haproxy_process_dropped_logs_total |
| haproxy_process_busy_polling_enabled |
| haproxy_process_failed_resolutions |
| haproxy_process_bytes_out_total |
| haproxy_process_spliced_bytes_out_total |
| haproxy_process_bytes_out_rate |
| haproxy_process_recv_logs_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_process_build_info |
| haproxy_process_max_memory_bytes |
| haproxy_process_pool_allocated_bytes |
| haproxy_process_pool_used_bytes |
| haproxy_process_start_time_seconds |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
+------------------------------------------------+
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
* Frontend metrics
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
+-------------------------------------------------+
| Metric name |
+-------------------------------------------------+
| haproxy_frontend_current_sessions |
| haproxy_frontend_max_sessions |
| haproxy_frontend_limit_sessions |
| haproxy_frontend_sessions_total |
| haproxy_frontend_bytes_in_total |
| haproxy_frontend_bytes_out_total |
| haproxy_frontend_requests_denied_total |
| haproxy_frontend_responses_denied_total |
| haproxy_frontend_request_errors_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_frontend_status |
| haproxy_frontend_limit_session_rate |
| haproxy_frontend_max_session_rate |
| haproxy_frontend_http_responses_total |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_frontend_http_requests_rate_max |
| haproxy_frontend_http_requests_total |
| haproxy_frontend_http_comp_bytes_in_total |
| haproxy_frontend_http_comp_bytes_out_total |
| haproxy_frontend_http_comp_bytes_bypassed_total |
| haproxy_frontend_http_comp_responses_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_frontend_connections_rate_max |
| haproxy_frontend_connections_total |
| haproxy_frontend_intercepted_requests_total |
| haproxy_frontend_denied_connections_total |
| haproxy_frontend_denied_sessions_total |
| haproxy_frontend_failed_header_rewriting_total |
| haproxy_frontend_http_cache_lookups_total |
| haproxy_frontend_http_cache_hits_total |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_frontend_internal_errors_total |
+-------------------------------------------------+
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
MEDIUM: contrib/prometheus-exporter: add listen stats this was a missing piece for a while now even though it was planned. This patch adds listen stats. Nothing in particular but we make use of the status helper previously added. `promex_st_metrics` diff also looks scary, but I had to realign all lines. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-14 22:22:56 +00:00
* Listener metrics
+-------------------------------------------------+
| Metric name |
+-------------------------------------------------+
| haproxy_listener_current_sessions |
| haproxy_listener_max_sessions |
| haproxy_listener_limit_sessions |
| haproxy_listener_sessions_total |
| haproxy_listener_bytes_in_total |
| haproxy_listener_bytes_out_total |
| haproxy_listener_requests_denied_total |
| haproxy_listener_responses_denied_total |
| haproxy_listener_request_errors_total |
| haproxy_listener_status |
| haproxy_listener_denied_connections_total |
| haproxy_listener_denied_sessions_total |
| haproxy_listener_failed_header_rewriting_total |
| haproxy_listener_internal_errors_total |
+-------------------------------------------------+
DOC: fix typo in Prometheus exporter doc It's just a minor typo in a section title.
2019-10-08 09:28:06 +00:00
* Backend metrics
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
+-----------------------------------------------------+
| Metric name |
+-----------------------------------------------------+
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_backend_current_queue |
| haproxy_backend_max_queue |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_backend_current_sessions |
| haproxy_backend_max_sessions |
| haproxy_backend_limit_sessions |
| haproxy_backend_sessions_total |
| haproxy_backend_bytes_in_total |
| haproxy_backend_bytes_out_total |
| haproxy_backend_requests_denied_total |
| haproxy_backend_responses_denied_total |
| haproxy_backend_connection_errors_total |
| haproxy_backend_response_errors_total |
| haproxy_backend_retry_warnings_total |
| haproxy_backend_redispatch_warnings_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_backend_status |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_backend_weight |
| haproxy_backend_active_servers |
| haproxy_backend_backup_servers |
| haproxy_backend_check_up_down_total |
| haproxy_backend_check_last_change_seconds |
| haproxy_backend_downtime_seconds_total |
| haproxy_backend_loadbalanced_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_backend_max_session_rate |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_backend_http_responses_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_backend_http_requests_total |
| haproxy_backend_client_aborts_total |
| haproxy_backend_server_aborts_total |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_backend_http_comp_bytes_in_total |
| haproxy_backend_http_comp_bytes_out_total |
| haproxy_backend_http_comp_bytes_bypassed_total |
| haproxy_backend_http_comp_responses_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_backend_last_session_seconds |
| haproxy_backend_queue_time_average_seconds |
| haproxy_backend_connect_time_average_seconds |
| haproxy_backend_response_time_average_seconds |
| haproxy_backend_total_time_average_seconds |
| haproxy_backend_failed_header_rewriting_total |
| haproxy_backend_connection_attempts_total |
| haproxy_backend_connection_reuses_total |
| haproxy_backend_http_cache_lookups_total |
| haproxy_backend_http_cache_hits_total |
| haproxy_backend_max_queue_time_seconds |
| haproxy_backend_max_connect_time_seconds |
| haproxy_backend_max_response_time_seconds |
| haproxy_backend_max_total_time_seconds |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_backend_internal_errors_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_backend_uweight |
DOC: promex: Add missing backend metrics "haproxy_backend_agg_server_status" and "haproxy_backend_agg_check_status" were not referenced in promex README. "haproxy_backend_agg_server_check_status" is also missing but it is a deprecated metric. Thus, it is better to not reference it.
2022-12-09 10:04:11 +00:00
| haproxy_backend_agg_server_status |
| haproxy_backend_agg_check_status |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
+-----------------------------------------------------+
CONTRIB: contrib/prometheus-exporter: Add a Prometheus exporter for HAProxy It has been developped as a service applet. Internally, it is called "promex". To build HAProxy with the promex service, you should use the Makefile variable "EXTRA_OBJS". To be used, it must be enabled in the configuration with an "http-request" rule and the corresponding HTTP proxy must enable the HTX support. For instance: frontend test mode http ... option http-use-htx http-request use-service prometheus-exporter if { path /metrics } ... See contrib/prometheus-exporter/README for details.
2019-02-07 14:38:42 +00:00
* Server metrics
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
+----------------------------------------------------+
| Metric name |
+----------------------------------------------------+
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_server_current_queue |
| haproxy_server_max_queue |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_server_current_sessions |
| haproxy_server_max_sessions |
| haproxy_server_limit_sessions |
| haproxy_server_sessions_total |
| haproxy_server_bytes_in_total |
| haproxy_server_bytes_out_total |
| haproxy_server_responses_denied_total |
| haproxy_server_connection_errors_total |
| haproxy_server_response_errors_total |
| haproxy_server_retry_warnings_total |
| haproxy_server_redispatch_warnings_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_server_status |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_server_weight |
MINOR: promex: Export active/backup metrics per-server numbers of active and backup servers per backend were exported but the info was not exported per-server. The main issue to do so was we were unable to have a different name for the same metric in a different scope. Thanks to the previous patch ("MINOR: promex: Add support for specialized front/back/li/srv metric names") it is now possible. So the info is now exported per-server. This patch should fix the issue #2271.
2023-12-04 09:49:52 +00:00
| haproxy_server_active |
| haproxy_server_backup |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_server_check_failures_total |
| haproxy_server_check_up_down_total |
| haproxy_server_check_last_change_seconds |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_server_downtime_seconds_total |
| haproxy_server_queue_limit |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_server_current_throttle |
| haproxy_server_loadbalanced_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_server_max_session_rate |
| haproxy_server_check_status |
| haproxy_server_check_code |
| haproxy_server_check_duration_seconds |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_server_http_responses_total |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_server_client_aborts_total |
| haproxy_server_server_aborts_total |
| haproxy_server_last_session_seconds |
| haproxy_server_queue_time_average_seconds |
| haproxy_server_connect_time_average_seconds |
| haproxy_server_response_time_average_seconds |
| haproxy_server_total_time_average_seconds |
| haproxy_server_failed_header_rewriting_total |
| haproxy_server_connection_attempts_total |
| haproxy_server_connection_reuses_total |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_server_idle_connections_current |
| haproxy_server_idle_connections_limit |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_server_max_queue_time_seconds |
| haproxy_server_max_connect_time_seconds |
| haproxy_server_max_response_time_seconds |
| haproxy_server_max_total_time_seconds |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
| haproxy_server_internal_errors_total |
| haproxy_server_unsafe_idle_connections_current |
| haproxy_server_safe_idle_connections_current |
| haproxy_server_used_connections_current |
| haproxy_server_need_connections_current |
DOC: contrib/prometheus-exporter: Add missing metrics in README Some metrics were missing (haproxy_process_uptime_seconds and haproxy_process_build_info). To ease the review against the service output, the same order is used in the README.
2021-02-01 13:50:30 +00:00
| haproxy_server_uweight |
CLEANUP: contrib/prometheus-exporter: remove description in README Now that we got ride of description in prometheus code, let's assume we no longer need to maintain it in README, and diret user to the output of prometheus to get more info. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-01 12:12:00 +00:00
+----------------------------------------------------+
MEDIUM: contrib/prometheus-exporter: export base stick table stats I saw some people falling back to unix socket to collect some data they could not find in prometheus exporter. One of them is base info from stick tables (used/size). I do not plan to extend it more for now; keys are quite a mess to handle. This should resolve github issue #1008. Signed-off-by: William Dauchy <wdauchy@gmail.com>
2021-02-07 19:42:38 +00:00
* Stick table metrics
+----------------------------------------------------+
| Metric name |
+----------------------------------------------------+
| haproxy_sticktable_size |
| haproxy_sticktable_used |
+----------------------------------------------------+
MEDIUM: promex/resolvers: Dump resolvers metrics via a promex module Just like for stick-tables, this patch adds a promex module to dump resolvers metrics. It adds the "resolver" scope and for now, it dumps folloowing metrics: * haproxy_resolver_sent * haproxy_resolver_send_error * haproxy_resolver_valid * haproxy_resolver_update * haproxy_resolver_cname * haproxy_resolver_cname_error * haproxy_resolver_any_err * haproxy_resolver_nx * haproxy_resolver_timeout * haproxy_resolver_refused * haproxy_resolver_other * haproxy_resolver_invalid * haproxy_resolver_too_big * haproxy_resolver_outdated
2024-01-31 09:34:14 +00:00
* Resolvers metrics
+----------------------------------------------------+
| Metric name |
+----------------------------------------------------+
| haproxy_resolver_sent |
| haproxy_resolver_send_error |
| haproxy_resolver_valid |
| haproxy_resolver_update |
| haproxy_resolver_cname |
| haproxy_resolver_cname_error |
| haproxy_resolver_any_err |
| haproxy_resolver_nx |
| haproxy_resolver_timeout |
| haproxy_resolver_refused |
| haproxy_resolver_other |
| haproxy_resolver_invalid |
| haproxy_resolver_too_big |
| haproxy_resolver_outdated |
+----------------------------------------------------+