blob: e62ad948cb33fd5bf2d12160ed78ab7058eb26cc [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
William Dauchy7741c332021-02-01 13:11:57 +0100180 [INF_CUM_LOG_MSGS] = { .n = IST("recv_logs_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
Christopher Fauletf959d082019-02-07 15:38:42 +0100181};
182
Christopher Faulet37286a52021-01-20 15:20:53 +0100183/* frontend/backend/server fields */
184const struct promex_metric promex_st_metrics[ST_F_TOTAL_FIELDS] = {
185 //[ST_F_PXNAME] ignored
186 //[ST_F_SVNAME] ignored
187 [ST_F_QCUR] = { .n = IST("current_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
188 [ST_F_QMAX] = { .n = IST("max_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
189 [ST_F_SCUR] = { .n = IST("current_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
190 [ST_F_SMAX] = { .n = IST("max_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
191 [ST_F_SLIM] = { .n = IST("limit_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
192 [ST_F_STOT] = { .n = IST("sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
193 [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) },
194 [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) },
195 [ST_F_DREQ] = { .n = IST("requests_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
196 [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) },
197 [ST_F_EREQ] = { .n = IST("request_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
198 [ST_F_ECON] = { .n = IST("connection_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
199 [ST_F_ERESP] = { .n = IST("response_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
200 [ST_F_WRETR] = { .n = IST("retry_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
201 [ST_F_WREDIS] = { .n = IST("redispatch_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
202 [ST_F_STATUS] = { .n = IST("status"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
203 [ST_F_WEIGHT] = { .n = IST("weight"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
204 [ST_F_ACT] = { .n = IST("active_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
205 [ST_F_BCK] = { .n = IST("backup_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
206 [ST_F_CHKFAIL] = { .n = IST("check_failures_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_SRV_METRIC) },
207 [ST_F_CHKDOWN] = { .n = IST("check_up_down_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
208 [ST_F_LASTCHG] = { .n = IST("check_last_change_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
209 [ST_F_DOWNTIME] = { .n = IST("downtime_seconds_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
210 [ST_F_QLIMIT] = { .n = IST("queue_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
211 //[ST_F_PID] ignored
212 //[ST_F_IID] ignored
213 //[ST_F_SID] ignored
214 [ST_F_THROTTLE] = { .n = IST("current_throttle"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
215 [ST_F_LBTOT] = { .n = IST("loadbalanced_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
216 //[ST_F_TRACKED] ignored
217 //[ST_F_TYPE] ignored
218 //[ST_F_RATE] ignored
219 [ST_F_RATE_LIM] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
220 [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) },
221 [ST_F_CHECK_STATUS] = { .n = IST("check_status"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
222 [ST_F_CHECK_CODE] = { .n = IST("check_code"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
223 [ST_F_CHECK_DURATION] = { .n = IST("check_duration_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
224 [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) },
225 [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) },
226 [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) },
227 [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) },
228 [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) },
229 [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) },
230 //[ST_F_HANAFAIL] ignored
231 //[ST_F_REQ_RATE] ignored
232 [ST_F_REQ_RATE_MAX] = { .n = IST("http_requests_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
233 [ST_F_REQ_TOT] = { .n = IST("http_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
234 [ST_F_CLI_ABRT] = { .n = IST("client_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
235 [ST_F_SRV_ABRT] = { .n = IST("server_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
236 [ST_F_COMP_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
237 [ST_F_COMP_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
238 [ST_F_COMP_BYP] = { .n = IST("http_comp_bytes_bypassed_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
239 [ST_F_COMP_RSP] = { .n = IST("http_comp_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
240 [ST_F_LASTSESS] = { .n = IST("last_session_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
241 //[ST_F_LAST_CHK] ignroed
242 //[ST_F_LAST_AGT] ignored
243 [ST_F_QTIME] = { .n = IST("queue_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
244 [ST_F_CTIME] = { .n = IST("connect_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
245 [ST_F_RTIME] = { .n = IST("response_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
246 [ST_F_TTIME] = { .n = IST("total_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
247 //[ST_F_AGENT_STATUS] ignored
248 //[ST_F_AGENT_CODE] ignored
249 //[ST_F_AGENT_DURATION] ignored
250 //[ST_F_CHECK_DESC] ignored
251 //[ST_F_AGENT_DESC] ignored
252 //[ST_F_CHECK_RISE] ignored
253 //[ST_F_CHECK_FALL] ignored
254 //[ST_F_CHECK_HEALTH] ignored
255 //[ST_F_AGENT_RISE] ignored
256 //[ST_F_AGENT_FALL] ignored
257 //[ST_F_AGENT_HEALTH] ignored
258 //[ST_F_ADDR] ignored
259 //[ST_F_COOKIE] ignored
260 //[ST_F_MODE] ignored
261 //[ST_F_ALGO] ignored
262 //[ST_F_CONN_RATE] ignored
263 [ST_F_CONN_RATE_MAX] = { .n = IST("connections_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
264 [ST_F_CONN_TOT] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
265 [ST_F_INTERCEPTED] = { .n = IST("intercepted_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
266 [ST_F_DCON] = { .n = IST("denied_connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
267 [ST_F_DSES] = { .n = IST("denied_sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
268 [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) },
269 [ST_F_CONNECT] = { .n = IST("connection_attempts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
270 [ST_F_REUSE] = { .n = IST("connection_reuses_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
271 [ST_F_CACHE_LOOKUPS] = { .n = IST("http_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
272 [ST_F_CACHE_HITS] = { .n = IST("http_cache_hits_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
273 [ST_F_SRV_ICUR] = { .n = IST("idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
274 [ST_F_SRV_ILIM] = { .n = IST("idle_connections_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
275 [ST_F_QT_MAX] = { .n = IST("max_queue_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
276 [ST_F_CT_MAX] = { .n = IST("max_connect_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
277 [ST_F_RT_MAX] = { .n = IST("max_response_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
278 [ST_F_TT_MAX] = { .n = IST("max_total_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
279 [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) },
280 [ST_F_IDLE_CONN_CUR] = { .n = IST("unsafe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
281 [ST_F_SAFE_CONN_CUR]= { .n = IST("safe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
282 [ST_F_USED_CONN_CUR] = { .n = IST("used_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
283 [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 +0100284 [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 +0100285};
286
William Dauchy82b2ce22021-02-01 13:11:55 +0100287/* Description of overriden stats fields */
Christopher Fauletf959d082019-02-07 15:38:42 +0100288const struct ist promex_st_metric_desc[ST_F_TOTAL_FIELDS] = {
289 [ST_F_PXNAME] = IST("The proxy name."),
290 [ST_F_SVNAME] = IST("The service name (FRONTEND for frontend, BACKEND for backend, any name for server/listener)."),
291 [ST_F_QCUR] = IST("Current number of queued requests."),
292 [ST_F_QMAX] = IST("Maximum observed number of queued requests."),
293 [ST_F_SCUR] = IST("Current number of active sessions."),
294 [ST_F_SMAX] = IST("Maximum observed number of active sessions."),
295 [ST_F_SLIM] = IST("Configured session limit."),
296 [ST_F_STOT] = IST("Total number of sessions."),
297 [ST_F_BIN] = IST("Current total of incoming bytes."),
298 [ST_F_BOUT] = IST("Current total of outgoing bytes."),
299 [ST_F_DREQ] = IST("Total number of denied requests."),
300 [ST_F_DRESP] = IST("Total number of denied responses."),
301 [ST_F_EREQ] = IST("Total number of request errors."),
302 [ST_F_ECON] = IST("Total number of connection errors."),
303 [ST_F_ERESP] = IST("Total number of response errors."),
304 [ST_F_WRETR] = IST("Total number of retry warnings."),
305 [ST_F_WREDIS] = IST("Total number of redispatch warnings."),
William Dauchya1da7ba2021-02-01 13:11:52 +0100306 [ST_F_STATUS] = IST("Current status of the service, per state label value."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100307 [ST_F_WEIGHT] = IST("Service weight."),
308 [ST_F_ACT] = IST("Current number of active servers."),
309 [ST_F_BCK] = IST("Current number of backup servers."),
310 [ST_F_CHKFAIL] = IST("Total number of failed check (Only counts checks failed when the server is up)."),
311 [ST_F_CHKDOWN] = IST("Total number of UP->DOWN transitions."),
312 [ST_F_LASTCHG] = IST("Number of seconds since the last UP<->DOWN transition."),
313 [ST_F_DOWNTIME] = IST("Total downtime (in seconds) for the service."),
314 [ST_F_QLIMIT] = IST("Configured maxqueue for the server (0 meaning no limit)."),
315 [ST_F_PID] = IST("Process id (0 for first instance, 1 for second, ...)"),
316 [ST_F_IID] = IST("Unique proxy id."),
317 [ST_F_SID] = IST("Server id (unique inside a proxy)."),
318 [ST_F_THROTTLE] = IST("Current throttle percentage for the server, when slowstart is active, or no value if not in slowstart."),
319 [ST_F_LBTOT] = IST("Total number of times a service was selected, either for new sessions, or when redispatching."),
320 [ST_F_TRACKED] = IST("Id of proxy/server if tracking is enabled."),
321 [ST_F_TYPE] = IST("Service type (0=frontend, 1=backend, 2=server, 3=socket/listener)."),
322 [ST_F_RATE] = IST("Current number of sessions per second over last elapsed second."),
323 [ST_F_RATE_LIM] = IST("Configured limit on new sessions per second."),
324 [ST_F_RATE_MAX] = IST("Maximum observed number of sessions per second."),
William Dauchyde3c3262021-02-01 13:11:51 +0100325 [ST_F_CHECK_STATUS] = IST("Status of last health check, per state label value."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100326 [ST_F_CHECK_CODE] = IST("layer5-7 code, if available of the last health check."),
Christopher Faulet2711e512020-02-27 16:12:07 +0100327 [ST_F_CHECK_DURATION] = IST("Total duration of the latest server health check, in seconds."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100328 [ST_F_QTIME] = IST("Avg. queue time for last 1024 successful connections."),
329 [ST_F_CTIME] = IST("Avg. connect time for last 1024 successful connections."),
330 [ST_F_RTIME] = IST("Avg. response time for last 1024 successful connections."),
331 [ST_F_TTIME] = IST("Avg. total time for last 1024 successful connections."),
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100332 [ST_F_QT_MAX] = IST("Maximum observed time spent in the queue"),
333 [ST_F_CT_MAX] = IST("Maximum observed time spent waiting for a connection to complete"),
334 [ST_F_RT_MAX] = IST("Maximum observed time spent waiting for a server response"),
335 [ST_F_TT_MAX] = IST("Maximum observed total request+response time (request+queue+connect+response+processing)"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100336};
337
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100338/* Specific labels for all ST_F_HRSP_* fields */
339const struct ist promex_hrsp_code[1 + ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = {
340 [ST_F_HRSP_1XX - ST_F_HRSP_1XX] = IST("1xx"),
341 [ST_F_HRSP_2XX - ST_F_HRSP_1XX] = IST("2xx"),
342 [ST_F_HRSP_3XX - ST_F_HRSP_1XX] = IST("3xx"),
343 [ST_F_HRSP_4XX - ST_F_HRSP_1XX] = IST("4xx"),
344 [ST_F_HRSP_5XX - ST_F_HRSP_1XX] = IST("5xx"),
345 [ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = IST("other"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100346};
347
William Dauchy54938212021-01-27 22:40:16 +0100348enum promex_front_state {
349 PROMEX_FRONT_STATE_DOWN = 0,
350 PROMEX_FRONT_STATE_UP,
351
352 PROMEX_FRONT_STATE_COUNT /* must be last */
353};
354
355const struct ist promex_front_st[PROMEX_FRONT_STATE_COUNT] = {
356 [PROMEX_FRONT_STATE_DOWN] = IST("DOWN"),
357 [PROMEX_FRONT_STATE_UP] = IST("UP"),
358};
359
360enum promex_back_state {
361 PROMEX_BACK_STATE_DOWN = 0,
362 PROMEX_BACK_STATE_UP,
363
364 PROMEX_BACK_STATE_COUNT /* must be last */
365};
366
367const struct ist promex_back_st[PROMEX_BACK_STATE_COUNT] = {
368 [PROMEX_BACK_STATE_DOWN] = IST("DOWN"),
369 [PROMEX_BACK_STATE_UP] = IST("UP"),
370};
371
372enum promex_srv_state {
373 PROMEX_SRV_STATE_DOWN = 0,
374 PROMEX_SRV_STATE_UP,
375 PROMEX_SRV_STATE_MAINT,
376 PROMEX_SRV_STATE_DRAIN,
377 PROMEX_SRV_STATE_NOLB,
378
379 PROMEX_SRV_STATE_COUNT /* must be last */
380};
381
382const struct ist promex_srv_st[PROMEX_SRV_STATE_COUNT] = {
383 [PROMEX_SRV_STATE_DOWN] = IST("DOWN"),
384 [PROMEX_SRV_STATE_UP] = IST("UP"),
385 [PROMEX_SRV_STATE_MAINT] = IST("MAINT"),
386 [PROMEX_SRV_STATE_DRAIN] = IST("DRAIN"),
387 [PROMEX_SRV_STATE_NOLB] = IST("NOLB"),
388};
389
390/* Return the server status. */
391enum promex_srv_state promex_srv_status(struct server *sv)
Christopher Fauletf959d082019-02-07 15:38:42 +0100392{
William Dauchy54938212021-01-27 22:40:16 +0100393 int state = PROMEX_SRV_STATE_DOWN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100394
Christopher Fauletf959d082019-02-07 15:38:42 +0100395 if (sv->cur_state == SRV_ST_RUNNING || sv->cur_state == SRV_ST_STARTING) {
William Dauchy54938212021-01-27 22:40:16 +0100396 state = PROMEX_SRV_STATE_UP;
Christopher Fauletf959d082019-02-07 15:38:42 +0100397 if (sv->cur_admin & SRV_ADMF_DRAIN)
William Dauchy54938212021-01-27 22:40:16 +0100398 state = PROMEX_SRV_STATE_DRAIN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100399 }
Christopher Fauletd45d1052019-09-06 16:10:19 +0200400 else if (sv->cur_state == SRV_ST_STOPPING)
William Dauchy54938212021-01-27 22:40:16 +0100401 state = PROMEX_SRV_STATE_NOLB;
Christopher Fauletd45d1052019-09-06 16:10:19 +0200402
403 if (sv->cur_admin & SRV_ADMF_MAINT)
William Dauchy54938212021-01-27 22:40:16 +0100404 state = PROMEX_SRV_STATE_MAINT;
Christopher Fauletf959d082019-02-07 15:38:42 +0100405
406 return state;
407}
408
409/* Convert a field to its string representation and write it in <out>, followed
410 * by a newline, if there is enough space. non-numeric value are converted in
William Dauchy18a2c6e2021-01-22 21:09:47 +0100411 * "NaN" because Prometheus only support numerical values (but it is unexepceted
Christopher Fauletf959d082019-02-07 15:38:42 +0100412 * to process this kind of value). It returns 1 on success. Otherwise, it
413 * returns 0. The buffer's length must not exceed <max> value.
414 */
415static int promex_metric_to_str(struct buffer *out, struct field *f, size_t max)
416{
417 int ret = 0;
418
419 switch (field_format(f, 0)) {
William Dauchy18a2c6e2021-01-22 21:09:47 +0100420 case FF_EMPTY: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100421 case FF_S32: ret = chunk_appendf(out, "%d\n", f->u.s32); break;
422 case FF_U32: ret = chunk_appendf(out, "%u\n", f->u.u32); break;
423 case FF_S64: ret = chunk_appendf(out, "%lld\n", (long long)f->u.s64); break;
424 case FF_U64: ret = chunk_appendf(out, "%llu\n", (unsigned long long)f->u.u64); break;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200425 case FF_FLT: ret = chunk_appendf(out, "%f\n", f->u.flt); break;
William Dauchy18a2c6e2021-01-22 21:09:47 +0100426 case FF_STR: ret = chunk_strcat(out, "NaN\n"); break;
427 default: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100428 }
429 if (!ret || out->data > max)
430 return 0;
431 return 1;
432}
433
Christopher Fauletf959d082019-02-07 15:38:42 +0100434/* Dump the header lines for <metric>. It is its #HELP and #TYPE strings. It
435 * returns 1 on success. Otherwise, if <out> length exceeds <max>, it returns 0.
436 */
437static int promex_dump_metric_header(struct appctx *appctx, struct htx *htx,
Christopher Faulet37286a52021-01-20 15:20:53 +0100438 const struct promex_metric *metric, const struct ist name,
439 struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100440{
Christopher Faulet37286a52021-01-20 15:20:53 +0100441 struct ist type;
William Dauchy82b2ce22021-02-01 13:11:55 +0100442 struct ist desc;
Christopher Faulet37286a52021-01-20 15:20:53 +0100443
444 switch (metric->type) {
445 case PROMEX_MT_COUNTER:
446 type = ist("counter");
447 break;
448 default:
449 type = ist("gauge");
450 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100451
William Dauchya191b772021-01-15 22:41:39 +0100452 if (istcat(out, ist("# HELP "), max) == -1 ||
453 istcat(out, name, max) == -1 ||
454 istcat(out, ist(" "), max) == -1)
455 goto full;
456
William Dauchy82b2ce22021-02-01 13:11:55 +0100457 if (metric->flags & PROMEX_FL_INFO_METRIC)
458 desc = ist(info_fields[appctx->st2].desc);
459 else if (!isttest(promex_st_metric_desc[appctx->st2]))
460 desc = ist(stat_fields[appctx->st2].desc);
461 else
462 desc = promex_st_metric_desc[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100463
William Dauchy82b2ce22021-02-01 13:11:55 +0100464 if (istcat(out, desc, max) == -1 ||
465 istcat(out, ist("\n# TYPE "), max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100466 istcat(out, name, max) == -1 ||
467 istcat(out, ist(" "), max) == -1 ||
Christopher Faulet37286a52021-01-20 15:20:53 +0100468 istcat(out, type, max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100469 istcat(out, ist("\n"), max) == -1)
470 goto full;
471
472 return 1;
473
474 full:
475 return 0;
476}
477
478/* Dump the line for <metric>. It starts by the metric name followed by its
479 * labels (proxy name, server name...) between braces and finally its value. If
480 * not already done, the header lines are dumped first. It returns 1 on
481 * success. Otherwise if <out> length exceeds <max>, it returns 0.
482 */
Christopher Faulet37286a52021-01-20 15:20:53 +0100483static int promex_dump_metric(struct appctx *appctx, struct htx *htx, struct ist prefix,
William Dauchyc6464592021-01-27 22:40:17 +0100484 const struct promex_metric *metric, struct field *val,
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100485 struct promex_label *labels, struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100486{
487 struct ist name = { .ptr = (char[PROMEX_MAX_NAME_LEN]){ 0 }, .len = 0 };
488 size_t len = out->len;
489
490 if (out->len + PROMEX_MAX_METRIC_LENGTH > max)
491 return 0;
492
Christopher Faulet37286a52021-01-20 15:20:53 +0100493 /* Fill the metric name */
494 istcat(&name, prefix, PROMEX_MAX_NAME_LEN);
495 istcat(&name, metric->n, PROMEX_MAX_NAME_LEN);
496
497
Christopher Fauletf959d082019-02-07 15:38:42 +0100498 if ((appctx->ctx.stats.flags & PROMEX_FL_METRIC_HDR) &&
Christopher Faulet37286a52021-01-20 15:20:53 +0100499 !promex_dump_metric_header(appctx, htx, metric, name, out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100500 goto full;
501
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100502 if (istcat(out, name, max) == -1)
503 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100504
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100505 if (isttest(labels[0].name)) {
506 int i;
507
508 if (istcat(out, ist("{"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100509 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100510
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100511 for (i = 0; isttest(labels[i].name); i++) {
512 if (!isttest(labels[i].value))
513 continue;
514
515 if ((i && istcat(out, ist(","), max) == -1) ||
516 istcat(out, labels[i].name, max) == -1 ||
517 istcat(out, ist("=\""), max) == -1 ||
518 istcat(out, labels[i].value, max) == -1 ||
519 istcat(out, ist("\""), max) == -1)
520 goto full;
521 }
522
523 if (istcat(out, ist("}"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100524 goto full;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100525
Christopher Fauletf959d082019-02-07 15:38:42 +0100526 }
527
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100528 if (istcat(out, ist(" "), max) == -1)
529 goto full;
530
Christopher Fauletf959d082019-02-07 15:38:42 +0100531 trash.data = out->len;
Christopher Faulet37286a52021-01-20 15:20:53 +0100532 if (!promex_metric_to_str(&trash, val, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100533 goto full;
534 out->len = trash.data;
535
536 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
537 return 1;
538 full:
539 // Restore previous length
540 out->len = len;
541 return 0;
542
543}
544
545
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500546/* Dump global metrics (prefixed by "haproxy_process_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100547 * 0 if <htx> is full and -1 in case of any error. */
548static int promex_dump_global_metrics(struct appctx *appctx, struct htx *htx)
549{
550 static struct ist prefix = IST("haproxy_process_");
Christopher Faulet37286a52021-01-20 15:20:53 +0100551 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100552 struct channel *chn = si_ic(appctx->owner);
553 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200554 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
Christopher Fauletf959d082019-02-07 15:38:42 +0100555 int ret = 1;
556
William Dauchy5d9b8f32021-01-11 20:07:49 +0100557 if (!stats_fill_info(info, INF_TOTAL_FIELDS))
558 return -1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100559
Christopher Faulet37286a52021-01-20 15:20:53 +0100560 for (; appctx->st2 < INF_TOTAL_FIELDS; appctx->st2++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100561 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
562
Christopher Faulet37286a52021-01-20 15:20:53 +0100563 if (!(promex_global_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
564 continue;
565
Christopher Fauletf959d082019-02-07 15:38:42 +0100566 switch (appctx->st2) {
William Dauchy5a982a72021-01-08 13:18:06 +0100567 case INF_BUILD_INFO:
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100568 labels[0].name = ist("version");
569 labels[0].value = ist(HAPROXY_VERSION);
Christopher Faulet37286a52021-01-20 15:20:53 +0100570 val = mkf_u32(FN_GAUGE, 1);
William Dauchy5a982a72021-01-08 13:18:06 +0100571 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100572
573 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100574 val = info[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100575 }
576
William Dauchyc6464592021-01-27 22:40:17 +0100577 if (!promex_dump_metric(appctx, htx, prefix, &promex_global_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100578 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100579 goto full;
580
Christopher Fauletf959d082019-02-07 15:38:42 +0100581 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Christopher Fauletf959d082019-02-07 15:38:42 +0100582 }
583
584 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200585 if (out.len) {
586 if (!htx_add_data_atonce(htx, out))
587 return -1; /* Unexpected and unrecoverable error */
588 channel_add_input(chn, out.len);
589 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100590 return ret;
591 full:
592 ret = 0;
593 goto end;
594}
595
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500596/* Dump frontends metrics (prefixed by "haproxy_frontend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100597 * 0 if <htx> is full and -1 in case of any error. */
598static int promex_dump_front_metrics(struct appctx *appctx, struct htx *htx)
599{
600 static struct ist prefix = IST("haproxy_frontend_");
601 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100602 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100603 struct channel *chn = si_ic(appctx->owner);
604 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200605 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchyb9577452021-01-17 18:27:46 +0100606 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100607 int ret = 1;
William Dauchyc6464592021-01-27 22:40:17 +0100608 enum promex_front_state state;
William Dauchyc6464592021-01-27 22:40:17 +0100609 int i;
Christopher Fauletf959d082019-02-07 15:38:42 +0100610
Christopher Faulet37286a52021-01-20 15:20:53 +0100611 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
612 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
613 continue;
614
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200615 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100616 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
617
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200618 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100619
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100620 labels[0].name = ist("proxy");
621 labels[0].value = ist2(px->id, strlen(px->id));
622
Christopher Fauletf959d082019-02-07 15:38:42 +0100623 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200624 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_FE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100625 goto next_px;
626
William Dauchyb9577452021-01-17 18:27:46 +0100627 if (!stats_fill_fe_stats(px, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
628 return -1;
629
Christopher Fauletf959d082019-02-07 15:38:42 +0100630 switch (appctx->st2) {
631 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100632 state = !px->disabled;
633 for (i = 0; i < PROMEX_FRONT_STATE_COUNT; i++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100634 labels[1].name = ist("state");
635 labels[1].value = promex_front_st[i];
William Dauchyc6464592021-01-27 22:40:17 +0100636 val = mkf_u32(FO_STATUS, state == i);
William Dauchyc6464592021-01-27 22:40:17 +0100637 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100638 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100639 goto full;
640 }
641 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100642 case ST_F_REQ_RATE_MAX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100643 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100644 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100645 case ST_F_INTERCEPTED:
Christopher Fauletf959d082019-02-07 15:38:42 +0100646 case ST_F_CACHE_LOOKUPS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100647 case ST_F_CACHE_HITS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100648 case ST_F_COMP_IN:
Christopher Fauletf959d082019-02-07 15:38:42 +0100649 case ST_F_COMP_OUT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100650 case ST_F_COMP_BYP:
William Dauchyb9577452021-01-17 18:27:46 +0100651 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100652 if (px->mode != PR_MODE_HTTP)
653 goto next_px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100654 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100655 break;
William Dauchyb9577452021-01-17 18:27:46 +0100656 case ST_F_HRSP_2XX:
657 case ST_F_HRSP_3XX:
658 case ST_F_HRSP_4XX:
659 case ST_F_HRSP_5XX:
660 case ST_F_HRSP_OTHER:
Christopher Fauletf959d082019-02-07 15:38:42 +0100661 if (px->mode != PR_MODE_HTTP)
662 goto next_px;
William Dauchyb9577452021-01-17 18:27:46 +0100663 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100664 labels[1].name = ist("code");
665 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
666 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100667 break;
668
669 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100670 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100671 }
672
William Dauchyc6464592021-01-27 22:40:17 +0100673 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100674 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100675 goto full;
676 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200677 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100678 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100679 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200680 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100681 }
682
683 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200684 if (out.len) {
685 if (!htx_add_data_atonce(htx, out))
686 return -1; /* Unexpected and unrecoverable error */
687 channel_add_input(chn, out.len);
688 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100689 return ret;
690 full:
691 ret = 0;
692 goto end;
693}
694
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500695/* Dump backends metrics (prefixed by "haproxy_backend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100696 * 0 if <htx> is full and -1 in case of any error. */
697static int promex_dump_back_metrics(struct appctx *appctx, struct htx *htx)
698{
699 static struct ist prefix = IST("haproxy_backend_");
700 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100701 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100702 struct channel *chn = si_ic(appctx->owner);
703 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200704 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchy3c6f0062021-01-25 17:29:02 +0100705 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100706 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200707 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100708 enum promex_back_state state;
William Dauchyc6464592021-01-27 22:40:17 +0100709 int i;
Christopher Fauletf959d082019-02-07 15:38:42 +0100710
Christopher Faulet37286a52021-01-20 15:20:53 +0100711 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
712 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
713 continue;
714
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200715 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100716 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
717
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200718 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100719
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100720 labels[0].name = ist("proxy");
721 labels[0].value = ist2(px->id, strlen(px->id));
722
Christopher Fauletf959d082019-02-07 15:38:42 +0100723 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200724 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100725 goto next_px;
726
William Dauchy3c6f0062021-01-25 17:29:02 +0100727 if (!stats_fill_be_stats(px, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
728 return -1;
729
Christopher Fauletf959d082019-02-07 15:38:42 +0100730 switch (appctx->st2) {
731 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100732 state = ((px->lbprm.tot_weight > 0 || !px->srv) ? 1 : 0);
733 for (i = 0; i < PROMEX_BACK_STATE_COUNT; i++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100734 labels[1].name = ist("state");
735 labels[1].value = promex_back_st[i];
William Dauchyc6464592021-01-27 22:40:17 +0100736 val = mkf_u32(FO_STATUS, state == i);
William Dauchyc6464592021-01-27 22:40:17 +0100737 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100738 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100739 goto full;
740 }
741 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100742 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200743 secs = (double)swrate_avg(px->be_counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100744 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100745 break;
746 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200747 secs = (double)swrate_avg(px->be_counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100748 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100749 break;
750 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200751 secs = (double)swrate_avg(px->be_counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100752 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100753 break;
754 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200755 secs = (double)swrate_avg(px->be_counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100756 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100757 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100758 case ST_F_QT_MAX:
759 secs = (double)px->be_counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100760 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100761 break;
762 case ST_F_CT_MAX:
763 secs = (double)px->be_counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100764 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100765 break;
766 case ST_F_RT_MAX:
767 secs = (double)px->be_counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100768 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100769 break;
770 case ST_F_TT_MAX:
771 secs = (double)px->be_counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100772 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100773 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100774 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100775 case ST_F_HRSP_1XX:
William Dauchy3c6f0062021-01-25 17:29:02 +0100776 case ST_F_CACHE_LOOKUPS:
777 case ST_F_CACHE_HITS:
778 case ST_F_COMP_IN:
779 case ST_F_COMP_OUT:
780 case ST_F_COMP_BYP:
781 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100782 if (px->mode != PR_MODE_HTTP)
783 goto next_px;
William Dauchy3c6f0062021-01-25 17:29:02 +0100784 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100785 break;
786 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100787 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100788 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100789 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100790 case ST_F_HRSP_OTHER:
791 if (px->mode != PR_MODE_HTTP)
792 goto next_px;
793 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100794 labels[1].name = ist("code");
795 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchy3c6f0062021-01-25 17:29:02 +0100796 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100797 break;
798
799 default:
William Dauchy3c6f0062021-01-25 17:29:02 +0100800 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100801 }
802
William Dauchy3c6f0062021-01-25 17:29:02 +0100803 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100804 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100805 goto full;
806 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200807 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100808 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100809 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200810 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100811 }
812
813 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200814 if (out.len) {
815 if (!htx_add_data_atonce(htx, out))
816 return -1; /* Unexpected and unrecoverable error */
817 channel_add_input(chn, out.len);
818 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100819 return ret;
820 full:
821 ret = 0;
822 goto end;
823}
824
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500825/* Dump servers metrics (prefixed by "haproxy_server_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100826 * 0 if <htx> is full and -1 in case of any error. */
827static int promex_dump_srv_metrics(struct appctx *appctx, struct htx *htx)
828{
829 static struct ist prefix = IST("haproxy_server_");
830 struct proxy *px;
831 struct server *sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100832 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100833 struct channel *chn = si_ic(appctx->owner);
834 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200835 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchybde2bf62021-01-25 17:29:04 +0100836 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100837 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200838 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100839 enum promex_srv_state state;
William Dauchyde3c3262021-02-01 13:11:51 +0100840 const char *check_state;
William Dauchyc6464592021-01-27 22:40:17 +0100841 int i;
Christopher Fauletf959d082019-02-07 15:38:42 +0100842
Christopher Faulet37286a52021-01-20 15:20:53 +0100843 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
844 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
845 continue;
846
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200847 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100848 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
849
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200850 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100851
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100852 labels[0].name = ist("proxy");
853 labels[0].value = ist2(px->id, strlen(px->id));
854
Christopher Fauletf959d082019-02-07 15:38:42 +0100855 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200856 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100857 goto next_px;
858
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200859 while (appctx->ctx.stats.obj2) {
860 sv = appctx->ctx.stats.obj2;
Christopher Fauletf959d082019-02-07 15:38:42 +0100861
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100862 labels[1].name = ist("server");
863 labels[1].value = ist2(sv->id, strlen(sv->id));
864
William Dauchybde2bf62021-01-25 17:29:04 +0100865 if (!stats_fill_sv_stats(px, sv, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
866 return -1;
867
Christopher Fauleteba22942019-11-19 14:18:24 +0100868 if ((appctx->ctx.stats.flags & PROMEX_FL_NO_MAINT_SRV) && (sv->cur_admin & SRV_ADMF_MAINT))
869 goto next_sv;
870
Christopher Fauletf959d082019-02-07 15:38:42 +0100871 switch (appctx->st2) {
872 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100873 state = promex_srv_status(sv);
874 for (i = 0; i < PROMEX_SRV_STATE_COUNT; i++) {
875 val = mkf_u32(FO_STATUS, state == i);
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100876 labels[2].name = ist("state");
877 labels[2].value = promex_srv_st[i];
William Dauchyc6464592021-01-27 22:40:17 +0100878 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100879 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100880 goto full;
881 }
882 goto next_sv;
Christopher Fauletf959d082019-02-07 15:38:42 +0100883 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200884 secs = (double)swrate_avg(sv->counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100885 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100886 break;
887 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200888 secs = (double)swrate_avg(sv->counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100889 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100890 break;
891 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200892 secs = (double)swrate_avg(sv->counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100893 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100894 break;
895 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200896 secs = (double)swrate_avg(sv->counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100897 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100898 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100899 case ST_F_QT_MAX:
900 secs = (double)sv->counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100901 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100902 break;
903 case ST_F_CT_MAX:
904 secs = (double)sv->counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100905 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100906 break;
907 case ST_F_RT_MAX:
908 secs = (double)sv->counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100909 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100910 break;
911 case ST_F_TT_MAX:
912 secs = (double)sv->counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100913 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100914 break;
Christopher Fauletcf403f32019-11-21 14:35:46 +0100915 case ST_F_CHECK_STATUS:
916 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
917 goto next_sv;
William Dauchyde3c3262021-02-01 13:11:51 +0100918
919 for (i = 0; i < HCHK_STATUS_SIZE; i++) {
920 if (get_check_status_result(i) < CHK_RES_FAILED)
921 continue;
922 val = mkf_u32(FO_STATUS, sv->check.status == i);
923 check_state = get_check_status_info(i);
924 labels[2].name = ist("state");
925 labels[2].value = ist2(check_state, strlen(check_state));
926 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
927 &val, labels, &out, max))
928 goto full;
929 }
930 goto next_sv;
Christopher Fauletcf403f32019-11-21 14:35:46 +0100931 case ST_F_CHECK_CODE:
932 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
933 goto next_sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100934 val = mkf_u32(FN_OUTPUT, (sv->check.status < HCHK_STATUS_L57DATA) ? 0 : sv->check.code);
Christopher Fauletcf403f32019-11-21 14:35:46 +0100935 break;
Christopher Faulet2711e512020-02-27 16:12:07 +0100936 case ST_F_CHECK_DURATION:
937 if (sv->check.status < HCHK_STATUS_CHECKED)
938 goto next_sv;
939 secs = (double)sv->check.duration / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100940 val = mkf_flt(FN_DURATION, secs);
Christopher Faulet2711e512020-02-27 16:12:07 +0100941 break;
Marcin Deranek3c27dda2020-05-15 18:32:51 +0200942 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100943 case ST_F_HRSP_1XX:
944 if (px->mode != PR_MODE_HTTP)
945 goto next_px;
William Dauchybde2bf62021-01-25 17:29:04 +0100946 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100947 break;
948 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100949 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100950 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100951 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100952 case ST_F_HRSP_OTHER:
953 if (px->mode != PR_MODE_HTTP)
954 goto next_px;
955 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100956 labels[2].name = ist("code");
957 labels[2].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchybde2bf62021-01-25 17:29:04 +0100958 val = stats[appctx->st2];
Christopher Fauletc55a6262020-07-10 15:39:39 +0200959 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100960
961 default:
William Dauchybde2bf62021-01-25 17:29:04 +0100962 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100963 }
964
William Dauchyc6464592021-01-27 22:40:17 +0100965 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100966 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100967 goto full;
Christopher Fauleteba22942019-11-19 14:18:24 +0100968 next_sv:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200969 appctx->ctx.stats.obj2 = sv->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100970 }
971
972 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200973 appctx->ctx.stats.obj1 = px->next;
974 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +0100975 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100976 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200977 appctx->ctx.stats.obj1 = proxies_list;
978 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +0100979 }
980
981
982 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200983 if (out.len) {
984 if (!htx_add_data_atonce(htx, out))
985 return -1; /* Unexpected and unrecoverable error */
986 channel_add_input(chn, out.len);
987 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100988 return ret;
989 full:
990 ret = 0;
991 goto end;
992}
993
994/* Dump all metrics (global, frontends, backends and servers) depending on the
995 * dumper state (appctx->st1). It returns 1 on success, 0 if <htx> is full and
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200996 * -1 in case of any error.
997 * Uses <appctx.ctx.stats.obj1> as a pointer to the current proxy and <obj2> as
998 * a pointer to the current server/listener. */
Christopher Fauletf959d082019-02-07 15:38:42 +0100999static int promex_dump_metrics(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1000{
1001 int ret;
1002
1003 switch (appctx->st1) {
1004 case PROMEX_DUMPER_INIT:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001005 appctx->ctx.stats.obj1 = NULL;
1006 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001007 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_INFO_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001008 appctx->st2 = INF_NAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001009 appctx->st1 = PROMEX_DUMPER_GLOBAL;
1010 /* fall through */
1011
1012 case PROMEX_DUMPER_GLOBAL:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001013 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_GLOBAL) {
1014 ret = promex_dump_global_metrics(appctx, htx);
1015 if (ret <= 0) {
1016 if (ret == -1)
1017 goto error;
1018 goto full;
1019 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001020 }
1021
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001022 appctx->ctx.stats.obj1 = proxies_list;
1023 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001024 appctx->ctx.stats.flags &= ~PROMEX_FL_INFO_METRIC;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001025 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_FRONT_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001026 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001027 appctx->st1 = PROMEX_DUMPER_FRONT;
1028 /* fall through */
1029
1030 case PROMEX_DUMPER_FRONT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001031 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_FRONT) {
1032 ret = promex_dump_front_metrics(appctx, htx);
1033 if (ret <= 0) {
1034 if (ret == -1)
1035 goto error;
1036 goto full;
1037 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001038 }
1039
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001040 appctx->ctx.stats.obj1 = proxies_list;
1041 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001042 appctx->ctx.stats.flags &= ~PROMEX_FL_FRONT_METRIC;
1043 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_BACK_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001044 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001045 appctx->st1 = PROMEX_DUMPER_BACK;
1046 /* fall through */
1047
1048 case PROMEX_DUMPER_BACK:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001049 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_BACK) {
1050 ret = promex_dump_back_metrics(appctx, htx);
1051 if (ret <= 0) {
1052 if (ret == -1)
1053 goto error;
1054 goto full;
1055 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001056 }
1057
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001058 appctx->ctx.stats.obj1 = proxies_list;
1059 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001060 appctx->ctx.stats.flags &= ~PROMEX_FL_BACK_METRIC;
1061 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
Christopher Faulet37286a52021-01-20 15:20:53 +01001062 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001063 appctx->st1 = PROMEX_DUMPER_SRV;
1064 /* fall through */
1065
1066 case PROMEX_DUMPER_SRV:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001067 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_SERVER) {
1068 ret = promex_dump_srv_metrics(appctx, htx);
1069 if (ret <= 0) {
1070 if (ret == -1)
1071 goto error;
1072 goto full;
1073 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001074 }
1075
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001076 appctx->ctx.stats.obj1 = NULL;
1077 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001078 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
Christopher Fauletf959d082019-02-07 15:38:42 +01001079 appctx->st2 = 0;
1080 appctx->st1 = PROMEX_DUMPER_DONE;
1081 /* fall through */
1082
1083 case PROMEX_DUMPER_DONE:
1084 default:
1085 break;
1086 }
1087
1088 return 1;
1089
1090 full:
1091 si_rx_room_blk(si);
1092 return 0;
1093 error:
1094 /* unrecoverable error */
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001095 appctx->ctx.stats.obj1 = NULL;
1096 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletf959d082019-02-07 15:38:42 +01001097 appctx->ctx.stats.flags = 0;
1098 appctx->st2 = 0;
1099 appctx->st1 = PROMEX_DUMPER_DONE;
1100 return -1;
1101}
1102
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001103/* Parse the query string of request URI to filter the metrics. It returns 1 on
Christopher Faulet78407ce2019-11-18 14:47:08 +01001104 * success and -1 on error. */
1105static int promex_parse_uri(struct appctx *appctx, struct stream_interface *si)
1106{
1107 struct channel *req = si_oc(si);
1108 struct channel *res = si_ic(si);
1109 struct htx *req_htx, *res_htx;
1110 struct htx_sl *sl;
William Dauchyc65f6562019-11-26 12:56:26 +01001111 char *p, *key, *value;
1112 const char *end;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001113 struct buffer *err;
1114 int default_scopes = PROMEX_FL_SCOPE_ALL;
1115 int len;
1116
1117 /* Get the query-string */
1118 req_htx = htxbuf(&req->buf);
1119 sl = http_get_stline(req_htx);
1120 if (!sl)
1121 goto error;
1122 p = http_find_param_list(HTX_SL_REQ_UPTR(sl), HTX_SL_REQ_ULEN(sl), '?');
1123 if (!p)
1124 goto end;
1125 end = HTX_SL_REQ_UPTR(sl) + HTX_SL_REQ_ULEN(sl);
Christopher Faulet78407ce2019-11-18 14:47:08 +01001126
William Dauchyc65f6562019-11-26 12:56:26 +01001127 /* copy the query-string */
1128 len = end - p;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001129 chunk_reset(&trash);
1130 memcpy(trash.area, p, len);
1131 trash.area[len] = 0;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001132 p = trash.area;
William Dauchyc65f6562019-11-26 12:56:26 +01001133 end = trash.area + len;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001134
1135 /* Parse the query-string */
William Dauchyc65f6562019-11-26 12:56:26 +01001136 while (p < end && *p && *p != '#') {
1137 value = NULL;
1138
1139 /* decode parameter name */
1140 key = p;
1141 while (p < end && *p != '=' && *p != '&' && *p != '#')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001142 ++p;
William Dauchyc65f6562019-11-26 12:56:26 +01001143 /* found a value */
1144 if (*p == '=') {
1145 *(p++) = 0;
1146 value = p;
1147 }
1148 else if (*p == '&')
1149 *(p++) = 0;
1150 else if (*p == '#')
1151 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001152 len = url_decode(key, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001153 if (len == -1)
1154 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001155
William Dauchyc65f6562019-11-26 12:56:26 +01001156 /* decode value */
1157 if (value) {
1158 while (p < end && *p != '=' && *p != '&' && *p != '#')
1159 ++p;
1160 if (*p == '=')
1161 goto error;
1162 if (*p == '&')
1163 *(p++) = 0;
1164 else if (*p == '#')
1165 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001166 len = url_decode(value, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001167 if (len == -1)
1168 goto error;
1169 }
1170
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001171 if (strcmp(key, "scope") == 0) {
William Dauchyc65f6562019-11-26 12:56:26 +01001172 default_scopes = 0; /* at least a scope defined, unset default scopes */
1173 if (!value)
1174 goto error;
1175 else if (*value == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001176 appctx->ctx.stats.flags &= ~PROMEX_FL_SCOPE_ALL;
William Dauchyc65f6562019-11-26 12:56:26 +01001177 else if (*value == '*')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001178 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_ALL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001179 else if (strcmp(value, "global") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001180 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_GLOBAL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001181 else if (strcmp(value, "server") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001182 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_SERVER;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001183 else if (strcmp(value, "backend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001184 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_BACK;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001185 else if (strcmp(value, "frontend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001186 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_FRONT;
1187 else
1188 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001189 }
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001190 else if (strcmp(key, "no-maint") == 0)
Christopher Fauleteba22942019-11-19 14:18:24 +01001191 appctx->ctx.stats.flags |= PROMEX_FL_NO_MAINT_SRV;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001192 }
1193
1194 end:
1195 appctx->ctx.stats.flags |= default_scopes;
1196 return 1;
1197
1198 error:
1199 err = &http_err_chunks[HTTP_ERR_400];
1200 channel_erase(res);
1201 res->buf.data = b_data(err);
1202 memcpy(res->buf.area, b_head(err), b_data(err));
1203 res_htx = htx_from_buf(&res->buf);
1204 channel_add_input(res, res_htx->data);
1205 appctx->st0 = PROMEX_ST_END;
1206 return -1;
1207}
1208
Christopher Fauletf959d082019-02-07 15:38:42 +01001209/* Send HTTP headers of the response. It returns 1 on success and 0 if <htx> is
1210 * full. */
1211static int promex_send_headers(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1212{
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001213 struct channel *chn = si_ic(appctx->owner);
Christopher Fauletf959d082019-02-07 15:38:42 +01001214 struct htx_sl *sl;
1215 unsigned int flags;
1216
1217 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);
1218 sl = htx_add_stline(htx, HTX_BLK_RES_SL, flags, ist("HTTP/1.1"), ist("200"), ist("OK"));
1219 if (!sl)
1220 goto full;
1221 sl->info.res.status = 200;
1222 if (!htx_add_header(htx, ist("Cache-Control"), ist("no-cache")) ||
Christopher Fauletf959d082019-02-07 15:38:42 +01001223 !htx_add_header(htx, ist("Content-Type"), ist("text/plain; version=0.0.4")) ||
1224 !htx_add_header(htx, ist("Transfer-Encoding"), ist("chunked")) ||
1225 !htx_add_endof(htx, HTX_BLK_EOH))
1226 goto full;
1227
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001228 channel_add_input(chn, htx->data);
Christopher Fauletf959d082019-02-07 15:38:42 +01001229 return 1;
1230 full:
1231 htx_reset(htx);
1232 si_rx_room_blk(si);
1233 return 0;
1234}
1235
1236/* The function returns 1 if the initialisation is complete, 0 if
1237 * an errors occurs and -1 if more data are required for initializing
1238 * the applet.
1239 */
1240static int promex_appctx_init(struct appctx *appctx, struct proxy *px, struct stream *strm)
1241{
1242 appctx->st0 = PROMEX_ST_INIT;
1243 return 1;
1244}
1245
1246/* The main I/O handler for the promex applet. */
1247static void promex_appctx_handle_io(struct appctx *appctx)
1248{
1249 struct stream_interface *si = appctx->owner;
1250 struct stream *s = si_strm(si);
1251 struct channel *req = si_oc(si);
1252 struct channel *res = si_ic(si);
1253 struct htx *req_htx, *res_htx;
1254 int ret;
1255
1256 res_htx = htx_from_buf(&res->buf);
Christopher Fauletf959d082019-02-07 15:38:42 +01001257 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1258 goto out;
1259
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001260 /* Check if the input buffer is available. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001261 if (!b_size(&res->buf)) {
1262 si_rx_room_blk(si);
1263 goto out;
1264 }
1265
1266 switch (appctx->st0) {
1267 case PROMEX_ST_INIT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001268 ret = promex_parse_uri(appctx, si);
1269 if (ret <= 0) {
1270 if (ret == -1)
1271 goto error;
1272 goto out;
1273 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001274 appctx->st0 = PROMEX_ST_HEAD;
1275 appctx->st1 = PROMEX_DUMPER_INIT;
1276 /* fall through */
1277
1278 case PROMEX_ST_HEAD:
1279 if (!promex_send_headers(appctx, si, res_htx))
1280 goto out;
1281 appctx->st0 = ((s->txn->meth == HTTP_METH_HEAD) ? PROMEX_ST_DONE : PROMEX_ST_DUMP);
1282 /* fall through */
1283
1284 case PROMEX_ST_DUMP:
1285 ret = promex_dump_metrics(appctx, si, res_htx);
1286 if (ret <= 0) {
1287 if (ret == -1)
1288 goto error;
1289 goto out;
1290 }
1291 appctx->st0 = PROMEX_ST_DONE;
1292 /* fall through */
1293
1294 case PROMEX_ST_DONE:
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001295 /* no more data are expected. Don't add TLR because mux-h1 will take care of it */
1296 res_htx->flags |= HTX_FL_EOM;
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001297 appctx->st0 = PROMEX_ST_END;
1298 /* fall through */
Christopher Fauletf959d082019-02-07 15:38:42 +01001299
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001300 case PROMEX_ST_END:
1301 if (!(res->flags & CF_SHUTR)) {
1302 res->flags |= CF_READ_NULL;
1303 si_shutr(si);
1304 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001305 }
1306
Christopher Fauletf959d082019-02-07 15:38:42 +01001307 out:
1308 htx_to_buf(res_htx, &res->buf);
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001309
1310 /* eat the whole request */
1311 if (co_data(req)) {
1312 req_htx = htx_from_buf(&req->buf);
1313 co_htx_skip(req, req_htx, co_data(req));
1314 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001315 return;
1316
1317 error:
1318 res->flags |= CF_READ_NULL;
1319 si_shutr(si);
1320 si_shutw(si);
1321}
1322
1323struct applet promex_applet = {
1324 .obj_type = OBJ_TYPE_APPLET,
1325 .name = "<PROMEX>", /* used for logging */
1326 .init = promex_appctx_init,
1327 .fct = promex_appctx_handle_io,
1328};
1329
1330static enum act_parse_ret service_parse_prometheus_exporter(const char **args, int *cur_arg, struct proxy *px,
1331 struct act_rule *rule, char **err)
1332{
1333 /* Prometheus exporter service is only available on "http-request" rulesets */
1334 if (rule->from != ACT_F_HTTP_REQ) {
1335 memprintf(err, "Prometheus exporter service only available on 'http-request' rulesets");
1336 return ACT_RET_PRS_ERR;
1337 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001338
1339 /* Add applet pointer in the rule. */
1340 rule->applet = promex_applet;
1341
1342 return ACT_RET_PRS_OK;
1343}
1344static void promex_register_build_options(void)
1345{
1346 char *ptr = NULL;
1347
1348 memprintf(&ptr, "Built with the Prometheus exporter as a service");
1349 hap_register_build_opts(ptr, 1);
1350}
1351
1352
1353static struct action_kw_list service_actions = { ILH, {
1354 { "prometheus-exporter", service_parse_prometheus_exporter },
1355 { /* END */ }
1356}};
1357
1358INITCALL1(STG_REGISTER, service_keywords_register, &service_actions);
1359INITCALL0(STG_REGISTER, promex_register_build_options);