blob: 403f5a619b73a99ae5894193863fb5228ca88e8c [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
66#define PROMEX_FL_SCOPE_GLOBAL 0x00000020
67#define PROMEX_FL_SCOPE_FRONT 0x00000040
68#define PROMEX_FL_SCOPE_BACK 0x00000080
69#define PROMEX_FL_SCOPE_SERVER 0x00000100
70#define PROMEX_FL_NO_MAINT_SRV 0x00000200
71#define PROMEX_FL_STICKTABLE_METRIC 0x00000400
72#define PROMEX_FL_SCOPE_STICKTABLE 0x00000800
Christopher Faulet78407ce2019-11-18 14:47:08 +010073
William Dauchy69164222021-02-07 20:42:38 +010074#define PROMEX_FL_SCOPE_ALL (PROMEX_FL_SCOPE_GLOBAL | PROMEX_FL_SCOPE_FRONT | \
75 PROMEX_FL_SCOPE_BACK | PROMEX_FL_SCOPE_SERVER | \
76 PROMEX_FL_SCOPE_STICKTABLE)
Christopher Fauletf959d082019-02-07 15:38:42 +010077
Christopher Faulet0312c0d2021-01-20 15:19:12 +010078/* Promtheus metric type (gauge or counter) */
79enum promex_mt_type {
80 PROMEX_MT_GAUGE = 1,
81 PROMEX_MT_COUNTER = 2,
82};
83
Christopher Fauletf959d082019-02-07 15:38:42 +010084/* The max length for metrics name. It is a hard limit but it should be
Ilya Shipitsince7b00f2020-03-23 22:28:40 +050085 * enough.
Christopher Fauletf959d082019-02-07 15:38:42 +010086 */
87#define PROMEX_MAX_NAME_LEN 128
88
89/* The expected max length for a metric dump, including its header lines. It is
90 * just a soft limit to avoid extra work. We don't try to dump a metric if less
91 * than this size is available in the HTX.
92 */
93#define PROMEX_MAX_METRIC_LENGTH 512
94
Christopher Faulet5a2f9382021-01-28 11:24:17 +010095/* The max number of labels per metric */
96#define PROMEX_MAX_LABELS 8
William Dauchy5a982a72021-01-08 13:18:06 +010097
Christopher Faulet0312c0d2021-01-20 15:19:12 +010098/* Describe a prometheus metric */
99struct promex_metric {
100 const struct ist n; /* The metric name */
101 enum promex_mt_type type; /* The metric type (gauge or counter) */
102 unsigned int flags; /* PROMEX_FL_* flags */
103};
104
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100105/* Describe a prometheus metric label. It is just a key/value pair */
106struct promex_label {
107 struct ist name;
108 struct ist value;
109};
110
Christopher Faulet37286a52021-01-20 15:20:53 +0100111/* Global metrics */
112const struct promex_metric promex_global_metrics[INF_TOTAL_FIELDS] = {
113 //[INF_NAME] ignored
114 //[INF_VERSION], ignored
115 //[INF_RELEASE_DATE] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100116 [INF_NBTHREAD] = { .n = IST("nbthread"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
117 [INF_NBPROC] = { .n = IST("nbproc"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
118 [INF_PROCESS_NUM] = { .n = IST("relative_process_id"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
119 //[INF_PID] ignored
120 //[INF_UPTIME] ignored
121 [INF_UPTIME_SEC] = { .n = IST("uptime_seconds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
122 [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 +0100123 //[INF_MEMMAX_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100124 [INF_MEMMAX_BYTES] = { .n = IST("max_memory_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100125 //[INF_POOL_ALLOC_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100126 [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 +0100127 //[INF_POOL_USED_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100128 [INF_POOL_USED_BYTES] = { .n = IST("pool_used_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
129 [INF_POOL_FAILED] = { .n = IST("pool_failures_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
130 [INF_ULIMIT_N] = { .n = IST("max_fds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
131 [INF_MAXSOCK] = { .n = IST("max_sockets"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
132 [INF_MAXCONN] = { .n = IST("max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
133 [INF_HARD_MAXCONN] = { .n = IST("hard_max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
134 [INF_CURR_CONN] = { .n = IST("current_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
135 [INF_CUM_CONN] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
136 [INF_CUM_REQ] = { .n = IST("requests_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
137 [INF_MAX_SSL_CONNS] = { .n = IST("max_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
138 [INF_CURR_SSL_CONNS] = { .n = IST("current_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
139 [INF_CUM_SSL_CONNS] = { .n = IST("ssl_connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
140 [INF_MAXPIPES] = { .n = IST("max_pipes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
141 [INF_PIPES_USED] = { .n = IST("pipes_used_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
142 [INF_PIPES_FREE] = { .n = IST("pipes_free_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
143 [INF_CONN_RATE] = { .n = IST("current_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
144 [INF_CONN_RATE_LIMIT] = { .n = IST("limit_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
145 [INF_MAX_CONN_RATE] = { .n = IST("max_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
146 [INF_SESS_RATE] = { .n = IST("current_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
147 [INF_SESS_RATE_LIMIT] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
148 [INF_MAX_SESS_RATE] = { .n = IST("max_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
149 [INF_SSL_RATE] = { .n = IST("current_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
150 [INF_SSL_RATE_LIMIT] = { .n = IST("limit_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
151 [INF_MAX_SSL_RATE] = { .n = IST("max_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
152 [INF_SSL_FRONTEND_KEY_RATE] = { .n = IST("current_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
153 [INF_SSL_FRONTEND_MAX_KEY_RATE] = { .n = IST("max_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
154 [INF_SSL_FRONTEND_SESSION_REUSE_PCT] = { .n = IST("frontend_ssl_reuse"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
155 [INF_SSL_BACKEND_KEY_RATE] = { .n = IST("current_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
156 [INF_SSL_BACKEND_MAX_KEY_RATE] = { .n = IST("max_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
157 [INF_SSL_CACHE_LOOKUPS] = { .n = IST("ssl_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
158 [INF_SSL_CACHE_MISSES] = { .n = IST("ssl_cache_misses_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
159 [INF_COMPRESS_BPS_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
160 [INF_COMPRESS_BPS_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
161 [INF_COMPRESS_BPS_RATE_LIM] = { .n = IST("limit_http_comp"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
162 [INF_ZLIB_MEM_USAGE] = { .n = IST("current_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
163 [INF_MAX_ZLIB_MEM_USAGE] = { .n = IST("max_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
164 [INF_TASKS] = { .n = IST("current_tasks"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
165 [INF_RUN_QUEUE] = { .n = IST("current_run_queue"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
166 [INF_IDLE_PCT] = { .n = IST("idle_time_percent"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
167 //[INF_NODE] ignored
168 //[INF_DESCRIPTION] ignored
169 [INF_STOPPING] = { .n = IST("stopping"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
170 [INF_JOBS] = { .n = IST("jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
171 [INF_UNSTOPPABLE_JOBS] = { .n = IST("unstoppable_jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
172 [INF_LISTENERS] = { .n = IST("listeners"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
173 [INF_ACTIVE_PEERS] = { .n = IST("active_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
174 [INF_CONNECTED_PEERS] = { .n = IST("connected_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
175 [INF_DROPPED_LOGS] = { .n = IST("dropped_logs_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
176 [INF_BUSY_POLLING] = { .n = IST("busy_polling_enabled"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
177 [INF_FAILED_RESOLUTIONS] = { .n = IST("failed_resolutions"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
178 [INF_TOTAL_BYTES_OUT] = { .n = IST("bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
179 [INF_TOTAL_SPLICED_BYTES_OUT] = { .n = IST("spliced_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
180 [INF_BYTES_OUT_RATE] = { .n = IST("bytes_out_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
181 //[INF_DEBUG_COMMANDS_ISSUED] ignored
William Dauchy7741c332021-02-01 13:11:57 +0100182 [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 +0100183 [INF_BUILD_INFO] = { .n = IST("build_info"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
Christopher Fauletf959d082019-02-07 15:38:42 +0100184};
185
Christopher Faulet37286a52021-01-20 15:20:53 +0100186/* frontend/backend/server fields */
187const struct promex_metric promex_st_metrics[ST_F_TOTAL_FIELDS] = {
188 //[ST_F_PXNAME] ignored
189 //[ST_F_SVNAME] ignored
190 [ST_F_QCUR] = { .n = IST("current_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
191 [ST_F_QMAX] = { .n = IST("max_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
192 [ST_F_SCUR] = { .n = IST("current_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
193 [ST_F_SMAX] = { .n = IST("max_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
194 [ST_F_SLIM] = { .n = IST("limit_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
195 [ST_F_STOT] = { .n = IST("sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
196 [ST_F_BIN] = { .n = IST("bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
197 [ST_F_BOUT] = { .n = IST("bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
198 [ST_F_DREQ] = { .n = IST("requests_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
199 [ST_F_DRESP] = { .n = IST("responses_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
200 [ST_F_EREQ] = { .n = IST("request_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
201 [ST_F_ECON] = { .n = IST("connection_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
202 [ST_F_ERESP] = { .n = IST("response_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
203 [ST_F_WRETR] = { .n = IST("retry_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
204 [ST_F_WREDIS] = { .n = IST("redispatch_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
205 [ST_F_STATUS] = { .n = IST("status"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
206 [ST_F_WEIGHT] = { .n = IST("weight"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
207 [ST_F_ACT] = { .n = IST("active_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
208 [ST_F_BCK] = { .n = IST("backup_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
209 [ST_F_CHKFAIL] = { .n = IST("check_failures_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_SRV_METRIC) },
210 [ST_F_CHKDOWN] = { .n = IST("check_up_down_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
211 [ST_F_LASTCHG] = { .n = IST("check_last_change_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
212 [ST_F_DOWNTIME] = { .n = IST("downtime_seconds_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
213 [ST_F_QLIMIT] = { .n = IST("queue_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
214 //[ST_F_PID] ignored
215 //[ST_F_IID] ignored
216 //[ST_F_SID] ignored
217 [ST_F_THROTTLE] = { .n = IST("current_throttle"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
218 [ST_F_LBTOT] = { .n = IST("loadbalanced_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
219 //[ST_F_TRACKED] ignored
220 //[ST_F_TYPE] ignored
221 //[ST_F_RATE] ignored
222 [ST_F_RATE_LIM] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
223 [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) },
224 [ST_F_CHECK_STATUS] = { .n = IST("check_status"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
225 [ST_F_CHECK_CODE] = { .n = IST("check_code"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
226 [ST_F_CHECK_DURATION] = { .n = IST("check_duration_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
227 [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) },
228 [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) },
229 [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) },
230 [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) },
231 [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) },
232 [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) },
233 //[ST_F_HANAFAIL] ignored
234 //[ST_F_REQ_RATE] ignored
235 [ST_F_REQ_RATE_MAX] = { .n = IST("http_requests_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
236 [ST_F_REQ_TOT] = { .n = IST("http_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
237 [ST_F_CLI_ABRT] = { .n = IST("client_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
238 [ST_F_SRV_ABRT] = { .n = IST("server_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
239 [ST_F_COMP_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
240 [ST_F_COMP_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
241 [ST_F_COMP_BYP] = { .n = IST("http_comp_bytes_bypassed_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
242 [ST_F_COMP_RSP] = { .n = IST("http_comp_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
243 [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 +0500244 //[ST_F_LAST_CHK] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100245 //[ST_F_LAST_AGT] ignored
246 [ST_F_QTIME] = { .n = IST("queue_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
247 [ST_F_CTIME] = { .n = IST("connect_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
248 [ST_F_RTIME] = { .n = IST("response_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
249 [ST_F_TTIME] = { .n = IST("total_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
250 //[ST_F_AGENT_STATUS] ignored
251 //[ST_F_AGENT_CODE] ignored
252 //[ST_F_AGENT_DURATION] ignored
253 //[ST_F_CHECK_DESC] ignored
254 //[ST_F_AGENT_DESC] ignored
255 //[ST_F_CHECK_RISE] ignored
256 //[ST_F_CHECK_FALL] ignored
257 //[ST_F_CHECK_HEALTH] ignored
258 //[ST_F_AGENT_RISE] ignored
259 //[ST_F_AGENT_FALL] ignored
260 //[ST_F_AGENT_HEALTH] ignored
261 //[ST_F_ADDR] ignored
262 //[ST_F_COOKIE] ignored
263 //[ST_F_MODE] ignored
264 //[ST_F_ALGO] ignored
265 //[ST_F_CONN_RATE] ignored
266 [ST_F_CONN_RATE_MAX] = { .n = IST("connections_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
267 [ST_F_CONN_TOT] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
268 [ST_F_INTERCEPTED] = { .n = IST("intercepted_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
269 [ST_F_DCON] = { .n = IST("denied_connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
270 [ST_F_DSES] = { .n = IST("denied_sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
271 [ST_F_WREW] = { .n = IST("failed_header_rewriting_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
272 [ST_F_CONNECT] = { .n = IST("connection_attempts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
273 [ST_F_REUSE] = { .n = IST("connection_reuses_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
274 [ST_F_CACHE_LOOKUPS] = { .n = IST("http_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
275 [ST_F_CACHE_HITS] = { .n = IST("http_cache_hits_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
276 [ST_F_SRV_ICUR] = { .n = IST("idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
277 [ST_F_SRV_ILIM] = { .n = IST("idle_connections_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
278 [ST_F_QT_MAX] = { .n = IST("max_queue_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
279 [ST_F_CT_MAX] = { .n = IST("max_connect_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
280 [ST_F_RT_MAX] = { .n = IST("max_response_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
281 [ST_F_TT_MAX] = { .n = IST("max_total_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
282 [ST_F_EINT] = { .n = IST("internal_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
283 [ST_F_IDLE_CONN_CUR] = { .n = IST("unsafe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
William Dauchydf9a05d2021-02-01 13:11:59 +0100284 [ST_F_SAFE_CONN_CUR] = { .n = IST("safe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100285 [ST_F_USED_CONN_CUR] = { .n = IST("used_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
286 [ST_F_NEED_CONN_EST] = { .n = IST("need_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
William Dauchye5a26a22021-02-01 13:11:56 +0100287 [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 +0100288};
289
Ilya Shipitsinacf84592021-02-06 22:29:08 +0500290/* Description of overridden stats fields */
Christopher Fauletf959d082019-02-07 15:38:42 +0100291const struct ist promex_st_metric_desc[ST_F_TOTAL_FIELDS] = {
William Dauchya1da7ba2021-02-01 13:11:52 +0100292 [ST_F_STATUS] = IST("Current status of the service, per state label value."),
William Dauchyde3c3262021-02-01 13:11:51 +0100293 [ST_F_CHECK_STATUS] = IST("Status of last health check, per state label value."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100294 [ST_F_CHECK_CODE] = IST("layer5-7 code, if available of the last health check."),
Christopher Faulet2711e512020-02-27 16:12:07 +0100295 [ST_F_CHECK_DURATION] = IST("Total duration of the latest server health check, in seconds."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100296 [ST_F_QTIME] = IST("Avg. queue time for last 1024 successful connections."),
297 [ST_F_CTIME] = IST("Avg. connect time for last 1024 successful connections."),
298 [ST_F_RTIME] = IST("Avg. response time for last 1024 successful connections."),
299 [ST_F_TTIME] = IST("Avg. total time for last 1024 successful connections."),
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100300 [ST_F_QT_MAX] = IST("Maximum observed time spent in the queue"),
301 [ST_F_CT_MAX] = IST("Maximum observed time spent waiting for a connection to complete"),
302 [ST_F_RT_MAX] = IST("Maximum observed time spent waiting for a server response"),
303 [ST_F_TT_MAX] = IST("Maximum observed total request+response time (request+queue+connect+response+processing)"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100304};
305
William Dauchy69164222021-02-07 20:42:38 +0100306/* stick table base fields */
307enum sticktable_field {
308 STICKTABLE_SIZE = 0,
309 STICKTABLE_USED,
310 /* must always be the last one */
311 STICKTABLE_TOTAL_FIELDS
312};
313
314const struct promex_metric promex_sticktable_metrics[STICKTABLE_TOTAL_FIELDS] = {
315 [STICKTABLE_SIZE] = { .n = IST("size"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_STICKTABLE_METRIC },
316 [STICKTABLE_USED] = { .n = IST("used"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_STICKTABLE_METRIC },
317};
318
319/* stick table base description */
320const struct ist promex_sticktable_metric_desc[STICKTABLE_TOTAL_FIELDS] = {
321 [STICKTABLE_SIZE] = IST("Stick table size."),
322 [STICKTABLE_USED] = IST("Number of entries used in this stick table."),
323};
324
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100325/* Specific labels for all ST_F_HRSP_* fields */
326const struct ist promex_hrsp_code[1 + ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = {
327 [ST_F_HRSP_1XX - ST_F_HRSP_1XX] = IST("1xx"),
328 [ST_F_HRSP_2XX - ST_F_HRSP_1XX] = IST("2xx"),
329 [ST_F_HRSP_3XX - ST_F_HRSP_1XX] = IST("3xx"),
330 [ST_F_HRSP_4XX - ST_F_HRSP_1XX] = IST("4xx"),
331 [ST_F_HRSP_5XX - ST_F_HRSP_1XX] = IST("5xx"),
332 [ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = IST("other"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100333};
334
William Dauchy54938212021-01-27 22:40:16 +0100335enum promex_front_state {
336 PROMEX_FRONT_STATE_DOWN = 0,
337 PROMEX_FRONT_STATE_UP,
338
339 PROMEX_FRONT_STATE_COUNT /* must be last */
340};
341
342const struct ist promex_front_st[PROMEX_FRONT_STATE_COUNT] = {
343 [PROMEX_FRONT_STATE_DOWN] = IST("DOWN"),
344 [PROMEX_FRONT_STATE_UP] = IST("UP"),
345};
346
347enum promex_back_state {
348 PROMEX_BACK_STATE_DOWN = 0,
349 PROMEX_BACK_STATE_UP,
350
351 PROMEX_BACK_STATE_COUNT /* must be last */
352};
353
354const struct ist promex_back_st[PROMEX_BACK_STATE_COUNT] = {
355 [PROMEX_BACK_STATE_DOWN] = IST("DOWN"),
356 [PROMEX_BACK_STATE_UP] = IST("UP"),
357};
358
359enum promex_srv_state {
360 PROMEX_SRV_STATE_DOWN = 0,
361 PROMEX_SRV_STATE_UP,
362 PROMEX_SRV_STATE_MAINT,
363 PROMEX_SRV_STATE_DRAIN,
364 PROMEX_SRV_STATE_NOLB,
365
366 PROMEX_SRV_STATE_COUNT /* must be last */
367};
368
369const struct ist promex_srv_st[PROMEX_SRV_STATE_COUNT] = {
370 [PROMEX_SRV_STATE_DOWN] = IST("DOWN"),
371 [PROMEX_SRV_STATE_UP] = IST("UP"),
372 [PROMEX_SRV_STATE_MAINT] = IST("MAINT"),
373 [PROMEX_SRV_STATE_DRAIN] = IST("DRAIN"),
374 [PROMEX_SRV_STATE_NOLB] = IST("NOLB"),
375};
376
377/* Return the server status. */
378enum promex_srv_state promex_srv_status(struct server *sv)
Christopher Fauletf959d082019-02-07 15:38:42 +0100379{
William Dauchy54938212021-01-27 22:40:16 +0100380 int state = PROMEX_SRV_STATE_DOWN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100381
Christopher Fauletf959d082019-02-07 15:38:42 +0100382 if (sv->cur_state == SRV_ST_RUNNING || sv->cur_state == SRV_ST_STARTING) {
William Dauchy54938212021-01-27 22:40:16 +0100383 state = PROMEX_SRV_STATE_UP;
Christopher Fauletf959d082019-02-07 15:38:42 +0100384 if (sv->cur_admin & SRV_ADMF_DRAIN)
William Dauchy54938212021-01-27 22:40:16 +0100385 state = PROMEX_SRV_STATE_DRAIN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100386 }
Christopher Fauletd45d1052019-09-06 16:10:19 +0200387 else if (sv->cur_state == SRV_ST_STOPPING)
William Dauchy54938212021-01-27 22:40:16 +0100388 state = PROMEX_SRV_STATE_NOLB;
Christopher Fauletd45d1052019-09-06 16:10:19 +0200389
390 if (sv->cur_admin & SRV_ADMF_MAINT)
William Dauchy54938212021-01-27 22:40:16 +0100391 state = PROMEX_SRV_STATE_MAINT;
Christopher Fauletf959d082019-02-07 15:38:42 +0100392
393 return state;
394}
395
396/* Convert a field to its string representation and write it in <out>, followed
397 * by a newline, if there is enough space. non-numeric value are converted in
William Dauchy18a2c6e2021-01-22 21:09:47 +0100398 * "NaN" because Prometheus only support numerical values (but it is unexepceted
Christopher Fauletf959d082019-02-07 15:38:42 +0100399 * to process this kind of value). It returns 1 on success. Otherwise, it
400 * returns 0. The buffer's length must not exceed <max> value.
401 */
402static int promex_metric_to_str(struct buffer *out, struct field *f, size_t max)
403{
404 int ret = 0;
405
406 switch (field_format(f, 0)) {
William Dauchy18a2c6e2021-01-22 21:09:47 +0100407 case FF_EMPTY: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100408 case FF_S32: ret = chunk_appendf(out, "%d\n", f->u.s32); break;
409 case FF_U32: ret = chunk_appendf(out, "%u\n", f->u.u32); break;
410 case FF_S64: ret = chunk_appendf(out, "%lld\n", (long long)f->u.s64); break;
411 case FF_U64: ret = chunk_appendf(out, "%llu\n", (unsigned long long)f->u.u64); break;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200412 case FF_FLT: ret = chunk_appendf(out, "%f\n", f->u.flt); break;
William Dauchy18a2c6e2021-01-22 21:09:47 +0100413 case FF_STR: ret = chunk_strcat(out, "NaN\n"); break;
414 default: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100415 }
416 if (!ret || out->data > max)
417 return 0;
418 return 1;
419}
420
Christopher Fauletf959d082019-02-07 15:38:42 +0100421/* Dump the header lines for <metric>. It is its #HELP and #TYPE strings. It
422 * returns 1 on success. Otherwise, if <out> length exceeds <max>, it returns 0.
423 */
424static int promex_dump_metric_header(struct appctx *appctx, struct htx *htx,
Christopher Faulet37286a52021-01-20 15:20:53 +0100425 const struct promex_metric *metric, const struct ist name,
426 struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100427{
Christopher Faulet37286a52021-01-20 15:20:53 +0100428 struct ist type;
William Dauchy82b2ce22021-02-01 13:11:55 +0100429 struct ist desc;
Christopher Faulet37286a52021-01-20 15:20:53 +0100430
431 switch (metric->type) {
432 case PROMEX_MT_COUNTER:
433 type = ist("counter");
434 break;
435 default:
436 type = ist("gauge");
437 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100438
William Dauchya191b772021-01-15 22:41:39 +0100439 if (istcat(out, ist("# HELP "), max) == -1 ||
440 istcat(out, name, max) == -1 ||
441 istcat(out, ist(" "), max) == -1)
442 goto full;
443
William Dauchy82b2ce22021-02-01 13:11:55 +0100444 if (metric->flags & PROMEX_FL_INFO_METRIC)
445 desc = ist(info_fields[appctx->st2].desc);
William Dauchy69164222021-02-07 20:42:38 +0100446 else if (metric->flags & PROMEX_FL_STICKTABLE_METRIC)
447 desc = promex_sticktable_metric_desc[appctx->st2];
William Dauchy82b2ce22021-02-01 13:11:55 +0100448 else if (!isttest(promex_st_metric_desc[appctx->st2]))
449 desc = ist(stat_fields[appctx->st2].desc);
450 else
451 desc = promex_st_metric_desc[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100452
William Dauchy82b2ce22021-02-01 13:11:55 +0100453 if (istcat(out, desc, max) == -1 ||
454 istcat(out, ist("\n# TYPE "), max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100455 istcat(out, name, max) == -1 ||
456 istcat(out, ist(" "), max) == -1 ||
Christopher Faulet37286a52021-01-20 15:20:53 +0100457 istcat(out, type, max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100458 istcat(out, ist("\n"), max) == -1)
459 goto full;
460
461 return 1;
462
463 full:
464 return 0;
465}
466
467/* Dump the line for <metric>. It starts by the metric name followed by its
468 * labels (proxy name, server name...) between braces and finally its value. If
469 * not already done, the header lines are dumped first. It returns 1 on
470 * success. Otherwise if <out> length exceeds <max>, it returns 0.
471 */
Christopher Faulet37286a52021-01-20 15:20:53 +0100472static int promex_dump_metric(struct appctx *appctx, struct htx *htx, struct ist prefix,
William Dauchyc6464592021-01-27 22:40:17 +0100473 const struct promex_metric *metric, struct field *val,
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100474 struct promex_label *labels, struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100475{
476 struct ist name = { .ptr = (char[PROMEX_MAX_NAME_LEN]){ 0 }, .len = 0 };
477 size_t len = out->len;
478
479 if (out->len + PROMEX_MAX_METRIC_LENGTH > max)
480 return 0;
481
Christopher Faulet37286a52021-01-20 15:20:53 +0100482 /* Fill the metric name */
483 istcat(&name, prefix, PROMEX_MAX_NAME_LEN);
484 istcat(&name, metric->n, PROMEX_MAX_NAME_LEN);
485
486
Christopher Fauletf959d082019-02-07 15:38:42 +0100487 if ((appctx->ctx.stats.flags & PROMEX_FL_METRIC_HDR) &&
Christopher Faulet37286a52021-01-20 15:20:53 +0100488 !promex_dump_metric_header(appctx, htx, metric, name, out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100489 goto full;
490
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100491 if (istcat(out, name, max) == -1)
492 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100493
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100494 if (isttest(labels[0].name)) {
495 int i;
496
497 if (istcat(out, ist("{"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100498 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100499
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100500 for (i = 0; isttest(labels[i].name); i++) {
501 if (!isttest(labels[i].value))
502 continue;
503
504 if ((i && istcat(out, ist(","), max) == -1) ||
505 istcat(out, labels[i].name, max) == -1 ||
506 istcat(out, ist("=\""), max) == -1 ||
507 istcat(out, labels[i].value, max) == -1 ||
508 istcat(out, ist("\""), max) == -1)
509 goto full;
510 }
511
512 if (istcat(out, ist("}"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100513 goto full;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100514
Christopher Fauletf959d082019-02-07 15:38:42 +0100515 }
516
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100517 if (istcat(out, ist(" "), max) == -1)
518 goto full;
519
Christopher Fauletf959d082019-02-07 15:38:42 +0100520 trash.data = out->len;
Christopher Faulet37286a52021-01-20 15:20:53 +0100521 if (!promex_metric_to_str(&trash, val, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100522 goto full;
523 out->len = trash.data;
524
525 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
526 return 1;
527 full:
528 // Restore previous length
529 out->len = len;
530 return 0;
531
532}
533
534
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500535/* Dump global metrics (prefixed by "haproxy_process_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100536 * 0 if <htx> is full and -1 in case of any error. */
537static int promex_dump_global_metrics(struct appctx *appctx, struct htx *htx)
538{
539 static struct ist prefix = IST("haproxy_process_");
Christopher Faulet37286a52021-01-20 15:20:53 +0100540 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100541 struct channel *chn = si_ic(appctx->owner);
542 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200543 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
Christopher Fauletf959d082019-02-07 15:38:42 +0100544 int ret = 1;
545
William Dauchy5d9b8f32021-01-11 20:07:49 +0100546 if (!stats_fill_info(info, INF_TOTAL_FIELDS))
547 return -1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100548
Christopher Faulet37286a52021-01-20 15:20:53 +0100549 for (; appctx->st2 < INF_TOTAL_FIELDS; appctx->st2++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100550 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
551
Christopher Faulet37286a52021-01-20 15:20:53 +0100552 if (!(promex_global_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
553 continue;
554
Christopher Fauletf959d082019-02-07 15:38:42 +0100555 switch (appctx->st2) {
William Dauchy5a982a72021-01-08 13:18:06 +0100556 case INF_BUILD_INFO:
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100557 labels[0].name = ist("version");
558 labels[0].value = ist(HAPROXY_VERSION);
Christopher Faulet37286a52021-01-20 15:20:53 +0100559 val = mkf_u32(FN_GAUGE, 1);
William Dauchy5a982a72021-01-08 13:18:06 +0100560 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100561
562 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100563 val = info[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100564 }
565
William Dauchyc6464592021-01-27 22:40:17 +0100566 if (!promex_dump_metric(appctx, htx, prefix, &promex_global_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100567 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100568 goto full;
569
Christopher Fauletf959d082019-02-07 15:38:42 +0100570 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Christopher Fauletf959d082019-02-07 15:38:42 +0100571 }
572
573 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200574 if (out.len) {
575 if (!htx_add_data_atonce(htx, out))
576 return -1; /* Unexpected and unrecoverable error */
577 channel_add_input(chn, out.len);
578 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100579 return ret;
580 full:
581 ret = 0;
582 goto end;
583}
584
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500585/* Dump frontends metrics (prefixed by "haproxy_frontend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100586 * 0 if <htx> is full and -1 in case of any error. */
587static int promex_dump_front_metrics(struct appctx *appctx, struct htx *htx)
588{
589 static struct ist prefix = IST("haproxy_frontend_");
590 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100591 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100592 struct channel *chn = si_ic(appctx->owner);
593 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200594 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchyb9577452021-01-17 18:27:46 +0100595 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100596 int ret = 1;
William Dauchyc6464592021-01-27 22:40:17 +0100597 enum promex_front_state state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100598
Christopher Faulet37286a52021-01-20 15:20:53 +0100599 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
600 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
601 continue;
602
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200603 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100604 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
605
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200606 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100607
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100608 labels[0].name = ist("proxy");
609 labels[0].value = ist2(px->id, strlen(px->id));
610
Christopher Fauletf959d082019-02-07 15:38:42 +0100611 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200612 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_FE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100613 goto next_px;
614
William Dauchyb9577452021-01-17 18:27:46 +0100615 if (!stats_fill_fe_stats(px, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
616 return -1;
617
Christopher Fauletf959d082019-02-07 15:38:42 +0100618 switch (appctx->st2) {
619 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100620 state = !px->disabled;
Christopher Faulet040b1192021-02-01 15:05:21 +0100621 for (; appctx->ctx.stats.st_code < PROMEX_FRONT_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100622 labels[1].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100623 labels[1].value = promex_front_st[appctx->ctx.stats.st_code];
624 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
William Dauchyc6464592021-01-27 22:40:17 +0100625 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100626 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100627 goto full;
628 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100629 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100630 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100631 case ST_F_REQ_RATE_MAX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100632 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100633 case ST_F_INTERCEPTED:
Christopher Fauletf959d082019-02-07 15:38:42 +0100634 case ST_F_CACHE_LOOKUPS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100635 case ST_F_CACHE_HITS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100636 case ST_F_COMP_IN:
Christopher Fauletf959d082019-02-07 15:38:42 +0100637 case ST_F_COMP_OUT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100638 case ST_F_COMP_BYP:
William Dauchyb9577452021-01-17 18:27:46 +0100639 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100640 if (px->mode != PR_MODE_HTTP)
641 goto next_px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100642 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100643 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100644 case ST_F_HRSP_1XX:
William Dauchyb9577452021-01-17 18:27:46 +0100645 case ST_F_HRSP_2XX:
646 case ST_F_HRSP_3XX:
647 case ST_F_HRSP_4XX:
648 case ST_F_HRSP_5XX:
649 case ST_F_HRSP_OTHER:
Christopher Fauletf959d082019-02-07 15:38:42 +0100650 if (px->mode != PR_MODE_HTTP)
651 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100652 if (appctx->st2 != ST_F_HRSP_1XX)
653 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100654 labels[1].name = ist("code");
655 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
656 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100657 break;
658
659 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100660 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100661 }
662
William Dauchyc6464592021-01-27 22:40:17 +0100663 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100664 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100665 goto full;
666 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200667 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100668 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100669 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200670 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100671 }
672
673 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200674 if (out.len) {
675 if (!htx_add_data_atonce(htx, out))
676 return -1; /* Unexpected and unrecoverable error */
677 channel_add_input(chn, out.len);
678 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100679 return ret;
680 full:
681 ret = 0;
682 goto end;
683}
684
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500685/* Dump backends metrics (prefixed by "haproxy_backend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100686 * 0 if <htx> is full and -1 in case of any error. */
687static int promex_dump_back_metrics(struct appctx *appctx, struct htx *htx)
688{
689 static struct ist prefix = IST("haproxy_backend_");
690 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100691 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100692 struct channel *chn = si_ic(appctx->owner);
693 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200694 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchy3c6f0062021-01-25 17:29:02 +0100695 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100696 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200697 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100698 enum promex_back_state state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100699
Christopher Faulet37286a52021-01-20 15:20:53 +0100700 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
701 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
702 continue;
703
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200704 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100705 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
706
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200707 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100708
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100709 labels[0].name = ist("proxy");
710 labels[0].value = ist2(px->id, strlen(px->id));
711
Christopher Fauletf959d082019-02-07 15:38:42 +0100712 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200713 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100714 goto next_px;
715
William Dauchy3c6f0062021-01-25 17:29:02 +0100716 if (!stats_fill_be_stats(px, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
717 return -1;
718
Christopher Fauletf959d082019-02-07 15:38:42 +0100719 switch (appctx->st2) {
720 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100721 state = ((px->lbprm.tot_weight > 0 || !px->srv) ? 1 : 0);
Christopher Faulet040b1192021-02-01 15:05:21 +0100722 for (; appctx->ctx.stats.st_code < PROMEX_BACK_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100723 labels[1].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100724 labels[1].value = promex_back_st[appctx->ctx.stats.st_code];
725 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
William Dauchyc6464592021-01-27 22:40:17 +0100726 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100727 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100728 goto full;
729 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100730 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100731 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100732 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200733 secs = (double)swrate_avg(px->be_counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100734 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100735 break;
736 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200737 secs = (double)swrate_avg(px->be_counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100738 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100739 break;
740 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200741 secs = (double)swrate_avg(px->be_counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100742 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100743 break;
744 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200745 secs = (double)swrate_avg(px->be_counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100746 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100747 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100748 case ST_F_QT_MAX:
749 secs = (double)px->be_counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100750 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100751 break;
752 case ST_F_CT_MAX:
753 secs = (double)px->be_counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100754 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100755 break;
756 case ST_F_RT_MAX:
757 secs = (double)px->be_counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100758 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100759 break;
760 case ST_F_TT_MAX:
761 secs = (double)px->be_counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100762 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100763 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100764 case ST_F_REQ_TOT:
William Dauchy3c6f0062021-01-25 17:29:02 +0100765 case ST_F_CACHE_LOOKUPS:
766 case ST_F_CACHE_HITS:
767 case ST_F_COMP_IN:
768 case ST_F_COMP_OUT:
769 case ST_F_COMP_BYP:
770 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100771 if (px->mode != PR_MODE_HTTP)
772 goto next_px;
William Dauchy3c6f0062021-01-25 17:29:02 +0100773 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100774 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100775 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100776 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100777 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100778 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100779 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100780 case ST_F_HRSP_OTHER:
781 if (px->mode != PR_MODE_HTTP)
782 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100783 if (appctx->st2 != ST_F_HRSP_1XX)
784 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100785 labels[1].name = ist("code");
786 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchy3c6f0062021-01-25 17:29:02 +0100787 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100788 break;
789
790 default:
William Dauchy3c6f0062021-01-25 17:29:02 +0100791 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100792 }
793
William Dauchy3c6f0062021-01-25 17:29:02 +0100794 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100795 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100796 goto full;
797 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200798 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100799 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100800 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200801 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100802 }
803
804 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200805 if (out.len) {
806 if (!htx_add_data_atonce(htx, out))
807 return -1; /* Unexpected and unrecoverable error */
808 channel_add_input(chn, out.len);
809 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100810 return ret;
811 full:
812 ret = 0;
813 goto end;
814}
815
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500816/* Dump servers metrics (prefixed by "haproxy_server_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100817 * 0 if <htx> is full and -1 in case of any error. */
818static int promex_dump_srv_metrics(struct appctx *appctx, struct htx *htx)
819{
820 static struct ist prefix = IST("haproxy_server_");
821 struct proxy *px;
822 struct server *sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100823 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100824 struct channel *chn = si_ic(appctx->owner);
825 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200826 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchybde2bf62021-01-25 17:29:04 +0100827 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100828 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200829 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100830 enum promex_srv_state state;
William Dauchyde3c3262021-02-01 13:11:51 +0100831 const char *check_state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100832
Christopher Faulet37286a52021-01-20 15:20:53 +0100833 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
834 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
835 continue;
836
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200837 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100838 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
839
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200840 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100841
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100842 labels[0].name = ist("proxy");
843 labels[0].value = ist2(px->id, strlen(px->id));
844
Christopher Fauletf959d082019-02-07 15:38:42 +0100845 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200846 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100847 goto next_px;
848
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200849 while (appctx->ctx.stats.obj2) {
850 sv = appctx->ctx.stats.obj2;
Christopher Fauletf959d082019-02-07 15:38:42 +0100851
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100852 labels[1].name = ist("server");
853 labels[1].value = ist2(sv->id, strlen(sv->id));
854
William Dauchybde2bf62021-01-25 17:29:04 +0100855 if (!stats_fill_sv_stats(px, sv, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
856 return -1;
857
Christopher Fauleteba22942019-11-19 14:18:24 +0100858 if ((appctx->ctx.stats.flags & PROMEX_FL_NO_MAINT_SRV) && (sv->cur_admin & SRV_ADMF_MAINT))
859 goto next_sv;
860
Christopher Fauletf959d082019-02-07 15:38:42 +0100861 switch (appctx->st2) {
862 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100863 state = promex_srv_status(sv);
Christopher Faulet040b1192021-02-01 15:05:21 +0100864 for (; appctx->ctx.stats.st_code < PROMEX_SRV_STATE_COUNT; appctx->ctx.stats.st_code++) {
865 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100866 labels[2].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100867 labels[2].value = promex_srv_st[appctx->ctx.stats.st_code];
William Dauchyc6464592021-01-27 22:40:17 +0100868 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100869 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100870 goto full;
871 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100872 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100873 goto next_sv;
Christopher Fauletf959d082019-02-07 15:38:42 +0100874 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200875 secs = (double)swrate_avg(sv->counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100876 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100877 break;
878 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200879 secs = (double)swrate_avg(sv->counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100880 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100881 break;
882 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200883 secs = (double)swrate_avg(sv->counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100884 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100885 break;
886 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200887 secs = (double)swrate_avg(sv->counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100888 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100889 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100890 case ST_F_QT_MAX:
891 secs = (double)sv->counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100892 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100893 break;
894 case ST_F_CT_MAX:
895 secs = (double)sv->counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100896 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100897 break;
898 case ST_F_RT_MAX:
899 secs = (double)sv->counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100900 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100901 break;
902 case ST_F_TT_MAX:
903 secs = (double)sv->counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100904 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100905 break;
Christopher Fauletcf403f32019-11-21 14:35:46 +0100906 case ST_F_CHECK_STATUS:
907 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
908 goto next_sv;
William Dauchyde3c3262021-02-01 13:11:51 +0100909
Christopher Faulet040b1192021-02-01 15:05:21 +0100910 for (; appctx->ctx.stats.st_code < HCHK_STATUS_SIZE; appctx->ctx.stats.st_code++) {
911 if (get_check_status_result(appctx->ctx.stats.st_code) < CHK_RES_FAILED)
William Dauchyde3c3262021-02-01 13:11:51 +0100912 continue;
Christopher Faulet040b1192021-02-01 15:05:21 +0100913 val = mkf_u32(FO_STATUS, sv->check.status == appctx->ctx.stats.st_code);
914 check_state = get_check_status_info(appctx->ctx.stats.st_code);
William Dauchyde3c3262021-02-01 13:11:51 +0100915 labels[2].name = ist("state");
916 labels[2].value = ist2(check_state, strlen(check_state));
917 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
918 &val, labels, &out, max))
919 goto full;
920 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100921 appctx->ctx.stats.st_code = 0;
William Dauchyde3c3262021-02-01 13:11:51 +0100922 goto next_sv;
Christopher Fauletcf403f32019-11-21 14:35:46 +0100923 case ST_F_CHECK_CODE:
924 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
925 goto next_sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100926 val = mkf_u32(FN_OUTPUT, (sv->check.status < HCHK_STATUS_L57DATA) ? 0 : sv->check.code);
Christopher Fauletcf403f32019-11-21 14:35:46 +0100927 break;
Christopher Faulet2711e512020-02-27 16:12:07 +0100928 case ST_F_CHECK_DURATION:
929 if (sv->check.status < HCHK_STATUS_CHECKED)
930 goto next_sv;
931 secs = (double)sv->check.duration / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100932 val = mkf_flt(FN_DURATION, secs);
Christopher Faulet2711e512020-02-27 16:12:07 +0100933 break;
Marcin Deranek3c27dda2020-05-15 18:32:51 +0200934 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100935 if (px->mode != PR_MODE_HTTP)
936 goto next_px;
William Dauchybde2bf62021-01-25 17:29:04 +0100937 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100938 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100939 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100940 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100941 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100942 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100943 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100944 case ST_F_HRSP_OTHER:
945 if (px->mode != PR_MODE_HTTP)
946 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100947 if (appctx->st2 != ST_F_HRSP_1XX)
948 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100949 labels[2].name = ist("code");
950 labels[2].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchybde2bf62021-01-25 17:29:04 +0100951 val = stats[appctx->st2];
Christopher Fauletc55a6262020-07-10 15:39:39 +0200952 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100953
954 default:
William Dauchybde2bf62021-01-25 17:29:04 +0100955 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100956 }
957
William Dauchyc6464592021-01-27 22:40:17 +0100958 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100959 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100960 goto full;
Christopher Fauleteba22942019-11-19 14:18:24 +0100961 next_sv:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200962 appctx->ctx.stats.obj2 = sv->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100963 }
964
965 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200966 appctx->ctx.stats.obj1 = px->next;
967 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +0100968 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100969 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200970 appctx->ctx.stats.obj1 = proxies_list;
971 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +0100972 }
973
974
975 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200976 if (out.len) {
977 if (!htx_add_data_atonce(htx, out))
978 return -1; /* Unexpected and unrecoverable error */
979 channel_add_input(chn, out.len);
980 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100981 return ret;
982 full:
983 ret = 0;
984 goto end;
985}
986
William Dauchy69164222021-02-07 20:42:38 +0100987/* Dump stick table metrics (prefixed by "haproxy_sticktable_"). It returns 1 on success,
988 * 0 if <htx> is full and -1 in case of any error. */
989static int promex_dump_sticktable_metrics(struct appctx *appctx, struct htx *htx)
990{
991 static struct ist prefix = IST("haproxy_sticktable_");
992 struct field val;
993 struct channel *chn = si_ic(appctx->owner);
994 struct ist out = ist2(trash.area, 0);
995 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
996 int ret = 1;
997 struct stktable *t;
998
999 for (; appctx->st2 < STICKTABLE_TOTAL_FIELDS; appctx->st2++) {
1000 if (!(promex_sticktable_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
1001 continue;
1002
1003 while (appctx->ctx.stats.obj1) {
1004 struct promex_label labels[PROMEX_MAX_LABELS - 1] = {};
1005
1006 t = appctx->ctx.stats.obj1;
1007 if (!t->size)
1008 goto next_px;
1009
1010 labels[0].name = ist("name");
1011 labels[0].value = ist2(t->id, strlen(t->id));
1012 labels[1].name = ist("type");
1013 labels[1].value = ist2(stktable_types[t->type].kw, strlen(stktable_types[t->type].kw));
1014 switch (appctx->st2) {
1015 case STICKTABLE_SIZE:
1016 val = mkf_u32(FN_GAUGE, t->size);
1017 break;
1018 case STICKTABLE_USED:
1019 val = mkf_u32(FN_GAUGE, t->current);
1020 break;
1021 default:
1022 goto next_px;
1023 }
1024
1025 if (!promex_dump_metric(appctx, htx, prefix,
1026 &promex_sticktable_metrics[appctx->st2],
1027 &val, labels, &out, max))
1028 goto full;
1029
1030 next_px:
1031 appctx->ctx.stats.obj1 = t->next;
1032 }
1033 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
1034 appctx->ctx.stats.obj1 = stktables_list;
1035 }
1036
1037 end:
1038 if (out.len) {
1039 if (!htx_add_data_atonce(htx, out))
1040 return -1; /* Unexpected and unrecoverable error */
1041 channel_add_input(chn, out.len);
1042 }
1043 return ret;
1044 full:
1045 ret = 0;
1046 goto end;
1047}
1048
Christopher Fauletf959d082019-02-07 15:38:42 +01001049/* Dump all metrics (global, frontends, backends and servers) depending on the
1050 * dumper state (appctx->st1). It returns 1 on success, 0 if <htx> is full and
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001051 * -1 in case of any error.
1052 * Uses <appctx.ctx.stats.obj1> as a pointer to the current proxy and <obj2> as
1053 * a pointer to the current server/listener. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001054static int promex_dump_metrics(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1055{
1056 int ret;
1057
1058 switch (appctx->st1) {
1059 case PROMEX_DUMPER_INIT:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001060 appctx->ctx.stats.obj1 = NULL;
1061 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001062 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_INFO_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001063 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001064 appctx->st2 = INF_NAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001065 appctx->st1 = PROMEX_DUMPER_GLOBAL;
1066 /* fall through */
1067
1068 case PROMEX_DUMPER_GLOBAL:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001069 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_GLOBAL) {
1070 ret = promex_dump_global_metrics(appctx, htx);
1071 if (ret <= 0) {
1072 if (ret == -1)
1073 goto error;
1074 goto full;
1075 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001076 }
1077
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001078 appctx->ctx.stats.obj1 = proxies_list;
1079 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001080 appctx->ctx.stats.flags &= ~PROMEX_FL_INFO_METRIC;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001081 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_FRONT_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001082 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001083 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001084 appctx->st1 = PROMEX_DUMPER_FRONT;
1085 /* fall through */
1086
1087 case PROMEX_DUMPER_FRONT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001088 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_FRONT) {
1089 ret = promex_dump_front_metrics(appctx, htx);
1090 if (ret <= 0) {
1091 if (ret == -1)
1092 goto error;
1093 goto full;
1094 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001095 }
1096
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001097 appctx->ctx.stats.obj1 = proxies_list;
1098 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001099 appctx->ctx.stats.flags &= ~PROMEX_FL_FRONT_METRIC;
1100 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_BACK_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001101 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001102 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001103 appctx->st1 = PROMEX_DUMPER_BACK;
1104 /* fall through */
1105
1106 case PROMEX_DUMPER_BACK:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001107 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_BACK) {
1108 ret = promex_dump_back_metrics(appctx, htx);
1109 if (ret <= 0) {
1110 if (ret == -1)
1111 goto error;
1112 goto full;
1113 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001114 }
1115
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001116 appctx->ctx.stats.obj1 = proxies_list;
1117 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001118 appctx->ctx.stats.flags &= ~PROMEX_FL_BACK_METRIC;
1119 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001120 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001121 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001122 appctx->st1 = PROMEX_DUMPER_SRV;
1123 /* fall through */
1124
1125 case PROMEX_DUMPER_SRV:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001126 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_SERVER) {
1127 ret = promex_dump_srv_metrics(appctx, htx);
1128 if (ret <= 0) {
1129 if (ret == -1)
1130 goto error;
1131 goto full;
1132 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001133 }
1134
William Dauchy69164222021-02-07 20:42:38 +01001135 appctx->ctx.stats.obj1 = stktables_list;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001136 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001137 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
William Dauchy69164222021-02-07 20:42:38 +01001138 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_STICKTABLE_METRIC);
1139 appctx->st2 = STICKTABLE_SIZE;
1140 appctx->st1 = PROMEX_DUMPER_STICKTABLE;
1141 /* fall through */
1142
1143 case PROMEX_DUMPER_STICKTABLE:
1144 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_STICKTABLE) {
1145 ret = promex_dump_sticktable_metrics(appctx, htx);
1146 if (ret <= 0) {
1147 if (ret == -1)
1148 goto error;
1149 goto full;
1150 }
1151 }
1152
1153 appctx->ctx.stats.obj1 = NULL;
1154 appctx->ctx.stats.obj2 = NULL;
1155 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_STICKTABLE_METRIC);
Christopher Fauletf959d082019-02-07 15:38:42 +01001156 appctx->st2 = 0;
1157 appctx->st1 = PROMEX_DUMPER_DONE;
1158 /* fall through */
1159
1160 case PROMEX_DUMPER_DONE:
1161 default:
1162 break;
1163 }
1164
1165 return 1;
1166
1167 full:
1168 si_rx_room_blk(si);
1169 return 0;
1170 error:
1171 /* unrecoverable error */
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001172 appctx->ctx.stats.obj1 = NULL;
1173 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletf959d082019-02-07 15:38:42 +01001174 appctx->ctx.stats.flags = 0;
1175 appctx->st2 = 0;
1176 appctx->st1 = PROMEX_DUMPER_DONE;
1177 return -1;
1178}
1179
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001180/* Parse the query string of request URI to filter the metrics. It returns 1 on
Christopher Faulet78407ce2019-11-18 14:47:08 +01001181 * success and -1 on error. */
1182static int promex_parse_uri(struct appctx *appctx, struct stream_interface *si)
1183{
1184 struct channel *req = si_oc(si);
1185 struct channel *res = si_ic(si);
1186 struct htx *req_htx, *res_htx;
1187 struct htx_sl *sl;
William Dauchyc65f6562019-11-26 12:56:26 +01001188 char *p, *key, *value;
1189 const char *end;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001190 struct buffer *err;
1191 int default_scopes = PROMEX_FL_SCOPE_ALL;
1192 int len;
1193
1194 /* Get the query-string */
1195 req_htx = htxbuf(&req->buf);
1196 sl = http_get_stline(req_htx);
1197 if (!sl)
1198 goto error;
1199 p = http_find_param_list(HTX_SL_REQ_UPTR(sl), HTX_SL_REQ_ULEN(sl), '?');
1200 if (!p)
1201 goto end;
1202 end = HTX_SL_REQ_UPTR(sl) + HTX_SL_REQ_ULEN(sl);
Christopher Faulet78407ce2019-11-18 14:47:08 +01001203
William Dauchyc65f6562019-11-26 12:56:26 +01001204 /* copy the query-string */
1205 len = end - p;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001206 chunk_reset(&trash);
1207 memcpy(trash.area, p, len);
1208 trash.area[len] = 0;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001209 p = trash.area;
William Dauchyc65f6562019-11-26 12:56:26 +01001210 end = trash.area + len;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001211
1212 /* Parse the query-string */
William Dauchyc65f6562019-11-26 12:56:26 +01001213 while (p < end && *p && *p != '#') {
1214 value = NULL;
1215
1216 /* decode parameter name */
1217 key = p;
1218 while (p < end && *p != '=' && *p != '&' && *p != '#')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001219 ++p;
William Dauchyc65f6562019-11-26 12:56:26 +01001220 /* found a value */
1221 if (*p == '=') {
1222 *(p++) = 0;
1223 value = p;
1224 }
1225 else if (*p == '&')
1226 *(p++) = 0;
1227 else if (*p == '#')
1228 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001229 len = url_decode(key, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001230 if (len == -1)
1231 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001232
William Dauchyc65f6562019-11-26 12:56:26 +01001233 /* decode value */
1234 if (value) {
1235 while (p < end && *p != '=' && *p != '&' && *p != '#')
1236 ++p;
1237 if (*p == '=')
1238 goto error;
1239 if (*p == '&')
1240 *(p++) = 0;
1241 else if (*p == '#')
1242 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001243 len = url_decode(value, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001244 if (len == -1)
1245 goto error;
1246 }
1247
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001248 if (strcmp(key, "scope") == 0) {
William Dauchyc65f6562019-11-26 12:56:26 +01001249 default_scopes = 0; /* at least a scope defined, unset default scopes */
1250 if (!value)
1251 goto error;
1252 else if (*value == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001253 appctx->ctx.stats.flags &= ~PROMEX_FL_SCOPE_ALL;
William Dauchyc65f6562019-11-26 12:56:26 +01001254 else if (*value == '*')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001255 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_ALL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001256 else if (strcmp(value, "global") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001257 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_GLOBAL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001258 else if (strcmp(value, "server") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001259 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_SERVER;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001260 else if (strcmp(value, "backend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001261 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_BACK;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001262 else if (strcmp(value, "frontend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001263 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_FRONT;
William Dauchy69164222021-02-07 20:42:38 +01001264 else if (strcmp(value, "sticktable") == 0)
1265 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_STICKTABLE;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001266 else
1267 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001268 }
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001269 else if (strcmp(key, "no-maint") == 0)
Christopher Fauleteba22942019-11-19 14:18:24 +01001270 appctx->ctx.stats.flags |= PROMEX_FL_NO_MAINT_SRV;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001271 }
1272
1273 end:
1274 appctx->ctx.stats.flags |= default_scopes;
1275 return 1;
1276
1277 error:
1278 err = &http_err_chunks[HTTP_ERR_400];
1279 channel_erase(res);
1280 res->buf.data = b_data(err);
1281 memcpy(res->buf.area, b_head(err), b_data(err));
1282 res_htx = htx_from_buf(&res->buf);
1283 channel_add_input(res, res_htx->data);
1284 appctx->st0 = PROMEX_ST_END;
1285 return -1;
1286}
1287
Christopher Fauletf959d082019-02-07 15:38:42 +01001288/* Send HTTP headers of the response. It returns 1 on success and 0 if <htx> is
1289 * full. */
1290static int promex_send_headers(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1291{
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001292 struct channel *chn = si_ic(appctx->owner);
Christopher Fauletf959d082019-02-07 15:38:42 +01001293 struct htx_sl *sl;
1294 unsigned int flags;
1295
1296 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);
1297 sl = htx_add_stline(htx, HTX_BLK_RES_SL, flags, ist("HTTP/1.1"), ist("200"), ist("OK"));
1298 if (!sl)
1299 goto full;
1300 sl->info.res.status = 200;
1301 if (!htx_add_header(htx, ist("Cache-Control"), ist("no-cache")) ||
Christopher Fauletf959d082019-02-07 15:38:42 +01001302 !htx_add_header(htx, ist("Content-Type"), ist("text/plain; version=0.0.4")) ||
1303 !htx_add_header(htx, ist("Transfer-Encoding"), ist("chunked")) ||
1304 !htx_add_endof(htx, HTX_BLK_EOH))
1305 goto full;
1306
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001307 channel_add_input(chn, htx->data);
Christopher Fauletf959d082019-02-07 15:38:42 +01001308 return 1;
1309 full:
1310 htx_reset(htx);
1311 si_rx_room_blk(si);
1312 return 0;
1313}
1314
1315/* The function returns 1 if the initialisation is complete, 0 if
1316 * an errors occurs and -1 if more data are required for initializing
1317 * the applet.
1318 */
1319static int promex_appctx_init(struct appctx *appctx, struct proxy *px, struct stream *strm)
1320{
1321 appctx->st0 = PROMEX_ST_INIT;
1322 return 1;
1323}
1324
1325/* The main I/O handler for the promex applet. */
1326static void promex_appctx_handle_io(struct appctx *appctx)
1327{
1328 struct stream_interface *si = appctx->owner;
1329 struct stream *s = si_strm(si);
1330 struct channel *req = si_oc(si);
1331 struct channel *res = si_ic(si);
1332 struct htx *req_htx, *res_htx;
1333 int ret;
1334
1335 res_htx = htx_from_buf(&res->buf);
Christopher Fauletf959d082019-02-07 15:38:42 +01001336 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1337 goto out;
1338
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001339 /* Check if the input buffer is available. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001340 if (!b_size(&res->buf)) {
1341 si_rx_room_blk(si);
1342 goto out;
1343 }
1344
1345 switch (appctx->st0) {
1346 case PROMEX_ST_INIT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001347 ret = promex_parse_uri(appctx, si);
1348 if (ret <= 0) {
1349 if (ret == -1)
1350 goto error;
1351 goto out;
1352 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001353 appctx->st0 = PROMEX_ST_HEAD;
1354 appctx->st1 = PROMEX_DUMPER_INIT;
1355 /* fall through */
1356
1357 case PROMEX_ST_HEAD:
1358 if (!promex_send_headers(appctx, si, res_htx))
1359 goto out;
1360 appctx->st0 = ((s->txn->meth == HTTP_METH_HEAD) ? PROMEX_ST_DONE : PROMEX_ST_DUMP);
1361 /* fall through */
1362
1363 case PROMEX_ST_DUMP:
1364 ret = promex_dump_metrics(appctx, si, res_htx);
1365 if (ret <= 0) {
1366 if (ret == -1)
1367 goto error;
1368 goto out;
1369 }
1370 appctx->st0 = PROMEX_ST_DONE;
1371 /* fall through */
1372
1373 case PROMEX_ST_DONE:
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001374 /* no more data are expected. Don't add TLR because mux-h1 will take care of it */
1375 res_htx->flags |= HTX_FL_EOM;
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001376 appctx->st0 = PROMEX_ST_END;
1377 /* fall through */
Christopher Fauletf959d082019-02-07 15:38:42 +01001378
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001379 case PROMEX_ST_END:
1380 if (!(res->flags & CF_SHUTR)) {
1381 res->flags |= CF_READ_NULL;
1382 si_shutr(si);
1383 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001384 }
1385
Christopher Fauletf959d082019-02-07 15:38:42 +01001386 out:
1387 htx_to_buf(res_htx, &res->buf);
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001388
1389 /* eat the whole request */
1390 if (co_data(req)) {
1391 req_htx = htx_from_buf(&req->buf);
1392 co_htx_skip(req, req_htx, co_data(req));
1393 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001394 return;
1395
1396 error:
1397 res->flags |= CF_READ_NULL;
1398 si_shutr(si);
1399 si_shutw(si);
1400}
1401
1402struct applet promex_applet = {
1403 .obj_type = OBJ_TYPE_APPLET,
1404 .name = "<PROMEX>", /* used for logging */
1405 .init = promex_appctx_init,
1406 .fct = promex_appctx_handle_io,
1407};
1408
1409static enum act_parse_ret service_parse_prometheus_exporter(const char **args, int *cur_arg, struct proxy *px,
1410 struct act_rule *rule, char **err)
1411{
1412 /* Prometheus exporter service is only available on "http-request" rulesets */
1413 if (rule->from != ACT_F_HTTP_REQ) {
1414 memprintf(err, "Prometheus exporter service only available on 'http-request' rulesets");
1415 return ACT_RET_PRS_ERR;
1416 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001417
1418 /* Add applet pointer in the rule. */
1419 rule->applet = promex_applet;
1420
1421 return ACT_RET_PRS_OK;
1422}
1423static void promex_register_build_options(void)
1424{
1425 char *ptr = NULL;
1426
1427 memprintf(&ptr, "Built with the Prometheus exporter as a service");
1428 hap_register_build_opts(ptr, 1);
1429}
1430
1431
1432static struct action_kw_list service_actions = { ILH, {
1433 { "prometheus-exporter", service_parse_prometheus_exporter },
1434 { /* END */ }
1435}};
1436
1437INITCALL1(STG_REGISTER, service_keywords_register, &service_actions);
1438INITCALL0(STG_REGISTER, promex_register_build_options);