blob: debe2f60cb431b0deccbd777e771af4e155bce12 [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 Tarreaub2551052020-06-09 09:07:15 +020022#include <haproxy/compression.h>
Christopher Fauletc55a6262020-07-10 15:39:39 +020023#include <haproxy/dns.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020024#include <haproxy/frontend.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020025#include <haproxy/global.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020026#include <haproxy/http.h>
Willy Tarreau87735332020-06-04 09:08:41 +020027#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020028#include <haproxy/htx.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020029#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020030#include <haproxy/listener.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020031#include <haproxy/log.h>
Willy Tarreau551271d2020-06-04 08:32:23 +020032#include <haproxy/pipe.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020033#include <haproxy/pool.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020034#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020035#include <haproxy/sample.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020036#include <haproxy/server.h>
Willy Tarreau209108d2020-06-04 20:30:20 +020037#include <haproxy/ssl_sock.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020038#include <haproxy/stats.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020039#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020040#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020041#include <haproxy/task.h>
William Dauchy5a982a72021-01-08 13:18:06 +010042#include <haproxy/version.h>
Christopher Fauletf959d082019-02-07 15:38:42 +010043
44/* Prometheus exporter applet states (appctx->st0) */
45enum {
46 PROMEX_ST_INIT = 0, /* initialized */
47 PROMEX_ST_HEAD, /* send headers before dump */
48 PROMEX_ST_DUMP, /* dumping stats */
49 PROMEX_ST_DONE, /* finished */
Christopher Faulet9744f7c2019-03-27 15:48:53 +010050 PROMEX_ST_END, /* treatment terminated */
Christopher Fauletf959d082019-02-07 15:38:42 +010051};
52
53/* Prometheus exporter dumper states (appctx->st1) */
54enum {
55 PROMEX_DUMPER_INIT = 0, /* initialized */
56 PROMEX_DUMPER_GLOBAL, /* dump metrics of globals */
57 PROMEX_DUMPER_FRONT, /* dump metrics of frontend proxies */
58 PROMEX_DUMPER_BACK, /* dump metrics of backend proxies */
59 PROMEX_DUMPER_LI, /* dump metrics of listeners */
60 PROMEX_DUMPER_SRV, /* dump metrics of servers */
61 PROMEX_DUMPER_DONE, /* finished */
62};
63
64/* Prometheus exporter flags (appctx->ctx.stats.flags) */
65#define PROMEX_FL_METRIC_HDR 0x00000001
66#define PROMEX_FL_INFO_METRIC 0x00000002
Christopher Fauletb713c4f2021-01-20 15:02:50 +010067#define PROMEX_FL_FRONT_METRIC 0x00000004
68#define PROMEX_FL_BACK_METRIC 0x00000008
69#define PROMEX_FL_SRV_METRIC 0x00000010
70#define PROMEX_FL_SCOPE_GLOBAL 0x00000020
71#define PROMEX_FL_SCOPE_FRONT 0x00000040
72#define PROMEX_FL_SCOPE_BACK 0x00000080
73#define PROMEX_FL_SCOPE_SERVER 0x00000100
74#define PROMEX_FL_NO_MAINT_SRV 0x00000200
Christopher Faulet78407ce2019-11-18 14:47:08 +010075
76#define PROMEX_FL_SCOPE_ALL (PROMEX_FL_SCOPE_GLOBAL|PROMEX_FL_SCOPE_FRONT|PROMEX_FL_SCOPE_BACK|PROMEX_FL_SCOPE_SERVER)
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
116 [INF_BUILD_INFO] = { .n = IST("build_info"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
117 [INF_NBTHREAD] = { .n = IST("nbthread"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
118 [INF_NBPROC] = { .n = IST("nbproc"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
119 [INF_PROCESS_NUM] = { .n = IST("relative_process_id"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
120 //[INF_PID] ignored
121 //[INF_UPTIME] ignored
122 [INF_UPTIME_SEC] = { .n = IST("uptime_seconds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
123 [INF_START_TIME_SEC] = { .n = IST("start_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
124 [INF_MEMMAX_BYTES] = { .n = IST("max_memory_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
125 [INF_POOL_ALLOC_BYTES] = { .n = IST("pool_allocated_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
126 [INF_POOL_USED_BYTES] = { .n = IST("pool_used_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
127 [INF_POOL_FAILED] = { .n = IST("pool_failures_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
128 [INF_ULIMIT_N] = { .n = IST("max_fds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
129 [INF_MAXSOCK] = { .n = IST("max_sockets"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
130 [INF_MAXCONN] = { .n = IST("max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
131 [INF_HARD_MAXCONN] = { .n = IST("hard_max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
132 [INF_CURR_CONN] = { .n = IST("current_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
133 [INF_CUM_CONN] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
134 [INF_CUM_REQ] = { .n = IST("requests_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
135 [INF_MAX_SSL_CONNS] = { .n = IST("max_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
136 [INF_CURR_SSL_CONNS] = { .n = IST("current_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
137 [INF_CUM_SSL_CONNS] = { .n = IST("ssl_connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
138 [INF_MAXPIPES] = { .n = IST("max_pipes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
139 [INF_PIPES_USED] = { .n = IST("pipes_used_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
140 [INF_PIPES_FREE] = { .n = IST("pipes_free_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
141 [INF_CONN_RATE] = { .n = IST("current_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
142 [INF_CONN_RATE_LIMIT] = { .n = IST("limit_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
143 [INF_MAX_CONN_RATE] = { .n = IST("max_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
144 [INF_SESS_RATE] = { .n = IST("current_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
145 [INF_SESS_RATE_LIMIT] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
146 [INF_MAX_SESS_RATE] = { .n = IST("max_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
147 [INF_SSL_RATE] = { .n = IST("current_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
148 [INF_SSL_RATE_LIMIT] = { .n = IST("limit_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
149 [INF_MAX_SSL_RATE] = { .n = IST("max_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
150 [INF_SSL_FRONTEND_KEY_RATE] = { .n = IST("current_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
151 [INF_SSL_FRONTEND_MAX_KEY_RATE] = { .n = IST("max_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
152 [INF_SSL_FRONTEND_SESSION_REUSE_PCT] = { .n = IST("frontend_ssl_reuse"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
153 [INF_SSL_BACKEND_KEY_RATE] = { .n = IST("current_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
154 [INF_SSL_BACKEND_MAX_KEY_RATE] = { .n = IST("max_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
155 [INF_SSL_CACHE_LOOKUPS] = { .n = IST("ssl_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
156 [INF_SSL_CACHE_MISSES] = { .n = IST("ssl_cache_misses_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
157 [INF_COMPRESS_BPS_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
158 [INF_COMPRESS_BPS_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
159 [INF_COMPRESS_BPS_RATE_LIM] = { .n = IST("limit_http_comp"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
160 [INF_ZLIB_MEM_USAGE] = { .n = IST("current_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
161 [INF_MAX_ZLIB_MEM_USAGE] = { .n = IST("max_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
162 [INF_TASKS] = { .n = IST("current_tasks"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
163 [INF_RUN_QUEUE] = { .n = IST("current_run_queue"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
164 [INF_IDLE_PCT] = { .n = IST("idle_time_percent"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
165 //[INF_NODE] ignored
166 //[INF_DESCRIPTION] ignored
167 [INF_STOPPING] = { .n = IST("stopping"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
168 [INF_JOBS] = { .n = IST("jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
169 [INF_UNSTOPPABLE_JOBS] = { .n = IST("unstoppable_jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
170 [INF_LISTENERS] = { .n = IST("listeners"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
171 [INF_ACTIVE_PEERS] = { .n = IST("active_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
172 [INF_CONNECTED_PEERS] = { .n = IST("connected_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
173 [INF_DROPPED_LOGS] = { .n = IST("dropped_logs_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
174 [INF_BUSY_POLLING] = { .n = IST("busy_polling_enabled"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
175 [INF_FAILED_RESOLUTIONS] = { .n = IST("failed_resolutions"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
176 [INF_TOTAL_BYTES_OUT] = { .n = IST("bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
177 [INF_TOTAL_SPLICED_BYTES_OUT] = { .n = IST("spliced_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
178 [INF_BYTES_OUT_RATE] = { .n = IST("bytes_out_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
179 //[INF_DEBUG_COMMANDS_ISSUED] ignored
Christopher Fauletf959d082019-02-07 15:38:42 +0100180};
181
Christopher Faulet37286a52021-01-20 15:20:53 +0100182/* frontend/backend/server fields */
183const struct promex_metric promex_st_metrics[ST_F_TOTAL_FIELDS] = {
184 //[ST_F_PXNAME] ignored
185 //[ST_F_SVNAME] ignored
186 [ST_F_QCUR] = { .n = IST("current_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
187 [ST_F_QMAX] = { .n = IST("max_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
188 [ST_F_SCUR] = { .n = IST("current_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
189 [ST_F_SMAX] = { .n = IST("max_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
190 [ST_F_SLIM] = { .n = IST("limit_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
191 [ST_F_STOT] = { .n = IST("sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
192 [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) },
193 [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) },
194 [ST_F_DREQ] = { .n = IST("requests_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
195 [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) },
196 [ST_F_EREQ] = { .n = IST("request_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
197 [ST_F_ECON] = { .n = IST("connection_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
198 [ST_F_ERESP] = { .n = IST("response_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
199 [ST_F_WRETR] = { .n = IST("retry_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
200 [ST_F_WREDIS] = { .n = IST("redispatch_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
201 [ST_F_STATUS] = { .n = IST("status"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
202 [ST_F_WEIGHT] = { .n = IST("weight"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
203 [ST_F_ACT] = { .n = IST("active_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
204 [ST_F_BCK] = { .n = IST("backup_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
205 [ST_F_CHKFAIL] = { .n = IST("check_failures_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_SRV_METRIC) },
206 [ST_F_CHKDOWN] = { .n = IST("check_up_down_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
207 [ST_F_LASTCHG] = { .n = IST("check_last_change_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
208 [ST_F_DOWNTIME] = { .n = IST("downtime_seconds_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
209 [ST_F_QLIMIT] = { .n = IST("queue_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
210 //[ST_F_PID] ignored
211 //[ST_F_IID] ignored
212 //[ST_F_SID] ignored
213 [ST_F_THROTTLE] = { .n = IST("current_throttle"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
214 [ST_F_LBTOT] = { .n = IST("loadbalanced_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
215 //[ST_F_TRACKED] ignored
216 //[ST_F_TYPE] ignored
217 //[ST_F_RATE] ignored
218 [ST_F_RATE_LIM] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
219 [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) },
220 [ST_F_CHECK_STATUS] = { .n = IST("check_status"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
221 [ST_F_CHECK_CODE] = { .n = IST("check_code"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
222 [ST_F_CHECK_DURATION] = { .n = IST("check_duration_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
223 [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) },
224 [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) },
225 [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) },
226 [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) },
227 [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) },
228 [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) },
229 //[ST_F_HANAFAIL] ignored
230 //[ST_F_REQ_RATE] ignored
231 [ST_F_REQ_RATE_MAX] = { .n = IST("http_requests_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
232 [ST_F_REQ_TOT] = { .n = IST("http_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
233 [ST_F_CLI_ABRT] = { .n = IST("client_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
234 [ST_F_SRV_ABRT] = { .n = IST("server_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
235 [ST_F_COMP_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
236 [ST_F_COMP_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
237 [ST_F_COMP_BYP] = { .n = IST("http_comp_bytes_bypassed_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
238 [ST_F_COMP_RSP] = { .n = IST("http_comp_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
239 [ST_F_LASTSESS] = { .n = IST("last_session_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
240 //[ST_F_LAST_CHK] ignroed
241 //[ST_F_LAST_AGT] ignored
242 [ST_F_QTIME] = { .n = IST("queue_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
243 [ST_F_CTIME] = { .n = IST("connect_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
244 [ST_F_RTIME] = { .n = IST("response_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
245 [ST_F_TTIME] = { .n = IST("total_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
246 //[ST_F_AGENT_STATUS] ignored
247 //[ST_F_AGENT_CODE] ignored
248 //[ST_F_AGENT_DURATION] ignored
249 //[ST_F_CHECK_DESC] ignored
250 //[ST_F_AGENT_DESC] ignored
251 //[ST_F_CHECK_RISE] ignored
252 //[ST_F_CHECK_FALL] ignored
253 //[ST_F_CHECK_HEALTH] ignored
254 //[ST_F_AGENT_RISE] ignored
255 //[ST_F_AGENT_FALL] ignored
256 //[ST_F_AGENT_HEALTH] ignored
257 //[ST_F_ADDR] ignored
258 //[ST_F_COOKIE] ignored
259 //[ST_F_MODE] ignored
260 //[ST_F_ALGO] ignored
261 //[ST_F_CONN_RATE] ignored
262 [ST_F_CONN_RATE_MAX] = { .n = IST("connections_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
263 [ST_F_CONN_TOT] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
264 [ST_F_INTERCEPTED] = { .n = IST("intercepted_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
265 [ST_F_DCON] = { .n = IST("denied_connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
266 [ST_F_DSES] = { .n = IST("denied_sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
267 [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) },
268 [ST_F_CONNECT] = { .n = IST("connection_attempts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
269 [ST_F_REUSE] = { .n = IST("connection_reuses_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
270 [ST_F_CACHE_LOOKUPS] = { .n = IST("http_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
271 [ST_F_CACHE_HITS] = { .n = IST("http_cache_hits_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
272 [ST_F_SRV_ICUR] = { .n = IST("idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
273 [ST_F_SRV_ILIM] = { .n = IST("idle_connections_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
274 [ST_F_QT_MAX] = { .n = IST("max_queue_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
275 [ST_F_CT_MAX] = { .n = IST("max_connect_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
276 [ST_F_RT_MAX] = { .n = IST("max_response_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
277 [ST_F_TT_MAX] = { .n = IST("max_total_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
278 [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) },
279 [ST_F_IDLE_CONN_CUR] = { .n = IST("unsafe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
280 [ST_F_SAFE_CONN_CUR]= { .n = IST("safe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
281 [ST_F_USED_CONN_CUR] = { .n = IST("used_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
282 [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 +0100283 [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 +0100284};
285
William Dauchy82b2ce22021-02-01 13:11:55 +0100286/* Description of overriden stats fields */
Christopher Fauletf959d082019-02-07 15:38:42 +0100287const struct ist promex_st_metric_desc[ST_F_TOTAL_FIELDS] = {
288 [ST_F_PXNAME] = IST("The proxy name."),
289 [ST_F_SVNAME] = IST("The service name (FRONTEND for frontend, BACKEND for backend, any name for server/listener)."),
290 [ST_F_QCUR] = IST("Current number of queued requests."),
291 [ST_F_QMAX] = IST("Maximum observed number of queued requests."),
292 [ST_F_SCUR] = IST("Current number of active sessions."),
293 [ST_F_SMAX] = IST("Maximum observed number of active sessions."),
294 [ST_F_SLIM] = IST("Configured session limit."),
295 [ST_F_STOT] = IST("Total number of sessions."),
296 [ST_F_BIN] = IST("Current total of incoming bytes."),
297 [ST_F_BOUT] = IST("Current total of outgoing bytes."),
298 [ST_F_DREQ] = IST("Total number of denied requests."),
299 [ST_F_DRESP] = IST("Total number of denied responses."),
300 [ST_F_EREQ] = IST("Total number of request errors."),
301 [ST_F_ECON] = IST("Total number of connection errors."),
302 [ST_F_ERESP] = IST("Total number of response errors."),
303 [ST_F_WRETR] = IST("Total number of retry warnings."),
304 [ST_F_WREDIS] = IST("Total number of redispatch warnings."),
William Dauchya1da7ba2021-02-01 13:11:52 +0100305 [ST_F_STATUS] = IST("Current status of the service, per state label value."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100306 [ST_F_WEIGHT] = IST("Service weight."),
307 [ST_F_ACT] = IST("Current number of active servers."),
308 [ST_F_BCK] = IST("Current number of backup servers."),
309 [ST_F_CHKFAIL] = IST("Total number of failed check (Only counts checks failed when the server is up)."),
310 [ST_F_CHKDOWN] = IST("Total number of UP->DOWN transitions."),
311 [ST_F_LASTCHG] = IST("Number of seconds since the last UP<->DOWN transition."),
312 [ST_F_DOWNTIME] = IST("Total downtime (in seconds) for the service."),
313 [ST_F_QLIMIT] = IST("Configured maxqueue for the server (0 meaning no limit)."),
314 [ST_F_PID] = IST("Process id (0 for first instance, 1 for second, ...)"),
315 [ST_F_IID] = IST("Unique proxy id."),
316 [ST_F_SID] = IST("Server id (unique inside a proxy)."),
317 [ST_F_THROTTLE] = IST("Current throttle percentage for the server, when slowstart is active, or no value if not in slowstart."),
318 [ST_F_LBTOT] = IST("Total number of times a service was selected, either for new sessions, or when redispatching."),
319 [ST_F_TRACKED] = IST("Id of proxy/server if tracking is enabled."),
320 [ST_F_TYPE] = IST("Service type (0=frontend, 1=backend, 2=server, 3=socket/listener)."),
321 [ST_F_RATE] = IST("Current number of sessions per second over last elapsed second."),
322 [ST_F_RATE_LIM] = IST("Configured limit on new sessions per second."),
323 [ST_F_RATE_MAX] = IST("Maximum observed number of sessions per second."),
William Dauchyde3c3262021-02-01 13:11:51 +0100324 [ST_F_CHECK_STATUS] = IST("Status of last health check, per state label value."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100325 [ST_F_CHECK_CODE] = IST("layer5-7 code, if available of the last health check."),
Christopher Faulet2711e512020-02-27 16:12:07 +0100326 [ST_F_CHECK_DURATION] = IST("Total duration of the latest server health check, in seconds."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100327 [ST_F_QTIME] = IST("Avg. queue time for last 1024 successful connections."),
328 [ST_F_CTIME] = IST("Avg. connect time for last 1024 successful connections."),
329 [ST_F_RTIME] = IST("Avg. response time for last 1024 successful connections."),
330 [ST_F_TTIME] = IST("Avg. total time for last 1024 successful connections."),
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100331 [ST_F_QT_MAX] = IST("Maximum observed time spent in the queue"),
332 [ST_F_CT_MAX] = IST("Maximum observed time spent waiting for a connection to complete"),
333 [ST_F_RT_MAX] = IST("Maximum observed time spent waiting for a server response"),
334 [ST_F_TT_MAX] = IST("Maximum observed total request+response time (request+queue+connect+response+processing)"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100335};
336
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100337/* Specific labels for all ST_F_HRSP_* fields */
338const struct ist promex_hrsp_code[1 + ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = {
339 [ST_F_HRSP_1XX - ST_F_HRSP_1XX] = IST("1xx"),
340 [ST_F_HRSP_2XX - ST_F_HRSP_1XX] = IST("2xx"),
341 [ST_F_HRSP_3XX - ST_F_HRSP_1XX] = IST("3xx"),
342 [ST_F_HRSP_4XX - ST_F_HRSP_1XX] = IST("4xx"),
343 [ST_F_HRSP_5XX - ST_F_HRSP_1XX] = IST("5xx"),
344 [ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = IST("other"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100345};
346
William Dauchy54938212021-01-27 22:40:16 +0100347enum promex_front_state {
348 PROMEX_FRONT_STATE_DOWN = 0,
349 PROMEX_FRONT_STATE_UP,
350
351 PROMEX_FRONT_STATE_COUNT /* must be last */
352};
353
354const struct ist promex_front_st[PROMEX_FRONT_STATE_COUNT] = {
355 [PROMEX_FRONT_STATE_DOWN] = IST("DOWN"),
356 [PROMEX_FRONT_STATE_UP] = IST("UP"),
357};
358
359enum promex_back_state {
360 PROMEX_BACK_STATE_DOWN = 0,
361 PROMEX_BACK_STATE_UP,
362
363 PROMEX_BACK_STATE_COUNT /* must be last */
364};
365
366const struct ist promex_back_st[PROMEX_BACK_STATE_COUNT] = {
367 [PROMEX_BACK_STATE_DOWN] = IST("DOWN"),
368 [PROMEX_BACK_STATE_UP] = IST("UP"),
369};
370
371enum promex_srv_state {
372 PROMEX_SRV_STATE_DOWN = 0,
373 PROMEX_SRV_STATE_UP,
374 PROMEX_SRV_STATE_MAINT,
375 PROMEX_SRV_STATE_DRAIN,
376 PROMEX_SRV_STATE_NOLB,
377
378 PROMEX_SRV_STATE_COUNT /* must be last */
379};
380
381const struct ist promex_srv_st[PROMEX_SRV_STATE_COUNT] = {
382 [PROMEX_SRV_STATE_DOWN] = IST("DOWN"),
383 [PROMEX_SRV_STATE_UP] = IST("UP"),
384 [PROMEX_SRV_STATE_MAINT] = IST("MAINT"),
385 [PROMEX_SRV_STATE_DRAIN] = IST("DRAIN"),
386 [PROMEX_SRV_STATE_NOLB] = IST("NOLB"),
387};
388
389/* Return the server status. */
390enum promex_srv_state promex_srv_status(struct server *sv)
Christopher Fauletf959d082019-02-07 15:38:42 +0100391{
William Dauchy54938212021-01-27 22:40:16 +0100392 int state = PROMEX_SRV_STATE_DOWN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100393
Christopher Fauletf959d082019-02-07 15:38:42 +0100394 if (sv->cur_state == SRV_ST_RUNNING || sv->cur_state == SRV_ST_STARTING) {
William Dauchy54938212021-01-27 22:40:16 +0100395 state = PROMEX_SRV_STATE_UP;
Christopher Fauletf959d082019-02-07 15:38:42 +0100396 if (sv->cur_admin & SRV_ADMF_DRAIN)
William Dauchy54938212021-01-27 22:40:16 +0100397 state = PROMEX_SRV_STATE_DRAIN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100398 }
Christopher Fauletd45d1052019-09-06 16:10:19 +0200399 else if (sv->cur_state == SRV_ST_STOPPING)
William Dauchy54938212021-01-27 22:40:16 +0100400 state = PROMEX_SRV_STATE_NOLB;
Christopher Fauletd45d1052019-09-06 16:10:19 +0200401
402 if (sv->cur_admin & SRV_ADMF_MAINT)
William Dauchy54938212021-01-27 22:40:16 +0100403 state = PROMEX_SRV_STATE_MAINT;
Christopher Fauletf959d082019-02-07 15:38:42 +0100404
405 return state;
406}
407
408/* Convert a field to its string representation and write it in <out>, followed
409 * by a newline, if there is enough space. non-numeric value are converted in
William Dauchy18a2c6e2021-01-22 21:09:47 +0100410 * "NaN" because Prometheus only support numerical values (but it is unexepceted
Christopher Fauletf959d082019-02-07 15:38:42 +0100411 * to process this kind of value). It returns 1 on success. Otherwise, it
412 * returns 0. The buffer's length must not exceed <max> value.
413 */
414static int promex_metric_to_str(struct buffer *out, struct field *f, size_t max)
415{
416 int ret = 0;
417
418 switch (field_format(f, 0)) {
William Dauchy18a2c6e2021-01-22 21:09:47 +0100419 case FF_EMPTY: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100420 case FF_S32: ret = chunk_appendf(out, "%d\n", f->u.s32); break;
421 case FF_U32: ret = chunk_appendf(out, "%u\n", f->u.u32); break;
422 case FF_S64: ret = chunk_appendf(out, "%lld\n", (long long)f->u.s64); break;
423 case FF_U64: ret = chunk_appendf(out, "%llu\n", (unsigned long long)f->u.u64); break;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200424 case FF_FLT: ret = chunk_appendf(out, "%f\n", f->u.flt); break;
William Dauchy18a2c6e2021-01-22 21:09:47 +0100425 case FF_STR: ret = chunk_strcat(out, "NaN\n"); break;
426 default: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100427 }
428 if (!ret || out->data > max)
429 return 0;
430 return 1;
431}
432
Christopher Fauletf959d082019-02-07 15:38:42 +0100433/* Dump the header lines for <metric>. It is its #HELP and #TYPE strings. It
434 * returns 1 on success. Otherwise, if <out> length exceeds <max>, it returns 0.
435 */
436static int promex_dump_metric_header(struct appctx *appctx, struct htx *htx,
Christopher Faulet37286a52021-01-20 15:20:53 +0100437 const struct promex_metric *metric, const struct ist name,
438 struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100439{
Christopher Faulet37286a52021-01-20 15:20:53 +0100440 struct ist type;
William Dauchy82b2ce22021-02-01 13:11:55 +0100441 struct ist desc;
Christopher Faulet37286a52021-01-20 15:20:53 +0100442
443 switch (metric->type) {
444 case PROMEX_MT_COUNTER:
445 type = ist("counter");
446 break;
447 default:
448 type = ist("gauge");
449 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100450
William Dauchya191b772021-01-15 22:41:39 +0100451 if (istcat(out, ist("# HELP "), max) == -1 ||
452 istcat(out, name, max) == -1 ||
453 istcat(out, ist(" "), max) == -1)
454 goto full;
455
William Dauchy82b2ce22021-02-01 13:11:55 +0100456 if (metric->flags & PROMEX_FL_INFO_METRIC)
457 desc = ist(info_fields[appctx->st2].desc);
458 else if (!isttest(promex_st_metric_desc[appctx->st2]))
459 desc = ist(stat_fields[appctx->st2].desc);
460 else
461 desc = promex_st_metric_desc[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100462
William Dauchy82b2ce22021-02-01 13:11:55 +0100463 if (istcat(out, desc, max) == -1 ||
464 istcat(out, ist("\n# TYPE "), max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100465 istcat(out, name, max) == -1 ||
466 istcat(out, ist(" "), max) == -1 ||
Christopher Faulet37286a52021-01-20 15:20:53 +0100467 istcat(out, type, max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100468 istcat(out, ist("\n"), max) == -1)
469 goto full;
470
471 return 1;
472
473 full:
474 return 0;
475}
476
477/* Dump the line for <metric>. It starts by the metric name followed by its
478 * labels (proxy name, server name...) between braces and finally its value. If
479 * not already done, the header lines are dumped first. It returns 1 on
480 * success. Otherwise if <out> length exceeds <max>, it returns 0.
481 */
Christopher Faulet37286a52021-01-20 15:20:53 +0100482static int promex_dump_metric(struct appctx *appctx, struct htx *htx, struct ist prefix,
William Dauchyc6464592021-01-27 22:40:17 +0100483 const struct promex_metric *metric, struct field *val,
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100484 struct promex_label *labels, struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100485{
486 struct ist name = { .ptr = (char[PROMEX_MAX_NAME_LEN]){ 0 }, .len = 0 };
487 size_t len = out->len;
488
489 if (out->len + PROMEX_MAX_METRIC_LENGTH > max)
490 return 0;
491
Christopher Faulet37286a52021-01-20 15:20:53 +0100492 /* Fill the metric name */
493 istcat(&name, prefix, PROMEX_MAX_NAME_LEN);
494 istcat(&name, metric->n, PROMEX_MAX_NAME_LEN);
495
496
Christopher Fauletf959d082019-02-07 15:38:42 +0100497 if ((appctx->ctx.stats.flags & PROMEX_FL_METRIC_HDR) &&
Christopher Faulet37286a52021-01-20 15:20:53 +0100498 !promex_dump_metric_header(appctx, htx, metric, name, out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100499 goto full;
500
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100501 if (istcat(out, name, max) == -1)
502 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100503
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100504 if (isttest(labels[0].name)) {
505 int i;
506
507 if (istcat(out, ist("{"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100508 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100509
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100510 for (i = 0; isttest(labels[i].name); i++) {
511 if (!isttest(labels[i].value))
512 continue;
513
514 if ((i && istcat(out, ist(","), max) == -1) ||
515 istcat(out, labels[i].name, max) == -1 ||
516 istcat(out, ist("=\""), max) == -1 ||
517 istcat(out, labels[i].value, max) == -1 ||
518 istcat(out, ist("\""), max) == -1)
519 goto full;
520 }
521
522 if (istcat(out, ist("}"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100523 goto full;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100524
Christopher Fauletf959d082019-02-07 15:38:42 +0100525 }
526
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100527 if (istcat(out, ist(" "), max) == -1)
528 goto full;
529
Christopher Fauletf959d082019-02-07 15:38:42 +0100530 trash.data = out->len;
Christopher Faulet37286a52021-01-20 15:20:53 +0100531 if (!promex_metric_to_str(&trash, val, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100532 goto full;
533 out->len = trash.data;
534
535 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
536 return 1;
537 full:
538 // Restore previous length
539 out->len = len;
540 return 0;
541
542}
543
544
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500545/* Dump global metrics (prefixed by "haproxy_process_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100546 * 0 if <htx> is full and -1 in case of any error. */
547static int promex_dump_global_metrics(struct appctx *appctx, struct htx *htx)
548{
549 static struct ist prefix = IST("haproxy_process_");
Christopher Faulet37286a52021-01-20 15:20:53 +0100550 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100551 struct channel *chn = si_ic(appctx->owner);
552 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200553 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
Christopher Fauletf959d082019-02-07 15:38:42 +0100554 int ret = 1;
555
William Dauchy5d9b8f32021-01-11 20:07:49 +0100556 if (!stats_fill_info(info, INF_TOTAL_FIELDS))
557 return -1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100558
Christopher Faulet37286a52021-01-20 15:20:53 +0100559 for (; appctx->st2 < INF_TOTAL_FIELDS; appctx->st2++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100560 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
561
Christopher Faulet37286a52021-01-20 15:20:53 +0100562 if (!(promex_global_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
563 continue;
564
Christopher Fauletf959d082019-02-07 15:38:42 +0100565 switch (appctx->st2) {
William Dauchy5a982a72021-01-08 13:18:06 +0100566 case INF_BUILD_INFO:
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100567 labels[0].name = ist("version");
568 labels[0].value = ist(HAPROXY_VERSION);
Christopher Faulet37286a52021-01-20 15:20:53 +0100569 val = mkf_u32(FN_GAUGE, 1);
William Dauchy5a982a72021-01-08 13:18:06 +0100570 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100571
572 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100573 val = info[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100574 }
575
William Dauchyc6464592021-01-27 22:40:17 +0100576 if (!promex_dump_metric(appctx, htx, prefix, &promex_global_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100577 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100578 goto full;
579
Christopher Fauletf959d082019-02-07 15:38:42 +0100580 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Christopher Fauletf959d082019-02-07 15:38:42 +0100581 }
582
583 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200584 if (out.len) {
585 if (!htx_add_data_atonce(htx, out))
586 return -1; /* Unexpected and unrecoverable error */
587 channel_add_input(chn, out.len);
588 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100589 return ret;
590 full:
591 ret = 0;
592 goto end;
593}
594
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500595/* Dump frontends metrics (prefixed by "haproxy_frontend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100596 * 0 if <htx> is full and -1 in case of any error. */
597static int promex_dump_front_metrics(struct appctx *appctx, struct htx *htx)
598{
599 static struct ist prefix = IST("haproxy_frontend_");
600 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100601 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100602 struct channel *chn = si_ic(appctx->owner);
603 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200604 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchyb9577452021-01-17 18:27:46 +0100605 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100606 int ret = 1;
William Dauchyc6464592021-01-27 22:40:17 +0100607 enum promex_front_state state;
William Dauchyc6464592021-01-27 22:40:17 +0100608 int i;
Christopher Fauletf959d082019-02-07 15:38:42 +0100609
Christopher Faulet37286a52021-01-20 15:20:53 +0100610 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
611 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
612 continue;
613
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200614 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100615 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
616
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200617 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100618
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100619 labels[0].name = ist("proxy");
620 labels[0].value = ist2(px->id, strlen(px->id));
621
Christopher Fauletf959d082019-02-07 15:38:42 +0100622 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200623 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_FE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100624 goto next_px;
625
William Dauchyb9577452021-01-17 18:27:46 +0100626 if (!stats_fill_fe_stats(px, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
627 return -1;
628
Christopher Fauletf959d082019-02-07 15:38:42 +0100629 switch (appctx->st2) {
630 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100631 state = !px->disabled;
632 for (i = 0; i < PROMEX_FRONT_STATE_COUNT; i++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100633 labels[1].name = ist("state");
634 labels[1].value = promex_front_st[i];
William Dauchyc6464592021-01-27 22:40:17 +0100635 val = mkf_u32(FO_STATUS, state == i);
William Dauchyc6464592021-01-27 22:40:17 +0100636 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100637 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100638 goto full;
639 }
640 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100641 case ST_F_REQ_RATE_MAX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100642 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100643 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100644 case ST_F_INTERCEPTED:
Christopher Fauletf959d082019-02-07 15:38:42 +0100645 case ST_F_CACHE_LOOKUPS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100646 case ST_F_CACHE_HITS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100647 case ST_F_COMP_IN:
Christopher Fauletf959d082019-02-07 15:38:42 +0100648 case ST_F_COMP_OUT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100649 case ST_F_COMP_BYP:
William Dauchyb9577452021-01-17 18:27:46 +0100650 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100651 if (px->mode != PR_MODE_HTTP)
652 goto next_px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100653 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100654 break;
William Dauchyb9577452021-01-17 18:27:46 +0100655 case ST_F_HRSP_2XX:
656 case ST_F_HRSP_3XX:
657 case ST_F_HRSP_4XX:
658 case ST_F_HRSP_5XX:
659 case ST_F_HRSP_OTHER:
Christopher Fauletf959d082019-02-07 15:38:42 +0100660 if (px->mode != PR_MODE_HTTP)
661 goto next_px;
William Dauchyb9577452021-01-17 18:27:46 +0100662 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100663 labels[1].name = ist("code");
664 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
665 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100666 break;
667
668 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100669 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100670 }
671
William Dauchyc6464592021-01-27 22:40:17 +0100672 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100673 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100674 goto full;
675 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200676 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100677 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100678 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200679 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100680 }
681
682 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200683 if (out.len) {
684 if (!htx_add_data_atonce(htx, out))
685 return -1; /* Unexpected and unrecoverable error */
686 channel_add_input(chn, out.len);
687 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100688 return ret;
689 full:
690 ret = 0;
691 goto end;
692}
693
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500694/* Dump backends metrics (prefixed by "haproxy_backend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100695 * 0 if <htx> is full and -1 in case of any error. */
696static int promex_dump_back_metrics(struct appctx *appctx, struct htx *htx)
697{
698 static struct ist prefix = IST("haproxy_backend_");
699 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100700 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100701 struct channel *chn = si_ic(appctx->owner);
702 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200703 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchy3c6f0062021-01-25 17:29:02 +0100704 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100705 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200706 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100707 enum promex_back_state state;
William Dauchyc6464592021-01-27 22:40:17 +0100708 int i;
Christopher Fauletf959d082019-02-07 15:38:42 +0100709
Christopher Faulet37286a52021-01-20 15:20:53 +0100710 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
711 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
712 continue;
713
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200714 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100715 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
716
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200717 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100718
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100719 labels[0].name = ist("proxy");
720 labels[0].value = ist2(px->id, strlen(px->id));
721
Christopher Fauletf959d082019-02-07 15:38:42 +0100722 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200723 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100724 goto next_px;
725
William Dauchy3c6f0062021-01-25 17:29:02 +0100726 if (!stats_fill_be_stats(px, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
727 return -1;
728
Christopher Fauletf959d082019-02-07 15:38:42 +0100729 switch (appctx->st2) {
730 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100731 state = ((px->lbprm.tot_weight > 0 || !px->srv) ? 1 : 0);
732 for (i = 0; i < PROMEX_BACK_STATE_COUNT; i++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100733 labels[1].name = ist("state");
734 labels[1].value = promex_back_st[i];
William Dauchyc6464592021-01-27 22:40:17 +0100735 val = mkf_u32(FO_STATUS, state == i);
William Dauchyc6464592021-01-27 22:40:17 +0100736 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100737 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100738 goto full;
739 }
740 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100741 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200742 secs = (double)swrate_avg(px->be_counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100743 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100744 break;
745 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200746 secs = (double)swrate_avg(px->be_counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100747 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100748 break;
749 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200750 secs = (double)swrate_avg(px->be_counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100751 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100752 break;
753 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200754 secs = (double)swrate_avg(px->be_counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100755 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100756 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100757 case ST_F_QT_MAX:
758 secs = (double)px->be_counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100759 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100760 break;
761 case ST_F_CT_MAX:
762 secs = (double)px->be_counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100763 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100764 break;
765 case ST_F_RT_MAX:
766 secs = (double)px->be_counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100767 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100768 break;
769 case ST_F_TT_MAX:
770 secs = (double)px->be_counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100771 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100772 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100773 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100774 case ST_F_HRSP_1XX:
William Dauchy3c6f0062021-01-25 17:29:02 +0100775 case ST_F_CACHE_LOOKUPS:
776 case ST_F_CACHE_HITS:
777 case ST_F_COMP_IN:
778 case ST_F_COMP_OUT:
779 case ST_F_COMP_BYP:
780 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100781 if (px->mode != PR_MODE_HTTP)
782 goto next_px;
William Dauchy3c6f0062021-01-25 17:29:02 +0100783 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100784 break;
785 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100786 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100787 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100788 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100789 case ST_F_HRSP_OTHER:
790 if (px->mode != PR_MODE_HTTP)
791 goto next_px;
792 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100793 labels[1].name = ist("code");
794 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchy3c6f0062021-01-25 17:29:02 +0100795 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100796 break;
797
798 default:
William Dauchy3c6f0062021-01-25 17:29:02 +0100799 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100800 }
801
William Dauchy3c6f0062021-01-25 17:29:02 +0100802 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100803 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100804 goto full;
805 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200806 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100807 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100808 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200809 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100810 }
811
812 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200813 if (out.len) {
814 if (!htx_add_data_atonce(htx, out))
815 return -1; /* Unexpected and unrecoverable error */
816 channel_add_input(chn, out.len);
817 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100818 return ret;
819 full:
820 ret = 0;
821 goto end;
822}
823
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500824/* Dump servers metrics (prefixed by "haproxy_server_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100825 * 0 if <htx> is full and -1 in case of any error. */
826static int promex_dump_srv_metrics(struct appctx *appctx, struct htx *htx)
827{
828 static struct ist prefix = IST("haproxy_server_");
829 struct proxy *px;
830 struct server *sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100831 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100832 struct channel *chn = si_ic(appctx->owner);
833 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200834 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchybde2bf62021-01-25 17:29:04 +0100835 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100836 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200837 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100838 enum promex_srv_state state;
William Dauchyde3c3262021-02-01 13:11:51 +0100839 const char *check_state;
William Dauchyc6464592021-01-27 22:40:17 +0100840 int i;
Christopher Fauletf959d082019-02-07 15:38:42 +0100841
Christopher Faulet37286a52021-01-20 15:20:53 +0100842 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
843 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
844 continue;
845
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200846 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100847 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
848
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200849 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100850
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100851 labels[0].name = ist("proxy");
852 labels[0].value = ist2(px->id, strlen(px->id));
853
Christopher Fauletf959d082019-02-07 15:38:42 +0100854 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200855 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100856 goto next_px;
857
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200858 while (appctx->ctx.stats.obj2) {
859 sv = appctx->ctx.stats.obj2;
Christopher Fauletf959d082019-02-07 15:38:42 +0100860
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100861 labels[1].name = ist("server");
862 labels[1].value = ist2(sv->id, strlen(sv->id));
863
William Dauchybde2bf62021-01-25 17:29:04 +0100864 if (!stats_fill_sv_stats(px, sv, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
865 return -1;
866
Christopher Fauleteba22942019-11-19 14:18:24 +0100867 if ((appctx->ctx.stats.flags & PROMEX_FL_NO_MAINT_SRV) && (sv->cur_admin & SRV_ADMF_MAINT))
868 goto next_sv;
869
Christopher Fauletf959d082019-02-07 15:38:42 +0100870 switch (appctx->st2) {
871 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100872 state = promex_srv_status(sv);
873 for (i = 0; i < PROMEX_SRV_STATE_COUNT; i++) {
874 val = mkf_u32(FO_STATUS, state == i);
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100875 labels[2].name = ist("state");
876 labels[2].value = promex_srv_st[i];
William Dauchyc6464592021-01-27 22:40:17 +0100877 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100878 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100879 goto full;
880 }
881 goto next_sv;
Christopher Fauletf959d082019-02-07 15:38:42 +0100882 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200883 secs = (double)swrate_avg(sv->counters.q_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_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200887 secs = (double)swrate_avg(sv->counters.c_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;
890 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200891 secs = (double)swrate_avg(sv->counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100892 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100893 break;
894 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200895 secs = (double)swrate_avg(sv->counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100896 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100897 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100898 case ST_F_QT_MAX:
899 secs = (double)sv->counters.qtime_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_CT_MAX:
903 secs = (double)sv->counters.ctime_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;
906 case ST_F_RT_MAX:
907 secs = (double)sv->counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100908 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100909 break;
910 case ST_F_TT_MAX:
911 secs = (double)sv->counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100912 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100913 break;
Christopher Fauletcf403f32019-11-21 14:35:46 +0100914 case ST_F_CHECK_STATUS:
915 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
916 goto next_sv;
William Dauchyde3c3262021-02-01 13:11:51 +0100917
918 for (i = 0; i < HCHK_STATUS_SIZE; i++) {
919 if (get_check_status_result(i) < CHK_RES_FAILED)
920 continue;
921 val = mkf_u32(FO_STATUS, sv->check.status == i);
922 check_state = get_check_status_info(i);
923 labels[2].name = ist("state");
924 labels[2].value = ist2(check_state, strlen(check_state));
925 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
926 &val, labels, &out, max))
927 goto full;
928 }
929 goto next_sv;
Christopher Fauletcf403f32019-11-21 14:35:46 +0100930 case ST_F_CHECK_CODE:
931 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
932 goto next_sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100933 val = mkf_u32(FN_OUTPUT, (sv->check.status < HCHK_STATUS_L57DATA) ? 0 : sv->check.code);
Christopher Fauletcf403f32019-11-21 14:35:46 +0100934 break;
Christopher Faulet2711e512020-02-27 16:12:07 +0100935 case ST_F_CHECK_DURATION:
936 if (sv->check.status < HCHK_STATUS_CHECKED)
937 goto next_sv;
938 secs = (double)sv->check.duration / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100939 val = mkf_flt(FN_DURATION, secs);
Christopher Faulet2711e512020-02-27 16:12:07 +0100940 break;
Marcin Deranek3c27dda2020-05-15 18:32:51 +0200941 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100942 case ST_F_HRSP_1XX:
943 if (px->mode != PR_MODE_HTTP)
944 goto next_px;
William Dauchybde2bf62021-01-25 17:29:04 +0100945 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100946 break;
947 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100948 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100949 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100950 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100951 case ST_F_HRSP_OTHER:
952 if (px->mode != PR_MODE_HTTP)
953 goto next_px;
954 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100955 labels[2].name = ist("code");
956 labels[2].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchybde2bf62021-01-25 17:29:04 +0100957 val = stats[appctx->st2];
Christopher Fauletc55a6262020-07-10 15:39:39 +0200958 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100959
960 default:
William Dauchybde2bf62021-01-25 17:29:04 +0100961 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100962 }
963
William Dauchyc6464592021-01-27 22:40:17 +0100964 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100965 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100966 goto full;
Christopher Fauleteba22942019-11-19 14:18:24 +0100967 next_sv:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200968 appctx->ctx.stats.obj2 = sv->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100969 }
970
971 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200972 appctx->ctx.stats.obj1 = px->next;
973 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +0100974 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100975 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200976 appctx->ctx.stats.obj1 = proxies_list;
977 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +0100978 }
979
980
981 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200982 if (out.len) {
983 if (!htx_add_data_atonce(htx, out))
984 return -1; /* Unexpected and unrecoverable error */
985 channel_add_input(chn, out.len);
986 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100987 return ret;
988 full:
989 ret = 0;
990 goto end;
991}
992
993/* Dump all metrics (global, frontends, backends and servers) depending on the
994 * dumper state (appctx->st1). It returns 1 on success, 0 if <htx> is full and
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200995 * -1 in case of any error.
996 * Uses <appctx.ctx.stats.obj1> as a pointer to the current proxy and <obj2> as
997 * a pointer to the current server/listener. */
Christopher Fauletf959d082019-02-07 15:38:42 +0100998static int promex_dump_metrics(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
999{
1000 int ret;
1001
1002 switch (appctx->st1) {
1003 case PROMEX_DUMPER_INIT:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001004 appctx->ctx.stats.obj1 = NULL;
1005 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001006 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_INFO_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001007 appctx->st2 = INF_NAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001008 appctx->st1 = PROMEX_DUMPER_GLOBAL;
1009 /* fall through */
1010
1011 case PROMEX_DUMPER_GLOBAL:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001012 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_GLOBAL) {
1013 ret = promex_dump_global_metrics(appctx, htx);
1014 if (ret <= 0) {
1015 if (ret == -1)
1016 goto error;
1017 goto full;
1018 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001019 }
1020
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001021 appctx->ctx.stats.obj1 = proxies_list;
1022 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001023 appctx->ctx.stats.flags &= ~PROMEX_FL_INFO_METRIC;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001024 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_FRONT_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001025 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001026 appctx->st1 = PROMEX_DUMPER_FRONT;
1027 /* fall through */
1028
1029 case PROMEX_DUMPER_FRONT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001030 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_FRONT) {
1031 ret = promex_dump_front_metrics(appctx, htx);
1032 if (ret <= 0) {
1033 if (ret == -1)
1034 goto error;
1035 goto full;
1036 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001037 }
1038
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001039 appctx->ctx.stats.obj1 = proxies_list;
1040 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001041 appctx->ctx.stats.flags &= ~PROMEX_FL_FRONT_METRIC;
1042 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_BACK_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001043 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001044 appctx->st1 = PROMEX_DUMPER_BACK;
1045 /* fall through */
1046
1047 case PROMEX_DUMPER_BACK:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001048 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_BACK) {
1049 ret = promex_dump_back_metrics(appctx, htx);
1050 if (ret <= 0) {
1051 if (ret == -1)
1052 goto error;
1053 goto full;
1054 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001055 }
1056
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001057 appctx->ctx.stats.obj1 = proxies_list;
1058 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001059 appctx->ctx.stats.flags &= ~PROMEX_FL_BACK_METRIC;
1060 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001061 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001062 appctx->st1 = PROMEX_DUMPER_SRV;
1063 /* fall through */
1064
1065 case PROMEX_DUMPER_SRV:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001066 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_SERVER) {
1067 ret = promex_dump_srv_metrics(appctx, htx);
1068 if (ret <= 0) {
1069 if (ret == -1)
1070 goto error;
1071 goto full;
1072 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001073 }
1074
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001075 appctx->ctx.stats.obj1 = NULL;
1076 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001077 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
Christopher Fauletf959d082019-02-07 15:38:42 +01001078 appctx->st2 = 0;
1079 appctx->st1 = PROMEX_DUMPER_DONE;
1080 /* fall through */
1081
1082 case PROMEX_DUMPER_DONE:
1083 default:
1084 break;
1085 }
1086
1087 return 1;
1088
1089 full:
1090 si_rx_room_blk(si);
1091 return 0;
1092 error:
1093 /* unrecoverable error */
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001094 appctx->ctx.stats.obj1 = NULL;
1095 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletf959d082019-02-07 15:38:42 +01001096 appctx->ctx.stats.flags = 0;
1097 appctx->st2 = 0;
1098 appctx->st1 = PROMEX_DUMPER_DONE;
1099 return -1;
1100}
1101
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001102/* Parse the query string of request URI to filter the metrics. It returns 1 on
Christopher Faulet78407ce2019-11-18 14:47:08 +01001103 * success and -1 on error. */
1104static int promex_parse_uri(struct appctx *appctx, struct stream_interface *si)
1105{
1106 struct channel *req = si_oc(si);
1107 struct channel *res = si_ic(si);
1108 struct htx *req_htx, *res_htx;
1109 struct htx_sl *sl;
William Dauchyc65f6562019-11-26 12:56:26 +01001110 char *p, *key, *value;
1111 const char *end;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001112 struct buffer *err;
1113 int default_scopes = PROMEX_FL_SCOPE_ALL;
1114 int len;
1115
1116 /* Get the query-string */
1117 req_htx = htxbuf(&req->buf);
1118 sl = http_get_stline(req_htx);
1119 if (!sl)
1120 goto error;
1121 p = http_find_param_list(HTX_SL_REQ_UPTR(sl), HTX_SL_REQ_ULEN(sl), '?');
1122 if (!p)
1123 goto end;
1124 end = HTX_SL_REQ_UPTR(sl) + HTX_SL_REQ_ULEN(sl);
Christopher Faulet78407ce2019-11-18 14:47:08 +01001125
William Dauchyc65f6562019-11-26 12:56:26 +01001126 /* copy the query-string */
1127 len = end - p;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001128 chunk_reset(&trash);
1129 memcpy(trash.area, p, len);
1130 trash.area[len] = 0;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001131 p = trash.area;
William Dauchyc65f6562019-11-26 12:56:26 +01001132 end = trash.area + len;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001133
1134 /* Parse the query-string */
William Dauchyc65f6562019-11-26 12:56:26 +01001135 while (p < end && *p && *p != '#') {
1136 value = NULL;
1137
1138 /* decode parameter name */
1139 key = p;
1140 while (p < end && *p != '=' && *p != '&' && *p != '#')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001141 ++p;
William Dauchyc65f6562019-11-26 12:56:26 +01001142 /* found a value */
1143 if (*p == '=') {
1144 *(p++) = 0;
1145 value = p;
1146 }
1147 else if (*p == '&')
1148 *(p++) = 0;
1149 else if (*p == '#')
1150 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001151 len = url_decode(key, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001152 if (len == -1)
1153 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001154
William Dauchyc65f6562019-11-26 12:56:26 +01001155 /* decode value */
1156 if (value) {
1157 while (p < end && *p != '=' && *p != '&' && *p != '#')
1158 ++p;
1159 if (*p == '=')
1160 goto error;
1161 if (*p == '&')
1162 *(p++) = 0;
1163 else if (*p == '#')
1164 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001165 len = url_decode(value, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001166 if (len == -1)
1167 goto error;
1168 }
1169
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001170 if (strcmp(key, "scope") == 0) {
William Dauchyc65f6562019-11-26 12:56:26 +01001171 default_scopes = 0; /* at least a scope defined, unset default scopes */
1172 if (!value)
1173 goto error;
1174 else if (*value == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001175 appctx->ctx.stats.flags &= ~PROMEX_FL_SCOPE_ALL;
William Dauchyc65f6562019-11-26 12:56:26 +01001176 else if (*value == '*')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001177 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_ALL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001178 else if (strcmp(value, "global") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001179 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_GLOBAL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001180 else if (strcmp(value, "server") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001181 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_SERVER;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001182 else if (strcmp(value, "backend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001183 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_BACK;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001184 else if (strcmp(value, "frontend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001185 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_FRONT;
1186 else
1187 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001188 }
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001189 else if (strcmp(key, "no-maint") == 0)
Christopher Fauleteba22942019-11-19 14:18:24 +01001190 appctx->ctx.stats.flags |= PROMEX_FL_NO_MAINT_SRV;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001191 }
1192
1193 end:
1194 appctx->ctx.stats.flags |= default_scopes;
1195 return 1;
1196
1197 error:
1198 err = &http_err_chunks[HTTP_ERR_400];
1199 channel_erase(res);
1200 res->buf.data = b_data(err);
1201 memcpy(res->buf.area, b_head(err), b_data(err));
1202 res_htx = htx_from_buf(&res->buf);
1203 channel_add_input(res, res_htx->data);
1204 appctx->st0 = PROMEX_ST_END;
1205 return -1;
1206}
1207
Christopher Fauletf959d082019-02-07 15:38:42 +01001208/* Send HTTP headers of the response. It returns 1 on success and 0 if <htx> is
1209 * full. */
1210static int promex_send_headers(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1211{
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001212 struct channel *chn = si_ic(appctx->owner);
Christopher Fauletf959d082019-02-07 15:38:42 +01001213 struct htx_sl *sl;
1214 unsigned int flags;
1215
1216 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);
1217 sl = htx_add_stline(htx, HTX_BLK_RES_SL, flags, ist("HTTP/1.1"), ist("200"), ist("OK"));
1218 if (!sl)
1219 goto full;
1220 sl->info.res.status = 200;
1221 if (!htx_add_header(htx, ist("Cache-Control"), ist("no-cache")) ||
Christopher Fauletf959d082019-02-07 15:38:42 +01001222 !htx_add_header(htx, ist("Content-Type"), ist("text/plain; version=0.0.4")) ||
1223 !htx_add_header(htx, ist("Transfer-Encoding"), ist("chunked")) ||
1224 !htx_add_endof(htx, HTX_BLK_EOH))
1225 goto full;
1226
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001227 channel_add_input(chn, htx->data);
Christopher Fauletf959d082019-02-07 15:38:42 +01001228 return 1;
1229 full:
1230 htx_reset(htx);
1231 si_rx_room_blk(si);
1232 return 0;
1233}
1234
1235/* The function returns 1 if the initialisation is complete, 0 if
1236 * an errors occurs and -1 if more data are required for initializing
1237 * the applet.
1238 */
1239static int promex_appctx_init(struct appctx *appctx, struct proxy *px, struct stream *strm)
1240{
1241 appctx->st0 = PROMEX_ST_INIT;
1242 return 1;
1243}
1244
1245/* The main I/O handler for the promex applet. */
1246static void promex_appctx_handle_io(struct appctx *appctx)
1247{
1248 struct stream_interface *si = appctx->owner;
1249 struct stream *s = si_strm(si);
1250 struct channel *req = si_oc(si);
1251 struct channel *res = si_ic(si);
1252 struct htx *req_htx, *res_htx;
1253 int ret;
1254
1255 res_htx = htx_from_buf(&res->buf);
Christopher Fauletf959d082019-02-07 15:38:42 +01001256 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1257 goto out;
1258
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001259 /* Check if the input buffer is available. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001260 if (!b_size(&res->buf)) {
1261 si_rx_room_blk(si);
1262 goto out;
1263 }
1264
1265 switch (appctx->st0) {
1266 case PROMEX_ST_INIT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001267 ret = promex_parse_uri(appctx, si);
1268 if (ret <= 0) {
1269 if (ret == -1)
1270 goto error;
1271 goto out;
1272 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001273 appctx->st0 = PROMEX_ST_HEAD;
1274 appctx->st1 = PROMEX_DUMPER_INIT;
1275 /* fall through */
1276
1277 case PROMEX_ST_HEAD:
1278 if (!promex_send_headers(appctx, si, res_htx))
1279 goto out;
1280 appctx->st0 = ((s->txn->meth == HTTP_METH_HEAD) ? PROMEX_ST_DONE : PROMEX_ST_DUMP);
1281 /* fall through */
1282
1283 case PROMEX_ST_DUMP:
1284 ret = promex_dump_metrics(appctx, si, res_htx);
1285 if (ret <= 0) {
1286 if (ret == -1)
1287 goto error;
1288 goto out;
1289 }
1290 appctx->st0 = PROMEX_ST_DONE;
1291 /* fall through */
1292
1293 case PROMEX_ST_DONE:
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001294 /* no more data are expected. Don't add TLR because mux-h1 will take care of it */
1295 res_htx->flags |= HTX_FL_EOM;
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001296 appctx->st0 = PROMEX_ST_END;
1297 /* fall through */
Christopher Fauletf959d082019-02-07 15:38:42 +01001298
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001299 case PROMEX_ST_END:
1300 if (!(res->flags & CF_SHUTR)) {
1301 res->flags |= CF_READ_NULL;
1302 si_shutr(si);
1303 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001304 }
1305
Christopher Fauletf959d082019-02-07 15:38:42 +01001306 out:
1307 htx_to_buf(res_htx, &res->buf);
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001308
1309 /* eat the whole request */
1310 if (co_data(req)) {
1311 req_htx = htx_from_buf(&req->buf);
1312 co_htx_skip(req, req_htx, co_data(req));
1313 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001314 return;
1315
1316 error:
1317 res->flags |= CF_READ_NULL;
1318 si_shutr(si);
1319 si_shutw(si);
1320}
1321
1322struct applet promex_applet = {
1323 .obj_type = OBJ_TYPE_APPLET,
1324 .name = "<PROMEX>", /* used for logging */
1325 .init = promex_appctx_init,
1326 .fct = promex_appctx_handle_io,
1327};
1328
1329static enum act_parse_ret service_parse_prometheus_exporter(const char **args, int *cur_arg, struct proxy *px,
1330 struct act_rule *rule, char **err)
1331{
1332 /* Prometheus exporter service is only available on "http-request" rulesets */
1333 if (rule->from != ACT_F_HTTP_REQ) {
1334 memprintf(err, "Prometheus exporter service only available on 'http-request' rulesets");
1335 return ACT_RET_PRS_ERR;
1336 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001337
1338 /* Add applet pointer in the rule. */
1339 rule->applet = promex_applet;
1340
1341 return ACT_RET_PRS_OK;
1342}
1343static void promex_register_build_options(void)
1344{
1345 char *ptr = NULL;
1346
1347 memprintf(&ptr, "Built with the Prometheus exporter as a service");
1348 hap_register_build_opts(ptr, 1);
1349}
1350
1351
1352static struct action_kw_list service_actions = { ILH, {
1353 { "prometheus-exporter", service_parse_prometheus_exporter },
1354 { /* END */ }
1355}};
1356
1357INITCALL1(STG_REGISTER, service_keywords_register, &service_actions);
1358INITCALL0(STG_REGISTER, promex_register_build_options);