blob: 7cf30c1f3cd061d7e3dd71a0ed62bc02d40e78f1 [file] [log] [blame]
Christopher Fauletf959d082019-02-07 15:38:42 +01001/*
2 * Promex is a Prometheus exporter for HAProxy
3 *
4 * It is highly inspired by the official Prometheus exporter.
5 * See: https://github.com/prometheus/haproxy_exporter
6 *
7 * Copyright 2019 Christopher Faulet <cfaulet@haproxy.com>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
13 *
14 */
15
Willy Tarreau122eba92020-06-04 10:15:32 +020016#include <haproxy/action-t.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020017#include <haproxy/api.h>
Willy Tarreau3f0f82e2020-06-04 19:42:41 +020018#include <haproxy/applet.h>
Willy Tarreau49801602020-06-04 22:50:02 +020019#include <haproxy/backend.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020020#include <haproxy/cfgparse.h>
William Dauchyde3c3262021-02-01 13:11:51 +010021#include <haproxy/check.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020022#include <haproxy/frontend.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020023#include <haproxy/global.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020024#include <haproxy/http.h>
Willy Tarreau87735332020-06-04 09:08:41 +020025#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020026#include <haproxy/htx.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020027#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020028#include <haproxy/listener.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020029#include <haproxy/log.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020030#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020031#include <haproxy/sample.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020032#include <haproxy/server.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020033#include <haproxy/stats.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020034#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020035#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020036#include <haproxy/task.h>
William Dauchy5a982a72021-01-08 13:18:06 +010037#include <haproxy/version.h>
Christopher Fauletf959d082019-02-07 15:38:42 +010038
39/* Prometheus exporter applet states (appctx->st0) */
40enum {
41 PROMEX_ST_INIT = 0, /* initialized */
42 PROMEX_ST_HEAD, /* send headers before dump */
43 PROMEX_ST_DUMP, /* dumping stats */
44 PROMEX_ST_DONE, /* finished */
Christopher Faulet9744f7c2019-03-27 15:48:53 +010045 PROMEX_ST_END, /* treatment terminated */
Christopher Fauletf959d082019-02-07 15:38:42 +010046};
47
48/* Prometheus exporter dumper states (appctx->st1) */
49enum {
William Dauchy69164222021-02-07 20:42:38 +010050 PROMEX_DUMPER_INIT = 0, /* initialized */
51 PROMEX_DUMPER_GLOBAL, /* dump metrics of globals */
52 PROMEX_DUMPER_FRONT, /* dump metrics of frontend proxies */
53 PROMEX_DUMPER_BACK, /* dump metrics of backend proxies */
54 PROMEX_DUMPER_LI, /* dump metrics of listeners */
55 PROMEX_DUMPER_SRV, /* dump metrics of servers */
56 PROMEX_DUMPER_STICKTABLE, /* dump metrics of stick tables */
57 PROMEX_DUMPER_DONE, /* finished */
Christopher Fauletf959d082019-02-07 15:38:42 +010058};
59
60/* Prometheus exporter flags (appctx->ctx.stats.flags) */
William Dauchy69164222021-02-07 20:42:38 +010061#define PROMEX_FL_METRIC_HDR 0x00000001
62#define PROMEX_FL_INFO_METRIC 0x00000002
63#define PROMEX_FL_FRONT_METRIC 0x00000004
64#define PROMEX_FL_BACK_METRIC 0x00000008
65#define PROMEX_FL_SRV_METRIC 0x00000010
William Dauchye3f7bd52021-02-14 23:22:56 +010066#define PROMEX_FL_LI_METRIC 0x00000020
67#define PROMEX_FL_STICKTABLE_METRIC 0x00000040
68#define PROMEX_FL_SCOPE_GLOBAL 0x00000080
69#define PROMEX_FL_SCOPE_FRONT 0x00000100
70#define PROMEX_FL_SCOPE_BACK 0x00000200
71#define PROMEX_FL_SCOPE_SERVER 0x00000400
72#define PROMEX_FL_SCOPE_LI 0x00000800
73#define PROMEX_FL_SCOPE_STICKTABLE 0x00001000
74#define PROMEX_FL_NO_MAINT_SRV 0x00002000
Christopher Faulet78407ce2019-11-18 14:47:08 +010075
William Dauchy69164222021-02-07 20:42:38 +010076#define PROMEX_FL_SCOPE_ALL (PROMEX_FL_SCOPE_GLOBAL | PROMEX_FL_SCOPE_FRONT | \
William Dauchye3f7bd52021-02-14 23:22:56 +010077 PROMEX_FL_SCOPE_LI | PROMEX_FL_SCOPE_BACK | \
78 PROMEX_FL_SCOPE_SERVER | PROMEX_FL_SCOPE_STICKTABLE)
Christopher Fauletf959d082019-02-07 15:38:42 +010079
Christopher Faulet0312c0d2021-01-20 15:19:12 +010080/* Promtheus metric type (gauge or counter) */
81enum promex_mt_type {
82 PROMEX_MT_GAUGE = 1,
83 PROMEX_MT_COUNTER = 2,
84};
85
Christopher Fauletf959d082019-02-07 15:38:42 +010086/* The max length for metrics name. It is a hard limit but it should be
Ilya Shipitsince7b00f2020-03-23 22:28:40 +050087 * enough.
Christopher Fauletf959d082019-02-07 15:38:42 +010088 */
89#define PROMEX_MAX_NAME_LEN 128
90
91/* The expected max length for a metric dump, including its header lines. It is
92 * just a soft limit to avoid extra work. We don't try to dump a metric if less
93 * than this size is available in the HTX.
94 */
95#define PROMEX_MAX_METRIC_LENGTH 512
96
Christopher Faulet5a2f9382021-01-28 11:24:17 +010097/* The max number of labels per metric */
98#define PROMEX_MAX_LABELS 8
William Dauchy5a982a72021-01-08 13:18:06 +010099
Christopher Faulet0312c0d2021-01-20 15:19:12 +0100100/* Describe a prometheus metric */
101struct promex_metric {
102 const struct ist n; /* The metric name */
103 enum promex_mt_type type; /* The metric type (gauge or counter) */
104 unsigned int flags; /* PROMEX_FL_* flags */
105};
106
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100107/* Describe a prometheus metric label. It is just a key/value pair */
108struct promex_label {
109 struct ist name;
110 struct ist value;
111};
112
Christopher Faulet37286a52021-01-20 15:20:53 +0100113/* Global metrics */
114const struct promex_metric promex_global_metrics[INF_TOTAL_FIELDS] = {
115 //[INF_NAME] ignored
116 //[INF_VERSION], ignored
117 //[INF_RELEASE_DATE] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100118 [INF_NBTHREAD] = { .n = IST("nbthread"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
119 [INF_NBPROC] = { .n = IST("nbproc"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
120 [INF_PROCESS_NUM] = { .n = IST("relative_process_id"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
121 //[INF_PID] ignored
122 //[INF_UPTIME] ignored
123 [INF_UPTIME_SEC] = { .n = IST("uptime_seconds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
124 [INF_START_TIME_SEC] = { .n = IST("start_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100125 //[INF_MEMMAX_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100126 [INF_MEMMAX_BYTES] = { .n = IST("max_memory_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100127 //[INF_POOL_ALLOC_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100128 [INF_POOL_ALLOC_BYTES] = { .n = IST("pool_allocated_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100129 //[INF_POOL_USED_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100130 [INF_POOL_USED_BYTES] = { .n = IST("pool_used_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
131 [INF_POOL_FAILED] = { .n = IST("pool_failures_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
132 [INF_ULIMIT_N] = { .n = IST("max_fds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
133 [INF_MAXSOCK] = { .n = IST("max_sockets"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
134 [INF_MAXCONN] = { .n = IST("max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
135 [INF_HARD_MAXCONN] = { .n = IST("hard_max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
136 [INF_CURR_CONN] = { .n = IST("current_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
137 [INF_CUM_CONN] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
138 [INF_CUM_REQ] = { .n = IST("requests_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
139 [INF_MAX_SSL_CONNS] = { .n = IST("max_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
140 [INF_CURR_SSL_CONNS] = { .n = IST("current_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
141 [INF_CUM_SSL_CONNS] = { .n = IST("ssl_connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
142 [INF_MAXPIPES] = { .n = IST("max_pipes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
143 [INF_PIPES_USED] = { .n = IST("pipes_used_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
144 [INF_PIPES_FREE] = { .n = IST("pipes_free_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
145 [INF_CONN_RATE] = { .n = IST("current_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
146 [INF_CONN_RATE_LIMIT] = { .n = IST("limit_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
147 [INF_MAX_CONN_RATE] = { .n = IST("max_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
148 [INF_SESS_RATE] = { .n = IST("current_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
149 [INF_SESS_RATE_LIMIT] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
150 [INF_MAX_SESS_RATE] = { .n = IST("max_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
151 [INF_SSL_RATE] = { .n = IST("current_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
152 [INF_SSL_RATE_LIMIT] = { .n = IST("limit_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
153 [INF_MAX_SSL_RATE] = { .n = IST("max_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
154 [INF_SSL_FRONTEND_KEY_RATE] = { .n = IST("current_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
155 [INF_SSL_FRONTEND_MAX_KEY_RATE] = { .n = IST("max_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
156 [INF_SSL_FRONTEND_SESSION_REUSE_PCT] = { .n = IST("frontend_ssl_reuse"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
157 [INF_SSL_BACKEND_KEY_RATE] = { .n = IST("current_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
158 [INF_SSL_BACKEND_MAX_KEY_RATE] = { .n = IST("max_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
159 [INF_SSL_CACHE_LOOKUPS] = { .n = IST("ssl_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
160 [INF_SSL_CACHE_MISSES] = { .n = IST("ssl_cache_misses_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
161 [INF_COMPRESS_BPS_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
162 [INF_COMPRESS_BPS_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
163 [INF_COMPRESS_BPS_RATE_LIM] = { .n = IST("limit_http_comp"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
164 [INF_ZLIB_MEM_USAGE] = { .n = IST("current_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
165 [INF_MAX_ZLIB_MEM_USAGE] = { .n = IST("max_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
166 [INF_TASKS] = { .n = IST("current_tasks"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
167 [INF_RUN_QUEUE] = { .n = IST("current_run_queue"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
168 [INF_IDLE_PCT] = { .n = IST("idle_time_percent"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
169 //[INF_NODE] ignored
170 //[INF_DESCRIPTION] ignored
171 [INF_STOPPING] = { .n = IST("stopping"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
172 [INF_JOBS] = { .n = IST("jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
173 [INF_UNSTOPPABLE_JOBS] = { .n = IST("unstoppable_jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
174 [INF_LISTENERS] = { .n = IST("listeners"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
175 [INF_ACTIVE_PEERS] = { .n = IST("active_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
176 [INF_CONNECTED_PEERS] = { .n = IST("connected_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
177 [INF_DROPPED_LOGS] = { .n = IST("dropped_logs_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
178 [INF_BUSY_POLLING] = { .n = IST("busy_polling_enabled"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
179 [INF_FAILED_RESOLUTIONS] = { .n = IST("failed_resolutions"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
180 [INF_TOTAL_BYTES_OUT] = { .n = IST("bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
181 [INF_TOTAL_SPLICED_BYTES_OUT] = { .n = IST("spliced_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
182 [INF_BYTES_OUT_RATE] = { .n = IST("bytes_out_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
183 //[INF_DEBUG_COMMANDS_ISSUED] ignored
William Dauchy7741c332021-02-01 13:11:57 +0100184 [INF_CUM_LOG_MSGS] = { .n = IST("recv_logs_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100185 [INF_BUILD_INFO] = { .n = IST("build_info"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
Christopher Fauletf959d082019-02-07 15:38:42 +0100186};
187
Christopher Faulet37286a52021-01-20 15:20:53 +0100188/* frontend/backend/server fields */
189const struct promex_metric promex_st_metrics[ST_F_TOTAL_FIELDS] = {
190 //[ST_F_PXNAME] ignored
191 //[ST_F_SVNAME] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100192 [ST_F_QCUR] = { .n = IST("current_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
193 [ST_F_QMAX] = { .n = IST("max_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
194 [ST_F_SCUR] = { .n = IST("current_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
195 [ST_F_SMAX] = { .n = IST("max_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
196 [ST_F_SLIM] = { .n = IST("limit_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
197 [ST_F_STOT] = { .n = IST("sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
198 [ST_F_BIN] = { .n = IST("bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
199 [ST_F_BOUT] = { .n = IST("bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
200 [ST_F_DREQ] = { .n = IST("requests_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC ) },
201 [ST_F_DRESP] = { .n = IST("responses_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
202 [ST_F_EREQ] = { .n = IST("request_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC ) },
203 [ST_F_ECON] = { .n = IST("connection_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
204 [ST_F_ERESP] = { .n = IST("response_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
205 [ST_F_WRETR] = { .n = IST("retry_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
206 [ST_F_WREDIS] = { .n = IST("redispatch_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
207 [ST_F_STATUS] = { .n = IST("status"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
208 [ST_F_WEIGHT] = { .n = IST("weight"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
209 [ST_F_ACT] = { .n = IST("active_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
210 [ST_F_BCK] = { .n = IST("backup_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
211 [ST_F_CHKFAIL] = { .n = IST("check_failures_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_SRV_METRIC) },
212 [ST_F_CHKDOWN] = { .n = IST("check_up_down_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
213 [ST_F_LASTCHG] = { .n = IST("check_last_change_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
214 [ST_F_DOWNTIME] = { .n = IST("downtime_seconds_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
215 [ST_F_QLIMIT] = { .n = IST("queue_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100216 //[ST_F_PID] ignored
217 //[ST_F_IID] ignored
218 //[ST_F_SID] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100219 [ST_F_THROTTLE] = { .n = IST("current_throttle"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
220 [ST_F_LBTOT] = { .n = IST("loadbalanced_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100221 //[ST_F_TRACKED] ignored
222 //[ST_F_TYPE] ignored
223 //[ST_F_RATE] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100224 [ST_F_RATE_LIM] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
225 [ST_F_RATE_MAX] = { .n = IST("max_session_rate"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
226 [ST_F_CHECK_STATUS] = { .n = IST("check_status"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
227 [ST_F_CHECK_CODE] = { .n = IST("check_code"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
228 [ST_F_CHECK_DURATION] = { .n = IST("check_duration_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
229 [ST_F_HRSP_1XX] = { .n = IST("http_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
230 [ST_F_HRSP_2XX] = { .n = IST("http_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
231 [ST_F_HRSP_3XX] = { .n = IST("http_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
232 [ST_F_HRSP_4XX] = { .n = IST("http_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
233 [ST_F_HRSP_5XX] = { .n = IST("http_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
234 [ST_F_HRSP_OTHER] = { .n = IST("http_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100235 //[ST_F_HANAFAIL] ignored
236 //[ST_F_REQ_RATE] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100237 [ST_F_REQ_RATE_MAX] = { .n = IST("http_requests_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
238 [ST_F_REQ_TOT] = { .n = IST("http_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
239 [ST_F_CLI_ABRT] = { .n = IST("client_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
240 [ST_F_SRV_ABRT] = { .n = IST("server_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
241 [ST_F_COMP_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
242 [ST_F_COMP_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
243 [ST_F_COMP_BYP] = { .n = IST("http_comp_bytes_bypassed_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
244 [ST_F_COMP_RSP] = { .n = IST("http_comp_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
245 [ST_F_LASTSESS] = { .n = IST("last_session_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Ilya Shipitsinacf84592021-02-06 22:29:08 +0500246 //[ST_F_LAST_CHK] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100247 //[ST_F_LAST_AGT] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100248 [ST_F_QTIME] = { .n = IST("queue_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
249 [ST_F_CTIME] = { .n = IST("connect_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
250 [ST_F_RTIME] = { .n = IST("response_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
251 [ST_F_TTIME] = { .n = IST("total_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100252 //[ST_F_AGENT_STATUS] ignored
253 //[ST_F_AGENT_CODE] ignored
254 //[ST_F_AGENT_DURATION] ignored
255 //[ST_F_CHECK_DESC] ignored
256 //[ST_F_AGENT_DESC] ignored
257 //[ST_F_CHECK_RISE] ignored
258 //[ST_F_CHECK_FALL] ignored
259 //[ST_F_CHECK_HEALTH] ignored
260 //[ST_F_AGENT_RISE] ignored
261 //[ST_F_AGENT_FALL] ignored
262 //[ST_F_AGENT_HEALTH] ignored
263 //[ST_F_ADDR] ignored
264 //[ST_F_COOKIE] ignored
265 //[ST_F_MODE] ignored
266 //[ST_F_ALGO] ignored
267 //[ST_F_CONN_RATE] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100268 [ST_F_CONN_RATE_MAX] = { .n = IST("connections_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
269 [ST_F_CONN_TOT] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
270 [ST_F_INTERCEPTED] = { .n = IST("intercepted_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
271 [ST_F_DCON] = { .n = IST("denied_connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC ) },
272 [ST_F_DSES] = { .n = IST("denied_sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC ) },
273 [ST_F_WREW] = { .n = IST("failed_header_rewriting_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
274 [ST_F_CONNECT] = { .n = IST("connection_attempts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
275 [ST_F_REUSE] = { .n = IST("connection_reuses_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
276 [ST_F_CACHE_LOOKUPS] = { .n = IST("http_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
277 [ST_F_CACHE_HITS] = { .n = IST("http_cache_hits_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
278 [ST_F_SRV_ICUR] = { .n = IST("idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
279 [ST_F_SRV_ILIM] = { .n = IST("idle_connections_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
280 [ST_F_QT_MAX] = { .n = IST("max_queue_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
281 [ST_F_CT_MAX] = { .n = IST("max_connect_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
282 [ST_F_RT_MAX] = { .n = IST("max_response_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
283 [ST_F_TT_MAX] = { .n = IST("max_total_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
284 [ST_F_EINT] = { .n = IST("internal_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
285 [ST_F_IDLE_CONN_CUR] = { .n = IST("unsafe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
286 [ST_F_SAFE_CONN_CUR] = { .n = IST("safe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
287 [ST_F_USED_CONN_CUR] = { .n = IST("used_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
288 [ST_F_NEED_CONN_EST] = { .n = IST("need_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
289 [ST_F_UWEIGHT] = { .n = IST("uweight"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Christopher Fauletf959d082019-02-07 15:38:42 +0100290};
291
Ilya Shipitsinacf84592021-02-06 22:29:08 +0500292/* Description of overridden stats fields */
Christopher Fauletf959d082019-02-07 15:38:42 +0100293const struct ist promex_st_metric_desc[ST_F_TOTAL_FIELDS] = {
William Dauchya1da7ba2021-02-01 13:11:52 +0100294 [ST_F_STATUS] = IST("Current status of the service, per state label value."),
William Dauchyde3c3262021-02-01 13:11:51 +0100295 [ST_F_CHECK_STATUS] = IST("Status of last health check, per state label value."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100296 [ST_F_CHECK_CODE] = IST("layer5-7 code, if available of the last health check."),
Christopher Faulet2711e512020-02-27 16:12:07 +0100297 [ST_F_CHECK_DURATION] = IST("Total duration of the latest server health check, in seconds."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100298 [ST_F_QTIME] = IST("Avg. queue time for last 1024 successful connections."),
299 [ST_F_CTIME] = IST("Avg. connect time for last 1024 successful connections."),
300 [ST_F_RTIME] = IST("Avg. response time for last 1024 successful connections."),
301 [ST_F_TTIME] = IST("Avg. total time for last 1024 successful connections."),
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100302 [ST_F_QT_MAX] = IST("Maximum observed time spent in the queue"),
303 [ST_F_CT_MAX] = IST("Maximum observed time spent waiting for a connection to complete"),
304 [ST_F_RT_MAX] = IST("Maximum observed time spent waiting for a server response"),
305 [ST_F_TT_MAX] = IST("Maximum observed total request+response time (request+queue+connect+response+processing)"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100306};
307
William Dauchy69164222021-02-07 20:42:38 +0100308/* stick table base fields */
309enum sticktable_field {
310 STICKTABLE_SIZE = 0,
311 STICKTABLE_USED,
312 /* must always be the last one */
313 STICKTABLE_TOTAL_FIELDS
314};
315
316const struct promex_metric promex_sticktable_metrics[STICKTABLE_TOTAL_FIELDS] = {
317 [STICKTABLE_SIZE] = { .n = IST("size"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_STICKTABLE_METRIC },
318 [STICKTABLE_USED] = { .n = IST("used"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_STICKTABLE_METRIC },
319};
320
321/* stick table base description */
322const struct ist promex_sticktable_metric_desc[STICKTABLE_TOTAL_FIELDS] = {
323 [STICKTABLE_SIZE] = IST("Stick table size."),
324 [STICKTABLE_USED] = IST("Number of entries used in this stick table."),
325};
326
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100327/* Specific labels for all ST_F_HRSP_* fields */
328const struct ist promex_hrsp_code[1 + ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = {
329 [ST_F_HRSP_1XX - ST_F_HRSP_1XX] = IST("1xx"),
330 [ST_F_HRSP_2XX - ST_F_HRSP_1XX] = IST("2xx"),
331 [ST_F_HRSP_3XX - ST_F_HRSP_1XX] = IST("3xx"),
332 [ST_F_HRSP_4XX - ST_F_HRSP_1XX] = IST("4xx"),
333 [ST_F_HRSP_5XX - ST_F_HRSP_1XX] = IST("5xx"),
334 [ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = IST("other"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100335};
336
William Dauchy54938212021-01-27 22:40:16 +0100337enum promex_front_state {
338 PROMEX_FRONT_STATE_DOWN = 0,
339 PROMEX_FRONT_STATE_UP,
340
341 PROMEX_FRONT_STATE_COUNT /* must be last */
342};
343
344const struct ist promex_front_st[PROMEX_FRONT_STATE_COUNT] = {
345 [PROMEX_FRONT_STATE_DOWN] = IST("DOWN"),
346 [PROMEX_FRONT_STATE_UP] = IST("UP"),
347};
348
349enum promex_back_state {
350 PROMEX_BACK_STATE_DOWN = 0,
351 PROMEX_BACK_STATE_UP,
352
353 PROMEX_BACK_STATE_COUNT /* must be last */
354};
355
356const struct ist promex_back_st[PROMEX_BACK_STATE_COUNT] = {
357 [PROMEX_BACK_STATE_DOWN] = IST("DOWN"),
358 [PROMEX_BACK_STATE_UP] = IST("UP"),
359};
360
361enum promex_srv_state {
362 PROMEX_SRV_STATE_DOWN = 0,
363 PROMEX_SRV_STATE_UP,
364 PROMEX_SRV_STATE_MAINT,
365 PROMEX_SRV_STATE_DRAIN,
366 PROMEX_SRV_STATE_NOLB,
367
368 PROMEX_SRV_STATE_COUNT /* must be last */
369};
370
371const struct ist promex_srv_st[PROMEX_SRV_STATE_COUNT] = {
372 [PROMEX_SRV_STATE_DOWN] = IST("DOWN"),
373 [PROMEX_SRV_STATE_UP] = IST("UP"),
374 [PROMEX_SRV_STATE_MAINT] = IST("MAINT"),
375 [PROMEX_SRV_STATE_DRAIN] = IST("DRAIN"),
376 [PROMEX_SRV_STATE_NOLB] = IST("NOLB"),
377};
378
379/* Return the server status. */
380enum promex_srv_state promex_srv_status(struct server *sv)
Christopher Fauletf959d082019-02-07 15:38:42 +0100381{
William Dauchy54938212021-01-27 22:40:16 +0100382 int state = PROMEX_SRV_STATE_DOWN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100383
Christopher Fauletf959d082019-02-07 15:38:42 +0100384 if (sv->cur_state == SRV_ST_RUNNING || sv->cur_state == SRV_ST_STARTING) {
William Dauchy54938212021-01-27 22:40:16 +0100385 state = PROMEX_SRV_STATE_UP;
Christopher Fauletf959d082019-02-07 15:38:42 +0100386 if (sv->cur_admin & SRV_ADMF_DRAIN)
William Dauchy54938212021-01-27 22:40:16 +0100387 state = PROMEX_SRV_STATE_DRAIN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100388 }
Christopher Fauletd45d1052019-09-06 16:10:19 +0200389 else if (sv->cur_state == SRV_ST_STOPPING)
William Dauchy54938212021-01-27 22:40:16 +0100390 state = PROMEX_SRV_STATE_NOLB;
Christopher Fauletd45d1052019-09-06 16:10:19 +0200391
392 if (sv->cur_admin & SRV_ADMF_MAINT)
William Dauchy54938212021-01-27 22:40:16 +0100393 state = PROMEX_SRV_STATE_MAINT;
Christopher Fauletf959d082019-02-07 15:38:42 +0100394
395 return state;
396}
397
398/* Convert a field to its string representation and write it in <out>, followed
399 * by a newline, if there is enough space. non-numeric value are converted in
William Dauchy18a2c6e2021-01-22 21:09:47 +0100400 * "NaN" because Prometheus only support numerical values (but it is unexepceted
Christopher Fauletf959d082019-02-07 15:38:42 +0100401 * to process this kind of value). It returns 1 on success. Otherwise, it
402 * returns 0. The buffer's length must not exceed <max> value.
403 */
404static int promex_metric_to_str(struct buffer *out, struct field *f, size_t max)
405{
406 int ret = 0;
407
408 switch (field_format(f, 0)) {
William Dauchy18a2c6e2021-01-22 21:09:47 +0100409 case FF_EMPTY: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100410 case FF_S32: ret = chunk_appendf(out, "%d\n", f->u.s32); break;
411 case FF_U32: ret = chunk_appendf(out, "%u\n", f->u.u32); break;
412 case FF_S64: ret = chunk_appendf(out, "%lld\n", (long long)f->u.s64); break;
413 case FF_U64: ret = chunk_appendf(out, "%llu\n", (unsigned long long)f->u.u64); break;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200414 case FF_FLT: ret = chunk_appendf(out, "%f\n", f->u.flt); break;
William Dauchy18a2c6e2021-01-22 21:09:47 +0100415 case FF_STR: ret = chunk_strcat(out, "NaN\n"); break;
416 default: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100417 }
418 if (!ret || out->data > max)
419 return 0;
420 return 1;
421}
422
Christopher Fauletf959d082019-02-07 15:38:42 +0100423/* Dump the header lines for <metric>. It is its #HELP and #TYPE strings. It
424 * returns 1 on success. Otherwise, if <out> length exceeds <max>, it returns 0.
425 */
426static int promex_dump_metric_header(struct appctx *appctx, struct htx *htx,
Christopher Faulet37286a52021-01-20 15:20:53 +0100427 const struct promex_metric *metric, const struct ist name,
428 struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100429{
Christopher Faulet37286a52021-01-20 15:20:53 +0100430 struct ist type;
William Dauchy82b2ce22021-02-01 13:11:55 +0100431 struct ist desc;
Christopher Faulet37286a52021-01-20 15:20:53 +0100432
433 switch (metric->type) {
434 case PROMEX_MT_COUNTER:
435 type = ist("counter");
436 break;
437 default:
438 type = ist("gauge");
439 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100440
William Dauchya191b772021-01-15 22:41:39 +0100441 if (istcat(out, ist("# HELP "), max) == -1 ||
442 istcat(out, name, max) == -1 ||
443 istcat(out, ist(" "), max) == -1)
444 goto full;
445
William Dauchy82b2ce22021-02-01 13:11:55 +0100446 if (metric->flags & PROMEX_FL_INFO_METRIC)
447 desc = ist(info_fields[appctx->st2].desc);
William Dauchy69164222021-02-07 20:42:38 +0100448 else if (metric->flags & PROMEX_FL_STICKTABLE_METRIC)
449 desc = promex_sticktable_metric_desc[appctx->st2];
William Dauchy82b2ce22021-02-01 13:11:55 +0100450 else if (!isttest(promex_st_metric_desc[appctx->st2]))
451 desc = ist(stat_fields[appctx->st2].desc);
452 else
453 desc = promex_st_metric_desc[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100454
William Dauchy82b2ce22021-02-01 13:11:55 +0100455 if (istcat(out, desc, max) == -1 ||
456 istcat(out, ist("\n# TYPE "), max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100457 istcat(out, name, max) == -1 ||
458 istcat(out, ist(" "), max) == -1 ||
Christopher Faulet37286a52021-01-20 15:20:53 +0100459 istcat(out, type, max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100460 istcat(out, ist("\n"), max) == -1)
461 goto full;
462
463 return 1;
464
465 full:
466 return 0;
467}
468
469/* Dump the line for <metric>. It starts by the metric name followed by its
470 * labels (proxy name, server name...) between braces and finally its value. If
471 * not already done, the header lines are dumped first. It returns 1 on
472 * success. Otherwise if <out> length exceeds <max>, it returns 0.
473 */
Christopher Faulet37286a52021-01-20 15:20:53 +0100474static int promex_dump_metric(struct appctx *appctx, struct htx *htx, struct ist prefix,
William Dauchyc6464592021-01-27 22:40:17 +0100475 const struct promex_metric *metric, struct field *val,
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100476 struct promex_label *labels, struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100477{
478 struct ist name = { .ptr = (char[PROMEX_MAX_NAME_LEN]){ 0 }, .len = 0 };
479 size_t len = out->len;
480
481 if (out->len + PROMEX_MAX_METRIC_LENGTH > max)
482 return 0;
483
Christopher Faulet37286a52021-01-20 15:20:53 +0100484 /* Fill the metric name */
485 istcat(&name, prefix, PROMEX_MAX_NAME_LEN);
486 istcat(&name, metric->n, PROMEX_MAX_NAME_LEN);
487
488
Christopher Fauletf959d082019-02-07 15:38:42 +0100489 if ((appctx->ctx.stats.flags & PROMEX_FL_METRIC_HDR) &&
Christopher Faulet37286a52021-01-20 15:20:53 +0100490 !promex_dump_metric_header(appctx, htx, metric, name, out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100491 goto full;
492
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100493 if (istcat(out, name, max) == -1)
494 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100495
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100496 if (isttest(labels[0].name)) {
497 int i;
498
499 if (istcat(out, ist("{"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100500 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100501
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100502 for (i = 0; isttest(labels[i].name); i++) {
503 if (!isttest(labels[i].value))
504 continue;
505
506 if ((i && istcat(out, ist(","), max) == -1) ||
507 istcat(out, labels[i].name, max) == -1 ||
508 istcat(out, ist("=\""), max) == -1 ||
509 istcat(out, labels[i].value, max) == -1 ||
510 istcat(out, ist("\""), max) == -1)
511 goto full;
512 }
513
514 if (istcat(out, ist("}"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100515 goto full;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100516
Christopher Fauletf959d082019-02-07 15:38:42 +0100517 }
518
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100519 if (istcat(out, ist(" "), max) == -1)
520 goto full;
521
Christopher Fauletf959d082019-02-07 15:38:42 +0100522 trash.data = out->len;
Christopher Faulet37286a52021-01-20 15:20:53 +0100523 if (!promex_metric_to_str(&trash, val, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100524 goto full;
525 out->len = trash.data;
526
527 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
528 return 1;
529 full:
530 // Restore previous length
531 out->len = len;
532 return 0;
533
534}
535
536
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500537/* Dump global metrics (prefixed by "haproxy_process_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100538 * 0 if <htx> is full and -1 in case of any error. */
539static int promex_dump_global_metrics(struct appctx *appctx, struct htx *htx)
540{
541 static struct ist prefix = IST("haproxy_process_");
Christopher Faulet37286a52021-01-20 15:20:53 +0100542 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100543 struct channel *chn = si_ic(appctx->owner);
544 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200545 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
Christopher Fauletf959d082019-02-07 15:38:42 +0100546 int ret = 1;
547
William Dauchy5d9b8f32021-01-11 20:07:49 +0100548 if (!stats_fill_info(info, INF_TOTAL_FIELDS))
549 return -1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100550
Christopher Faulet37286a52021-01-20 15:20:53 +0100551 for (; appctx->st2 < INF_TOTAL_FIELDS; appctx->st2++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100552 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
553
Christopher Faulet37286a52021-01-20 15:20:53 +0100554 if (!(promex_global_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
555 continue;
556
Christopher Fauletf959d082019-02-07 15:38:42 +0100557 switch (appctx->st2) {
William Dauchy5a982a72021-01-08 13:18:06 +0100558 case INF_BUILD_INFO:
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100559 labels[0].name = ist("version");
560 labels[0].value = ist(HAPROXY_VERSION);
Christopher Faulet37286a52021-01-20 15:20:53 +0100561 val = mkf_u32(FN_GAUGE, 1);
William Dauchy5a982a72021-01-08 13:18:06 +0100562 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100563
564 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100565 val = info[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100566 }
567
William Dauchyc6464592021-01-27 22:40:17 +0100568 if (!promex_dump_metric(appctx, htx, prefix, &promex_global_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100569 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100570 goto full;
571
Christopher Fauletf959d082019-02-07 15:38:42 +0100572 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Christopher Fauletf959d082019-02-07 15:38:42 +0100573 }
574
575 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200576 if (out.len) {
577 if (!htx_add_data_atonce(htx, out))
578 return -1; /* Unexpected and unrecoverable error */
579 channel_add_input(chn, out.len);
580 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100581 return ret;
582 full:
583 ret = 0;
584 goto end;
585}
586
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500587/* Dump frontends metrics (prefixed by "haproxy_frontend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100588 * 0 if <htx> is full and -1 in case of any error. */
589static int promex_dump_front_metrics(struct appctx *appctx, struct htx *htx)
590{
591 static struct ist prefix = IST("haproxy_frontend_");
592 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100593 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100594 struct channel *chn = si_ic(appctx->owner);
595 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200596 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchyb9577452021-01-17 18:27:46 +0100597 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100598 int ret = 1;
William Dauchyc6464592021-01-27 22:40:17 +0100599 enum promex_front_state state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100600
Christopher Faulet37286a52021-01-20 15:20:53 +0100601 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
602 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
603 continue;
604
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200605 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100606 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
607
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200608 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100609
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100610 labels[0].name = ist("proxy");
611 labels[0].value = ist2(px->id, strlen(px->id));
612
Christopher Fauletf959d082019-02-07 15:38:42 +0100613 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200614 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_FE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100615 goto next_px;
616
William Dauchyb9577452021-01-17 18:27:46 +0100617 if (!stats_fill_fe_stats(px, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
618 return -1;
619
Christopher Fauletf959d082019-02-07 15:38:42 +0100620 switch (appctx->st2) {
621 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100622 state = !px->disabled;
Christopher Faulet040b1192021-02-01 15:05:21 +0100623 for (; appctx->ctx.stats.st_code < PROMEX_FRONT_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100624 labels[1].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100625 labels[1].value = promex_front_st[appctx->ctx.stats.st_code];
626 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
William Dauchyc6464592021-01-27 22:40:17 +0100627 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100628 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100629 goto full;
630 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100631 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100632 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100633 case ST_F_REQ_RATE_MAX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100634 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100635 case ST_F_INTERCEPTED:
Christopher Fauletf959d082019-02-07 15:38:42 +0100636 case ST_F_CACHE_LOOKUPS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100637 case ST_F_CACHE_HITS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100638 case ST_F_COMP_IN:
Christopher Fauletf959d082019-02-07 15:38:42 +0100639 case ST_F_COMP_OUT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100640 case ST_F_COMP_BYP:
William Dauchyb9577452021-01-17 18:27:46 +0100641 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100642 if (px->mode != PR_MODE_HTTP)
643 goto next_px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100644 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100645 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100646 case ST_F_HRSP_1XX:
William Dauchyb9577452021-01-17 18:27:46 +0100647 case ST_F_HRSP_2XX:
648 case ST_F_HRSP_3XX:
649 case ST_F_HRSP_4XX:
650 case ST_F_HRSP_5XX:
651 case ST_F_HRSP_OTHER:
Christopher Fauletf959d082019-02-07 15:38:42 +0100652 if (px->mode != PR_MODE_HTTP)
653 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100654 if (appctx->st2 != ST_F_HRSP_1XX)
655 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100656 labels[1].name = ist("code");
657 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
658 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100659 break;
660
661 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100662 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100663 }
664
William Dauchyc6464592021-01-27 22:40:17 +0100665 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100666 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100667 goto full;
668 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200669 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100670 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100671 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200672 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100673 }
674
675 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200676 if (out.len) {
677 if (!htx_add_data_atonce(htx, out))
678 return -1; /* Unexpected and unrecoverable error */
679 channel_add_input(chn, out.len);
680 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100681 return ret;
682 full:
683 ret = 0;
684 goto end;
685}
686
William Dauchye3f7bd52021-02-14 23:22:56 +0100687/* Dump listener metrics (prefixed by "haproxy_listen_"). It returns 1 on
688 * success, 0 if <htx> is full and -1 in case of any error. */
689static int promex_dump_listener_metrics(struct appctx *appctx, struct htx *htx)
690{
691 static struct ist prefix = IST("haproxy_listener_");
692 struct proxy *px;
693 struct field val;
694 struct channel *chn = si_ic(appctx->owner);
695 struct ist out = ist2(trash.area, 0);
696 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
697 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
698 struct listener *li;
699 int ret = 1;
700 enum li_status status;
701
702 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
703 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
704 continue;
705
706 while (appctx->ctx.stats.obj1) {
707 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
708
709 px = appctx->ctx.stats.obj1;
710
711 labels[0].name = ist("proxy");
712 labels[0].value = ist2(px->id, strlen(px->id));
713
714 /* skip the disabled proxies, global frontend and non-networked ones */
715 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_FE))
716 goto next_px;
717
718 li = appctx->ctx.stats.obj2;
719 list_for_each_entry_from(li, &px->conf.listeners, by_fe) {
720
721 labels[1].name = ist("listener");
722 labels[1].value = ist2(li->name, strlen(li->name));
723
724 if (!li->counters)
725 continue;
726
727 if (!stats_fill_li_stats(px, li, 0, stats,
728 ST_F_TOTAL_FIELDS, &(appctx->st2)))
729 return -1;
730
731 switch (appctx->st2) {
732 case ST_F_STATUS:
733 status = get_li_status(li);
734 for (; appctx->ctx.stats.st_code < LI_STATE_COUNT; appctx->ctx.stats.st_code++) {
735 val = mkf_u32(FO_STATUS, status == appctx->ctx.stats.st_code);
736 labels[2].name = ist("state");
737 labels[2].value = ist(li_status_st[appctx->ctx.stats.st_code]);
738 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
739 &val, labels, &out, max))
740 goto full;
741 }
742 appctx->ctx.stats.st_code = 0;
743 continue;
744 default:
745 val = stats[appctx->st2];
746 }
747
748 if (!promex_dump_metric(appctx, htx, prefix,
749 &promex_st_metrics[appctx->st2],
750 &val, labels, &out, max))
751 goto full;
752 }
753
754 next_px:
755 px = px->next;
756 appctx->ctx.stats.obj1 = px;
757 appctx->ctx.stats.obj2 = (px ? LIST_NEXT(&px->conf.listeners, struct listener *, by_fe) : NULL);
758 }
759 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
760 appctx->ctx.stats.obj1 = proxies_list;
761 appctx->ctx.stats.obj2 = LIST_NEXT(&proxies_list->conf.listeners, struct listener *, by_fe);
762 }
763
764 end:
765 if (out.len) {
766 if (!htx_add_data_atonce(htx, out))
767 return -1; /* Unexpected and unrecoverable error */
768 channel_add_input(chn, out.len);
769 }
770 return ret;
771 full:
772 appctx->ctx.stats.obj2 = li;
773 ret = 0;
774 goto end;
775}
776
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500777/* Dump backends metrics (prefixed by "haproxy_backend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100778 * 0 if <htx> is full and -1 in case of any error. */
779static int promex_dump_back_metrics(struct appctx *appctx, struct htx *htx)
780{
781 static struct ist prefix = IST("haproxy_backend_");
782 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100783 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100784 struct channel *chn = si_ic(appctx->owner);
785 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200786 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchy3c6f0062021-01-25 17:29:02 +0100787 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100788 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200789 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100790 enum promex_back_state state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100791
Christopher Faulet37286a52021-01-20 15:20:53 +0100792 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
793 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
794 continue;
795
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200796 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100797 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
798
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200799 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100800
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100801 labels[0].name = ist("proxy");
802 labels[0].value = ist2(px->id, strlen(px->id));
803
Christopher Fauletf959d082019-02-07 15:38:42 +0100804 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200805 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100806 goto next_px;
807
William Dauchy3c6f0062021-01-25 17:29:02 +0100808 if (!stats_fill_be_stats(px, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
809 return -1;
810
Christopher Fauletf959d082019-02-07 15:38:42 +0100811 switch (appctx->st2) {
812 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100813 state = ((px->lbprm.tot_weight > 0 || !px->srv) ? 1 : 0);
Christopher Faulet040b1192021-02-01 15:05:21 +0100814 for (; appctx->ctx.stats.st_code < PROMEX_BACK_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100815 labels[1].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100816 labels[1].value = promex_back_st[appctx->ctx.stats.st_code];
817 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
William Dauchyc6464592021-01-27 22:40:17 +0100818 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100819 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100820 goto full;
821 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100822 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100823 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100824 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200825 secs = (double)swrate_avg(px->be_counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100826 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100827 break;
828 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200829 secs = (double)swrate_avg(px->be_counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100830 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100831 break;
832 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200833 secs = (double)swrate_avg(px->be_counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100834 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100835 break;
836 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200837 secs = (double)swrate_avg(px->be_counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100838 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100839 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100840 case ST_F_QT_MAX:
841 secs = (double)px->be_counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100842 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100843 break;
844 case ST_F_CT_MAX:
845 secs = (double)px->be_counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100846 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100847 break;
848 case ST_F_RT_MAX:
849 secs = (double)px->be_counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100850 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100851 break;
852 case ST_F_TT_MAX:
853 secs = (double)px->be_counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100854 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100855 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100856 case ST_F_REQ_TOT:
William Dauchy3c6f0062021-01-25 17:29:02 +0100857 case ST_F_CACHE_LOOKUPS:
858 case ST_F_CACHE_HITS:
859 case ST_F_COMP_IN:
860 case ST_F_COMP_OUT:
861 case ST_F_COMP_BYP:
862 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100863 if (px->mode != PR_MODE_HTTP)
864 goto next_px;
William Dauchy3c6f0062021-01-25 17:29:02 +0100865 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100866 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100867 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100868 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100869 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100870 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100871 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100872 case ST_F_HRSP_OTHER:
873 if (px->mode != PR_MODE_HTTP)
874 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100875 if (appctx->st2 != ST_F_HRSP_1XX)
876 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100877 labels[1].name = ist("code");
878 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchy3c6f0062021-01-25 17:29:02 +0100879 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100880 break;
881
882 default:
William Dauchy3c6f0062021-01-25 17:29:02 +0100883 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100884 }
885
William Dauchy3c6f0062021-01-25 17:29:02 +0100886 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100887 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100888 goto full;
889 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200890 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100891 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100892 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200893 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100894 }
895
896 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200897 if (out.len) {
898 if (!htx_add_data_atonce(htx, out))
899 return -1; /* Unexpected and unrecoverable error */
900 channel_add_input(chn, out.len);
901 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100902 return ret;
903 full:
904 ret = 0;
905 goto end;
906}
907
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500908/* Dump servers metrics (prefixed by "haproxy_server_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100909 * 0 if <htx> is full and -1 in case of any error. */
910static int promex_dump_srv_metrics(struct appctx *appctx, struct htx *htx)
911{
912 static struct ist prefix = IST("haproxy_server_");
913 struct proxy *px;
914 struct server *sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100915 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100916 struct channel *chn = si_ic(appctx->owner);
917 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200918 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchybde2bf62021-01-25 17:29:04 +0100919 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100920 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200921 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100922 enum promex_srv_state state;
William Dauchyde3c3262021-02-01 13:11:51 +0100923 const char *check_state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100924
Christopher Faulet37286a52021-01-20 15:20:53 +0100925 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
926 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
927 continue;
928
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200929 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100930 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
931
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200932 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100933
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100934 labels[0].name = ist("proxy");
935 labels[0].value = ist2(px->id, strlen(px->id));
936
Christopher Fauletf959d082019-02-07 15:38:42 +0100937 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200938 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100939 goto next_px;
940
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200941 while (appctx->ctx.stats.obj2) {
942 sv = appctx->ctx.stats.obj2;
Christopher Fauletf959d082019-02-07 15:38:42 +0100943
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100944 labels[1].name = ist("server");
945 labels[1].value = ist2(sv->id, strlen(sv->id));
946
William Dauchybde2bf62021-01-25 17:29:04 +0100947 if (!stats_fill_sv_stats(px, sv, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
948 return -1;
949
Christopher Fauleteba22942019-11-19 14:18:24 +0100950 if ((appctx->ctx.stats.flags & PROMEX_FL_NO_MAINT_SRV) && (sv->cur_admin & SRV_ADMF_MAINT))
951 goto next_sv;
952
Christopher Fauletf959d082019-02-07 15:38:42 +0100953 switch (appctx->st2) {
954 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100955 state = promex_srv_status(sv);
William Dauchy64a38052021-02-14 22:26:24 +0100956 for (; appctx->ctx.stats.st_code < PROMEX_SRV_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet040b1192021-02-01 15:05:21 +0100957 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100958 labels[2].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100959 labels[2].value = promex_srv_st[appctx->ctx.stats.st_code];
William Dauchyc6464592021-01-27 22:40:17 +0100960 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100961 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100962 goto full;
963 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100964 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100965 goto next_sv;
Christopher Fauletf959d082019-02-07 15:38:42 +0100966 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200967 secs = (double)swrate_avg(sv->counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100968 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100969 break;
970 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200971 secs = (double)swrate_avg(sv->counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100972 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100973 break;
974 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200975 secs = (double)swrate_avg(sv->counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100976 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100977 break;
978 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200979 secs = (double)swrate_avg(sv->counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100980 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100981 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100982 case ST_F_QT_MAX:
983 secs = (double)sv->counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100984 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100985 break;
986 case ST_F_CT_MAX:
987 secs = (double)sv->counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100988 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100989 break;
990 case ST_F_RT_MAX:
991 secs = (double)sv->counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100992 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100993 break;
994 case ST_F_TT_MAX:
995 secs = (double)sv->counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100996 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100997 break;
Christopher Fauletcf403f32019-11-21 14:35:46 +0100998 case ST_F_CHECK_STATUS:
999 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
1000 goto next_sv;
William Dauchyde3c3262021-02-01 13:11:51 +01001001
Christopher Faulet040b1192021-02-01 15:05:21 +01001002 for (; appctx->ctx.stats.st_code < HCHK_STATUS_SIZE; appctx->ctx.stats.st_code++) {
1003 if (get_check_status_result(appctx->ctx.stats.st_code) < CHK_RES_FAILED)
William Dauchyde3c3262021-02-01 13:11:51 +01001004 continue;
Christopher Faulet040b1192021-02-01 15:05:21 +01001005 val = mkf_u32(FO_STATUS, sv->check.status == appctx->ctx.stats.st_code);
1006 check_state = get_check_status_info(appctx->ctx.stats.st_code);
William Dauchyde3c3262021-02-01 13:11:51 +01001007 labels[2].name = ist("state");
1008 labels[2].value = ist2(check_state, strlen(check_state));
1009 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
1010 &val, labels, &out, max))
1011 goto full;
1012 }
Christopher Faulet040b1192021-02-01 15:05:21 +01001013 appctx->ctx.stats.st_code = 0;
William Dauchyde3c3262021-02-01 13:11:51 +01001014 goto next_sv;
Christopher Fauletcf403f32019-11-21 14:35:46 +01001015 case ST_F_CHECK_CODE:
1016 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
1017 goto next_sv;
Christopher Faulet37286a52021-01-20 15:20:53 +01001018 val = mkf_u32(FN_OUTPUT, (sv->check.status < HCHK_STATUS_L57DATA) ? 0 : sv->check.code);
Christopher Fauletcf403f32019-11-21 14:35:46 +01001019 break;
Christopher Faulet2711e512020-02-27 16:12:07 +01001020 case ST_F_CHECK_DURATION:
1021 if (sv->check.status < HCHK_STATUS_CHECKED)
1022 goto next_sv;
1023 secs = (double)sv->check.duration / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001024 val = mkf_flt(FN_DURATION, secs);
Christopher Faulet2711e512020-02-27 16:12:07 +01001025 break;
Marcin Deranek3c27dda2020-05-15 18:32:51 +02001026 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +01001027 if (px->mode != PR_MODE_HTTP)
1028 goto next_px;
William Dauchybde2bf62021-01-25 17:29:04 +01001029 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +01001030 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +01001031 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001032 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001033 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001034 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001035 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001036 case ST_F_HRSP_OTHER:
1037 if (px->mode != PR_MODE_HTTP)
1038 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +01001039 if (appctx->st2 != ST_F_HRSP_1XX)
1040 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +01001041 labels[2].name = ist("code");
1042 labels[2].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchybde2bf62021-01-25 17:29:04 +01001043 val = stats[appctx->st2];
Christopher Fauletc55a6262020-07-10 15:39:39 +02001044 break;
Christopher Fauletf959d082019-02-07 15:38:42 +01001045
1046 default:
William Dauchybde2bf62021-01-25 17:29:04 +01001047 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +01001048 }
1049
William Dauchyc6464592021-01-27 22:40:17 +01001050 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +01001051 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +01001052 goto full;
Christopher Fauleteba22942019-11-19 14:18:24 +01001053 next_sv:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001054 appctx->ctx.stats.obj2 = sv->next;
Christopher Fauletf959d082019-02-07 15:38:42 +01001055 }
1056
1057 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001058 appctx->ctx.stats.obj1 = px->next;
1059 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +01001060 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001061 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001062 appctx->ctx.stats.obj1 = proxies_list;
1063 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +01001064 }
1065
1066
1067 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +02001068 if (out.len) {
1069 if (!htx_add_data_atonce(htx, out))
1070 return -1; /* Unexpected and unrecoverable error */
1071 channel_add_input(chn, out.len);
1072 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001073 return ret;
1074 full:
1075 ret = 0;
1076 goto end;
1077}
1078
William Dauchy69164222021-02-07 20:42:38 +01001079/* Dump stick table metrics (prefixed by "haproxy_sticktable_"). It returns 1 on success,
1080 * 0 if <htx> is full and -1 in case of any error. */
1081static int promex_dump_sticktable_metrics(struct appctx *appctx, struct htx *htx)
1082{
1083 static struct ist prefix = IST("haproxy_sticktable_");
1084 struct field val;
1085 struct channel *chn = si_ic(appctx->owner);
1086 struct ist out = ist2(trash.area, 0);
1087 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
1088 int ret = 1;
1089 struct stktable *t;
1090
1091 for (; appctx->st2 < STICKTABLE_TOTAL_FIELDS; appctx->st2++) {
1092 if (!(promex_sticktable_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
1093 continue;
1094
1095 while (appctx->ctx.stats.obj1) {
1096 struct promex_label labels[PROMEX_MAX_LABELS - 1] = {};
1097
1098 t = appctx->ctx.stats.obj1;
1099 if (!t->size)
1100 goto next_px;
1101
1102 labels[0].name = ist("name");
1103 labels[0].value = ist2(t->id, strlen(t->id));
1104 labels[1].name = ist("type");
1105 labels[1].value = ist2(stktable_types[t->type].kw, strlen(stktable_types[t->type].kw));
1106 switch (appctx->st2) {
1107 case STICKTABLE_SIZE:
1108 val = mkf_u32(FN_GAUGE, t->size);
1109 break;
1110 case STICKTABLE_USED:
1111 val = mkf_u32(FN_GAUGE, t->current);
1112 break;
1113 default:
1114 goto next_px;
1115 }
1116
1117 if (!promex_dump_metric(appctx, htx, prefix,
1118 &promex_sticktable_metrics[appctx->st2],
1119 &val, labels, &out, max))
1120 goto full;
1121
1122 next_px:
1123 appctx->ctx.stats.obj1 = t->next;
1124 }
1125 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
1126 appctx->ctx.stats.obj1 = stktables_list;
1127 }
1128
1129 end:
1130 if (out.len) {
1131 if (!htx_add_data_atonce(htx, out))
1132 return -1; /* Unexpected and unrecoverable error */
1133 channel_add_input(chn, out.len);
1134 }
1135 return ret;
1136 full:
1137 ret = 0;
1138 goto end;
1139}
1140
Christopher Fauletf959d082019-02-07 15:38:42 +01001141/* Dump all metrics (global, frontends, backends and servers) depending on the
1142 * dumper state (appctx->st1). It returns 1 on success, 0 if <htx> is full and
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001143 * -1 in case of any error.
1144 * Uses <appctx.ctx.stats.obj1> as a pointer to the current proxy and <obj2> as
1145 * a pointer to the current server/listener. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001146static int promex_dump_metrics(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1147{
1148 int ret;
1149
1150 switch (appctx->st1) {
1151 case PROMEX_DUMPER_INIT:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001152 appctx->ctx.stats.obj1 = NULL;
1153 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001154 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_INFO_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001155 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001156 appctx->st2 = INF_NAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001157 appctx->st1 = PROMEX_DUMPER_GLOBAL;
1158 /* fall through */
1159
1160 case PROMEX_DUMPER_GLOBAL:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001161 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_GLOBAL) {
1162 ret = promex_dump_global_metrics(appctx, htx);
1163 if (ret <= 0) {
1164 if (ret == -1)
1165 goto error;
1166 goto full;
1167 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001168 }
1169
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001170 appctx->ctx.stats.obj1 = proxies_list;
1171 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001172 appctx->ctx.stats.flags &= ~PROMEX_FL_INFO_METRIC;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001173 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_FRONT_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001174 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001175 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001176 appctx->st1 = PROMEX_DUMPER_FRONT;
1177 /* fall through */
1178
1179 case PROMEX_DUMPER_FRONT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001180 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_FRONT) {
1181 ret = promex_dump_front_metrics(appctx, htx);
1182 if (ret <= 0) {
1183 if (ret == -1)
1184 goto error;
1185 goto full;
1186 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001187 }
1188
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001189 appctx->ctx.stats.obj1 = proxies_list;
William Dauchye3f7bd52021-02-14 23:22:56 +01001190 appctx->ctx.stats.obj2 = LIST_NEXT(&proxies_list->conf.listeners, struct listener *, by_fe);
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001191 appctx->ctx.stats.flags &= ~PROMEX_FL_FRONT_METRIC;
William Dauchye3f7bd52021-02-14 23:22:56 +01001192 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_LI_METRIC);
1193 appctx->ctx.stats.st_code = 0;
1194 appctx->st2 = ST_F_PXNAME;
1195 appctx->st1 = PROMEX_DUMPER_LI;
1196 /* fall through */
1197
1198 case PROMEX_DUMPER_LI:
1199 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_LI) {
1200 ret = promex_dump_listener_metrics(appctx, htx);
1201 if (ret <= 0) {
1202 if (ret == -1)
1203 goto error;
1204 goto full;
1205 }
1206 }
1207
1208 appctx->ctx.stats.obj1 = proxies_list;
1209 appctx->ctx.stats.obj2 = NULL;
1210 appctx->ctx.stats.flags &= ~PROMEX_FL_LI_METRIC;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001211 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_BACK_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001212 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001213 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001214 appctx->st1 = PROMEX_DUMPER_BACK;
1215 /* fall through */
1216
1217 case PROMEX_DUMPER_BACK:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001218 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_BACK) {
1219 ret = promex_dump_back_metrics(appctx, htx);
1220 if (ret <= 0) {
1221 if (ret == -1)
1222 goto error;
1223 goto full;
1224 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001225 }
1226
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001227 appctx->ctx.stats.obj1 = proxies_list;
1228 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001229 appctx->ctx.stats.flags &= ~PROMEX_FL_BACK_METRIC;
1230 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001231 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001232 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001233 appctx->st1 = PROMEX_DUMPER_SRV;
1234 /* fall through */
1235
1236 case PROMEX_DUMPER_SRV:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001237 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_SERVER) {
1238 ret = promex_dump_srv_metrics(appctx, htx);
1239 if (ret <= 0) {
1240 if (ret == -1)
1241 goto error;
1242 goto full;
1243 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001244 }
1245
William Dauchy69164222021-02-07 20:42:38 +01001246 appctx->ctx.stats.obj1 = stktables_list;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001247 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001248 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
William Dauchy69164222021-02-07 20:42:38 +01001249 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_STICKTABLE_METRIC);
1250 appctx->st2 = STICKTABLE_SIZE;
1251 appctx->st1 = PROMEX_DUMPER_STICKTABLE;
1252 /* fall through */
1253
1254 case PROMEX_DUMPER_STICKTABLE:
1255 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_STICKTABLE) {
1256 ret = promex_dump_sticktable_metrics(appctx, htx);
1257 if (ret <= 0) {
1258 if (ret == -1)
1259 goto error;
1260 goto full;
1261 }
1262 }
1263
1264 appctx->ctx.stats.obj1 = NULL;
1265 appctx->ctx.stats.obj2 = NULL;
1266 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_STICKTABLE_METRIC);
Christopher Fauletf959d082019-02-07 15:38:42 +01001267 appctx->st2 = 0;
1268 appctx->st1 = PROMEX_DUMPER_DONE;
1269 /* fall through */
1270
1271 case PROMEX_DUMPER_DONE:
1272 default:
1273 break;
1274 }
1275
1276 return 1;
1277
1278 full:
1279 si_rx_room_blk(si);
1280 return 0;
1281 error:
1282 /* unrecoverable error */
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001283 appctx->ctx.stats.obj1 = NULL;
1284 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletf959d082019-02-07 15:38:42 +01001285 appctx->ctx.stats.flags = 0;
1286 appctx->st2 = 0;
1287 appctx->st1 = PROMEX_DUMPER_DONE;
1288 return -1;
1289}
1290
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001291/* Parse the query string of request URI to filter the metrics. It returns 1 on
Christopher Faulet78407ce2019-11-18 14:47:08 +01001292 * success and -1 on error. */
1293static int promex_parse_uri(struct appctx *appctx, struct stream_interface *si)
1294{
1295 struct channel *req = si_oc(si);
1296 struct channel *res = si_ic(si);
1297 struct htx *req_htx, *res_htx;
1298 struct htx_sl *sl;
William Dauchyc65f6562019-11-26 12:56:26 +01001299 char *p, *key, *value;
1300 const char *end;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001301 struct buffer *err;
1302 int default_scopes = PROMEX_FL_SCOPE_ALL;
1303 int len;
1304
1305 /* Get the query-string */
1306 req_htx = htxbuf(&req->buf);
1307 sl = http_get_stline(req_htx);
1308 if (!sl)
1309 goto error;
1310 p = http_find_param_list(HTX_SL_REQ_UPTR(sl), HTX_SL_REQ_ULEN(sl), '?');
1311 if (!p)
1312 goto end;
1313 end = HTX_SL_REQ_UPTR(sl) + HTX_SL_REQ_ULEN(sl);
Christopher Faulet78407ce2019-11-18 14:47:08 +01001314
William Dauchyc65f6562019-11-26 12:56:26 +01001315 /* copy the query-string */
1316 len = end - p;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001317 chunk_reset(&trash);
1318 memcpy(trash.area, p, len);
1319 trash.area[len] = 0;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001320 p = trash.area;
William Dauchyc65f6562019-11-26 12:56:26 +01001321 end = trash.area + len;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001322
1323 /* Parse the query-string */
William Dauchyc65f6562019-11-26 12:56:26 +01001324 while (p < end && *p && *p != '#') {
1325 value = NULL;
1326
1327 /* decode parameter name */
1328 key = p;
1329 while (p < end && *p != '=' && *p != '&' && *p != '#')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001330 ++p;
William Dauchyc65f6562019-11-26 12:56:26 +01001331 /* found a value */
1332 if (*p == '=') {
1333 *(p++) = 0;
1334 value = p;
1335 }
1336 else if (*p == '&')
1337 *(p++) = 0;
1338 else if (*p == '#')
1339 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001340 len = url_decode(key, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001341 if (len == -1)
1342 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001343
William Dauchyc65f6562019-11-26 12:56:26 +01001344 /* decode value */
1345 if (value) {
1346 while (p < end && *p != '=' && *p != '&' && *p != '#')
1347 ++p;
1348 if (*p == '=')
1349 goto error;
1350 if (*p == '&')
1351 *(p++) = 0;
1352 else if (*p == '#')
1353 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001354 len = url_decode(value, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001355 if (len == -1)
1356 goto error;
1357 }
1358
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001359 if (strcmp(key, "scope") == 0) {
William Dauchyc65f6562019-11-26 12:56:26 +01001360 default_scopes = 0; /* at least a scope defined, unset default scopes */
1361 if (!value)
1362 goto error;
1363 else if (*value == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001364 appctx->ctx.stats.flags &= ~PROMEX_FL_SCOPE_ALL;
William Dauchyc65f6562019-11-26 12:56:26 +01001365 else if (*value == '*')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001366 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_ALL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001367 else if (strcmp(value, "global") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001368 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_GLOBAL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001369 else if (strcmp(value, "server") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001370 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_SERVER;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001371 else if (strcmp(value, "backend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001372 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_BACK;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001373 else if (strcmp(value, "frontend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001374 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_FRONT;
William Dauchye3f7bd52021-02-14 23:22:56 +01001375 else if (strcmp(value, "listener") == 0)
1376 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_LI;
William Dauchy69164222021-02-07 20:42:38 +01001377 else if (strcmp(value, "sticktable") == 0)
1378 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_STICKTABLE;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001379 else
1380 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001381 }
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001382 else if (strcmp(key, "no-maint") == 0)
Christopher Fauleteba22942019-11-19 14:18:24 +01001383 appctx->ctx.stats.flags |= PROMEX_FL_NO_MAINT_SRV;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001384 }
1385
1386 end:
1387 appctx->ctx.stats.flags |= default_scopes;
1388 return 1;
1389
1390 error:
1391 err = &http_err_chunks[HTTP_ERR_400];
1392 channel_erase(res);
1393 res->buf.data = b_data(err);
1394 memcpy(res->buf.area, b_head(err), b_data(err));
1395 res_htx = htx_from_buf(&res->buf);
1396 channel_add_input(res, res_htx->data);
1397 appctx->st0 = PROMEX_ST_END;
1398 return -1;
1399}
1400
Christopher Fauletf959d082019-02-07 15:38:42 +01001401/* Send HTTP headers of the response. It returns 1 on success and 0 if <htx> is
1402 * full. */
1403static int promex_send_headers(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1404{
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001405 struct channel *chn = si_ic(appctx->owner);
Christopher Fauletf959d082019-02-07 15:38:42 +01001406 struct htx_sl *sl;
1407 unsigned int flags;
1408
1409 flags = (HTX_SL_F_IS_RESP|HTX_SL_F_VER_11|HTX_SL_F_XFER_ENC|HTX_SL_F_XFER_LEN|HTX_SL_F_CHNK);
1410 sl = htx_add_stline(htx, HTX_BLK_RES_SL, flags, ist("HTTP/1.1"), ist("200"), ist("OK"));
1411 if (!sl)
1412 goto full;
1413 sl->info.res.status = 200;
1414 if (!htx_add_header(htx, ist("Cache-Control"), ist("no-cache")) ||
Christopher Fauletf959d082019-02-07 15:38:42 +01001415 !htx_add_header(htx, ist("Content-Type"), ist("text/plain; version=0.0.4")) ||
1416 !htx_add_header(htx, ist("Transfer-Encoding"), ist("chunked")) ||
1417 !htx_add_endof(htx, HTX_BLK_EOH))
1418 goto full;
1419
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001420 channel_add_input(chn, htx->data);
Christopher Fauletf959d082019-02-07 15:38:42 +01001421 return 1;
1422 full:
1423 htx_reset(htx);
1424 si_rx_room_blk(si);
1425 return 0;
1426}
1427
1428/* The function returns 1 if the initialisation is complete, 0 if
1429 * an errors occurs and -1 if more data are required for initializing
1430 * the applet.
1431 */
1432static int promex_appctx_init(struct appctx *appctx, struct proxy *px, struct stream *strm)
1433{
1434 appctx->st0 = PROMEX_ST_INIT;
1435 return 1;
1436}
1437
1438/* The main I/O handler for the promex applet. */
1439static void promex_appctx_handle_io(struct appctx *appctx)
1440{
1441 struct stream_interface *si = appctx->owner;
1442 struct stream *s = si_strm(si);
1443 struct channel *req = si_oc(si);
1444 struct channel *res = si_ic(si);
1445 struct htx *req_htx, *res_htx;
1446 int ret;
1447
1448 res_htx = htx_from_buf(&res->buf);
Christopher Fauletf959d082019-02-07 15:38:42 +01001449 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1450 goto out;
1451
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001452 /* Check if the input buffer is available. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001453 if (!b_size(&res->buf)) {
1454 si_rx_room_blk(si);
1455 goto out;
1456 }
1457
1458 switch (appctx->st0) {
1459 case PROMEX_ST_INIT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001460 ret = promex_parse_uri(appctx, si);
1461 if (ret <= 0) {
1462 if (ret == -1)
1463 goto error;
1464 goto out;
1465 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001466 appctx->st0 = PROMEX_ST_HEAD;
1467 appctx->st1 = PROMEX_DUMPER_INIT;
1468 /* fall through */
1469
1470 case PROMEX_ST_HEAD:
1471 if (!promex_send_headers(appctx, si, res_htx))
1472 goto out;
1473 appctx->st0 = ((s->txn->meth == HTTP_METH_HEAD) ? PROMEX_ST_DONE : PROMEX_ST_DUMP);
1474 /* fall through */
1475
1476 case PROMEX_ST_DUMP:
1477 ret = promex_dump_metrics(appctx, si, res_htx);
1478 if (ret <= 0) {
1479 if (ret == -1)
1480 goto error;
1481 goto out;
1482 }
1483 appctx->st0 = PROMEX_ST_DONE;
1484 /* fall through */
1485
1486 case PROMEX_ST_DONE:
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001487 /* no more data are expected. Don't add TLR because mux-h1 will take care of it */
1488 res_htx->flags |= HTX_FL_EOM;
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001489 appctx->st0 = PROMEX_ST_END;
1490 /* fall through */
Christopher Fauletf959d082019-02-07 15:38:42 +01001491
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001492 case PROMEX_ST_END:
1493 if (!(res->flags & CF_SHUTR)) {
1494 res->flags |= CF_READ_NULL;
1495 si_shutr(si);
1496 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001497 }
1498
Christopher Fauletf959d082019-02-07 15:38:42 +01001499 out:
1500 htx_to_buf(res_htx, &res->buf);
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001501
1502 /* eat the whole request */
1503 if (co_data(req)) {
1504 req_htx = htx_from_buf(&req->buf);
1505 co_htx_skip(req, req_htx, co_data(req));
1506 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001507 return;
1508
1509 error:
1510 res->flags |= CF_READ_NULL;
1511 si_shutr(si);
1512 si_shutw(si);
1513}
1514
1515struct applet promex_applet = {
1516 .obj_type = OBJ_TYPE_APPLET,
1517 .name = "<PROMEX>", /* used for logging */
1518 .init = promex_appctx_init,
1519 .fct = promex_appctx_handle_io,
1520};
1521
1522static enum act_parse_ret service_parse_prometheus_exporter(const char **args, int *cur_arg, struct proxy *px,
1523 struct act_rule *rule, char **err)
1524{
1525 /* Prometheus exporter service is only available on "http-request" rulesets */
1526 if (rule->from != ACT_F_HTTP_REQ) {
1527 memprintf(err, "Prometheus exporter service only available on 'http-request' rulesets");
1528 return ACT_RET_PRS_ERR;
1529 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001530
1531 /* Add applet pointer in the rule. */
1532 rule->applet = promex_applet;
1533
1534 return ACT_RET_PRS_OK;
1535}
1536static void promex_register_build_options(void)
1537{
1538 char *ptr = NULL;
1539
1540 memprintf(&ptr, "Built with the Prometheus exporter as a service");
1541 hap_register_build_opts(ptr, 1);
1542}
1543
1544
1545static struct action_kw_list service_actions = { ILH, {
1546 { "prometheus-exporter", service_parse_prometheus_exporter },
1547 { /* END */ }
1548}};
1549
1550INITCALL1(STG_REGISTER, service_keywords_register, &service_actions);
1551INITCALL0(STG_REGISTER, promex_register_build_options);