blob: 69fb26a1ea69f558e8983050ab5e79162f3e8bbe [file] [log] [blame]
Christopher Fauletf959d082019-02-07 15:38:42 +01001/*
2 * Promex is a Prometheus exporter for HAProxy
3 *
4 * It is highly inspired by the official Prometheus exporter.
5 * See: https://github.com/prometheus/haproxy_exporter
6 *
7 * Copyright 2019 Christopher Faulet <cfaulet@haproxy.com>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version
12 * 2 of the License, or (at your option) any later version.
13 *
14 */
15
Willy Tarreau122eba92020-06-04 10:15:32 +020016#include <haproxy/action-t.h>
Willy Tarreaub2551052020-06-09 09:07:15 +020017#include <haproxy/api.h>
Willy Tarreau3f0f82e2020-06-04 19:42:41 +020018#include <haproxy/applet.h>
Willy Tarreau49801602020-06-04 22:50:02 +020019#include <haproxy/backend.h>
Willy Tarreau6be78492020-06-05 00:00:29 +020020#include <haproxy/cfgparse.h>
William Dauchyde3c3262021-02-01 13:11:51 +010021#include <haproxy/check.h>
Willy Tarreau762d7a52020-06-04 11:23:07 +020022#include <haproxy/frontend.h>
Willy Tarreauf268ee82020-06-04 17:05:57 +020023#include <haproxy/global.h>
Willy Tarreaucd72d8c2020-06-02 19:11:26 +020024#include <haproxy/http.h>
Willy Tarreaub7fc4c42021-10-06 18:56:42 +020025#include <haproxy/http_ana.h>
Willy Tarreau87735332020-06-04 09:08:41 +020026#include <haproxy/http_htx.h>
Willy Tarreau16f958c2020-06-03 08:44:35 +020027#include <haproxy/htx.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020028#include <haproxy/list.h>
Willy Tarreau213e9902020-06-04 14:58:24 +020029#include <haproxy/listener.h>
Willy Tarreau36979d92020-06-05 17:27:29 +020030#include <haproxy/log.h>
Willy Tarreaua264d962020-06-04 22:29:18 +020031#include <haproxy/proxy.h>
Willy Tarreaue6ce10b2020-06-04 15:33:47 +020032#include <haproxy/sample.h>
Willy Tarreau1e56f922020-06-04 23:20:13 +020033#include <haproxy/server.h>
Willy Tarreau2eec9b52020-06-04 19:58:55 +020034#include <haproxy/stats.h>
Willy Tarreaudfd3de82020-06-04 23:46:14 +020035#include <haproxy/stream.h>
Willy Tarreau5e539c92020-06-04 20:45:39 +020036#include <haproxy/stream_interface.h>
Willy Tarreaucea0e1b2020-06-04 17:25:40 +020037#include <haproxy/task.h>
Willy Tarreau0fd04fd2021-05-08 12:58:12 +020038#include <haproxy/tools.h>
William Dauchy5a982a72021-01-08 13:18:06 +010039#include <haproxy/version.h>
Christopher Fauletf959d082019-02-07 15:38:42 +010040
41/* Prometheus exporter applet states (appctx->st0) */
42enum {
43 PROMEX_ST_INIT = 0, /* initialized */
44 PROMEX_ST_HEAD, /* send headers before dump */
45 PROMEX_ST_DUMP, /* dumping stats */
46 PROMEX_ST_DONE, /* finished */
Christopher Faulet9744f7c2019-03-27 15:48:53 +010047 PROMEX_ST_END, /* treatment terminated */
Christopher Fauletf959d082019-02-07 15:38:42 +010048};
49
50/* Prometheus exporter dumper states (appctx->st1) */
51enum {
William Dauchy69164222021-02-07 20:42:38 +010052 PROMEX_DUMPER_INIT = 0, /* initialized */
53 PROMEX_DUMPER_GLOBAL, /* dump metrics of globals */
54 PROMEX_DUMPER_FRONT, /* dump metrics of frontend proxies */
55 PROMEX_DUMPER_BACK, /* dump metrics of backend proxies */
56 PROMEX_DUMPER_LI, /* dump metrics of listeners */
57 PROMEX_DUMPER_SRV, /* dump metrics of servers */
58 PROMEX_DUMPER_STICKTABLE, /* dump metrics of stick tables */
59 PROMEX_DUMPER_DONE, /* finished */
Christopher Fauletf959d082019-02-07 15:38:42 +010060};
61
62/* Prometheus exporter flags (appctx->ctx.stats.flags) */
William Dauchy69164222021-02-07 20:42:38 +010063#define PROMEX_FL_METRIC_HDR 0x00000001
64#define PROMEX_FL_INFO_METRIC 0x00000002
65#define PROMEX_FL_FRONT_METRIC 0x00000004
66#define PROMEX_FL_BACK_METRIC 0x00000008
67#define PROMEX_FL_SRV_METRIC 0x00000010
William Dauchye3f7bd52021-02-14 23:22:56 +010068#define PROMEX_FL_LI_METRIC 0x00000020
69#define PROMEX_FL_STICKTABLE_METRIC 0x00000040
70#define PROMEX_FL_SCOPE_GLOBAL 0x00000080
71#define PROMEX_FL_SCOPE_FRONT 0x00000100
72#define PROMEX_FL_SCOPE_BACK 0x00000200
73#define PROMEX_FL_SCOPE_SERVER 0x00000400
74#define PROMEX_FL_SCOPE_LI 0x00000800
75#define PROMEX_FL_SCOPE_STICKTABLE 0x00001000
76#define PROMEX_FL_NO_MAINT_SRV 0x00002000
Christopher Faulet78407ce2019-11-18 14:47:08 +010077
William Dauchy69164222021-02-07 20:42:38 +010078#define PROMEX_FL_SCOPE_ALL (PROMEX_FL_SCOPE_GLOBAL | PROMEX_FL_SCOPE_FRONT | \
William Dauchye3f7bd52021-02-14 23:22:56 +010079 PROMEX_FL_SCOPE_LI | PROMEX_FL_SCOPE_BACK | \
80 PROMEX_FL_SCOPE_SERVER | PROMEX_FL_SCOPE_STICKTABLE)
Christopher Fauletf959d082019-02-07 15:38:42 +010081
Christopher Faulet0312c0d2021-01-20 15:19:12 +010082/* Promtheus metric type (gauge or counter) */
83enum promex_mt_type {
84 PROMEX_MT_GAUGE = 1,
85 PROMEX_MT_COUNTER = 2,
86};
87
Christopher Fauletf959d082019-02-07 15:38:42 +010088/* The max length for metrics name. It is a hard limit but it should be
Ilya Shipitsince7b00f2020-03-23 22:28:40 +050089 * enough.
Christopher Fauletf959d082019-02-07 15:38:42 +010090 */
91#define PROMEX_MAX_NAME_LEN 128
92
93/* The expected max length for a metric dump, including its header lines. It is
94 * just a soft limit to avoid extra work. We don't try to dump a metric if less
95 * than this size is available in the HTX.
96 */
97#define PROMEX_MAX_METRIC_LENGTH 512
98
Christopher Faulet5a2f9382021-01-28 11:24:17 +010099/* The max number of labels per metric */
100#define PROMEX_MAX_LABELS 8
William Dauchy5a982a72021-01-08 13:18:06 +0100101
Christopher Faulet0312c0d2021-01-20 15:19:12 +0100102/* Describe a prometheus metric */
103struct promex_metric {
104 const struct ist n; /* The metric name */
105 enum promex_mt_type type; /* The metric type (gauge or counter) */
106 unsigned int flags; /* PROMEX_FL_* flags */
107};
108
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100109/* Describe a prometheus metric label. It is just a key/value pair */
110struct promex_label {
111 struct ist name;
112 struct ist value;
113};
114
Christopher Faulet37286a52021-01-20 15:20:53 +0100115/* Global metrics */
116const struct promex_metric promex_global_metrics[INF_TOTAL_FIELDS] = {
117 //[INF_NAME] ignored
118 //[INF_VERSION], ignored
119 //[INF_RELEASE_DATE] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100120 [INF_NBTHREAD] = { .n = IST("nbthread"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
121 [INF_NBPROC] = { .n = IST("nbproc"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
122 [INF_PROCESS_NUM] = { .n = IST("relative_process_id"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
123 //[INF_PID] ignored
124 //[INF_UPTIME] ignored
125 [INF_UPTIME_SEC] = { .n = IST("uptime_seconds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
126 [INF_START_TIME_SEC] = { .n = IST("start_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100127 //[INF_MEMMAX_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100128 [INF_MEMMAX_BYTES] = { .n = IST("max_memory_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100129 //[INF_POOL_ALLOC_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100130 [INF_POOL_ALLOC_BYTES] = { .n = IST("pool_allocated_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100131 //[INF_POOL_USED_MB] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100132 [INF_POOL_USED_BYTES] = { .n = IST("pool_used_bytes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
133 [INF_POOL_FAILED] = { .n = IST("pool_failures_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
134 [INF_ULIMIT_N] = { .n = IST("max_fds"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
135 [INF_MAXSOCK] = { .n = IST("max_sockets"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
136 [INF_MAXCONN] = { .n = IST("max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
137 [INF_HARD_MAXCONN] = { .n = IST("hard_max_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
138 [INF_CURR_CONN] = { .n = IST("current_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
139 [INF_CUM_CONN] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
140 [INF_CUM_REQ] = { .n = IST("requests_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
141 [INF_MAX_SSL_CONNS] = { .n = IST("max_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
142 [INF_CURR_SSL_CONNS] = { .n = IST("current_ssl_connections"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
143 [INF_CUM_SSL_CONNS] = { .n = IST("ssl_connections_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
144 [INF_MAXPIPES] = { .n = IST("max_pipes"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
145 [INF_PIPES_USED] = { .n = IST("pipes_used_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
146 [INF_PIPES_FREE] = { .n = IST("pipes_free_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
147 [INF_CONN_RATE] = { .n = IST("current_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
148 [INF_CONN_RATE_LIMIT] = { .n = IST("limit_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
149 [INF_MAX_CONN_RATE] = { .n = IST("max_connection_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
150 [INF_SESS_RATE] = { .n = IST("current_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
151 [INF_SESS_RATE_LIMIT] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
152 [INF_MAX_SESS_RATE] = { .n = IST("max_session_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
153 [INF_SSL_RATE] = { .n = IST("current_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
154 [INF_SSL_RATE_LIMIT] = { .n = IST("limit_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
155 [INF_MAX_SSL_RATE] = { .n = IST("max_ssl_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
156 [INF_SSL_FRONTEND_KEY_RATE] = { .n = IST("current_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
157 [INF_SSL_FRONTEND_MAX_KEY_RATE] = { .n = IST("max_frontend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
158 [INF_SSL_FRONTEND_SESSION_REUSE_PCT] = { .n = IST("frontend_ssl_reuse"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
159 [INF_SSL_BACKEND_KEY_RATE] = { .n = IST("current_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
160 [INF_SSL_BACKEND_MAX_KEY_RATE] = { .n = IST("max_backend_ssl_key_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
161 [INF_SSL_CACHE_LOOKUPS] = { .n = IST("ssl_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
162 [INF_SSL_CACHE_MISSES] = { .n = IST("ssl_cache_misses_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
163 [INF_COMPRESS_BPS_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
164 [INF_COMPRESS_BPS_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
165 [INF_COMPRESS_BPS_RATE_LIM] = { .n = IST("limit_http_comp"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
166 [INF_ZLIB_MEM_USAGE] = { .n = IST("current_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
167 [INF_MAX_ZLIB_MEM_USAGE] = { .n = IST("max_zlib_memory"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
168 [INF_TASKS] = { .n = IST("current_tasks"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
169 [INF_RUN_QUEUE] = { .n = IST("current_run_queue"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
170 [INF_IDLE_PCT] = { .n = IST("idle_time_percent"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
171 //[INF_NODE] ignored
172 //[INF_DESCRIPTION] ignored
173 [INF_STOPPING] = { .n = IST("stopping"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
174 [INF_JOBS] = { .n = IST("jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
175 [INF_UNSTOPPABLE_JOBS] = { .n = IST("unstoppable_jobs"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
176 [INF_LISTENERS] = { .n = IST("listeners"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
177 [INF_ACTIVE_PEERS] = { .n = IST("active_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
178 [INF_CONNECTED_PEERS] = { .n = IST("connected_peers"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
179 [INF_DROPPED_LOGS] = { .n = IST("dropped_logs_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
180 [INF_BUSY_POLLING] = { .n = IST("busy_polling_enabled"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
181 [INF_FAILED_RESOLUTIONS] = { .n = IST("failed_resolutions"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
182 [INF_TOTAL_BYTES_OUT] = { .n = IST("bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
183 [INF_TOTAL_SPLICED_BYTES_OUT] = { .n = IST("spliced_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
184 [INF_BYTES_OUT_RATE] = { .n = IST("bytes_out_rate"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
185 //[INF_DEBUG_COMMANDS_ISSUED] ignored
William Dauchy7741c332021-02-01 13:11:57 +0100186 [INF_CUM_LOG_MSGS] = { .n = IST("recv_logs_total"), .type = PROMEX_MT_COUNTER, .flags = PROMEX_FL_INFO_METRIC },
William Dauchydf9a05d2021-02-01 13:11:59 +0100187 [INF_BUILD_INFO] = { .n = IST("build_info"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_INFO_METRIC },
Christopher Fauletf959d082019-02-07 15:38:42 +0100188};
189
Christopher Faulet37286a52021-01-20 15:20:53 +0100190/* frontend/backend/server fields */
191const struct promex_metric promex_st_metrics[ST_F_TOTAL_FIELDS] = {
192 //[ST_F_PXNAME] ignored
193 //[ST_F_SVNAME] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100194 [ST_F_QCUR] = { .n = IST("current_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
195 [ST_F_QMAX] = { .n = IST("max_queue"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
196 [ST_F_SCUR] = { .n = IST("current_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
197 [ST_F_SMAX] = { .n = IST("max_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
198 [ST_F_SLIM] = { .n = IST("limit_sessions"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
199 [ST_F_STOT] = { .n = IST("sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
200 [ST_F_BIN] = { .n = IST("bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
201 [ST_F_BOUT] = { .n = IST("bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
202 [ST_F_DREQ] = { .n = IST("requests_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC ) },
203 [ST_F_DRESP] = { .n = IST("responses_denied_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
204 [ST_F_EREQ] = { .n = IST("request_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC ) },
205 [ST_F_ECON] = { .n = IST("connection_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
206 [ST_F_ERESP] = { .n = IST("response_errors_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
207 [ST_F_WRETR] = { .n = IST("retry_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
208 [ST_F_WREDIS] = { .n = IST("redispatch_warnings_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
209 [ST_F_STATUS] = { .n = IST("status"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
210 [ST_F_WEIGHT] = { .n = IST("weight"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
211 [ST_F_ACT] = { .n = IST("active_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
212 [ST_F_BCK] = { .n = IST("backup_servers"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC ) },
213 [ST_F_CHKFAIL] = { .n = IST("check_failures_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_SRV_METRIC) },
214 [ST_F_CHKDOWN] = { .n = IST("check_up_down_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
215 [ST_F_LASTCHG] = { .n = IST("check_last_change_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
216 [ST_F_DOWNTIME] = { .n = IST("downtime_seconds_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
217 [ST_F_QLIMIT] = { .n = IST("queue_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100218 //[ST_F_PID] ignored
219 //[ST_F_IID] ignored
220 //[ST_F_SID] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100221 [ST_F_THROTTLE] = { .n = IST("current_throttle"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
222 [ST_F_LBTOT] = { .n = IST("loadbalanced_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100223 //[ST_F_TRACKED] ignored
224 //[ST_F_TYPE] ignored
225 //[ST_F_RATE] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100226 [ST_F_RATE_LIM] = { .n = IST("limit_session_rate"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
227 [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) },
228 [ST_F_CHECK_STATUS] = { .n = IST("check_status"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
229 [ST_F_CHECK_CODE] = { .n = IST("check_code"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
230 [ST_F_CHECK_DURATION] = { .n = IST("check_duration_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
231 [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) },
232 [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) },
233 [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) },
234 [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) },
235 [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) },
236 [ST_F_HRSP_OTHER] = { .n = IST("http_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100237 //[ST_F_HANAFAIL] ignored
238 //[ST_F_REQ_RATE] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100239 [ST_F_REQ_RATE_MAX] = { .n = IST("http_requests_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
240 [ST_F_REQ_TOT] = { .n = IST("http_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
241 [ST_F_CLI_ABRT] = { .n = IST("client_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
242 [ST_F_SRV_ABRT] = { .n = IST("server_aborts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
243 [ST_F_COMP_IN] = { .n = IST("http_comp_bytes_in_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
244 [ST_F_COMP_OUT] = { .n = IST("http_comp_bytes_out_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
245 [ST_F_COMP_BYP] = { .n = IST("http_comp_bytes_bypassed_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
246 [ST_F_COMP_RSP] = { .n = IST("http_comp_responses_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
247 [ST_F_LASTSESS] = { .n = IST("last_session_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Ilya Shipitsinacf84592021-02-06 22:29:08 +0500248 //[ST_F_LAST_CHK] ignored
Christopher Faulet37286a52021-01-20 15:20:53 +0100249 //[ST_F_LAST_AGT] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100250 [ST_F_QTIME] = { .n = IST("queue_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
251 [ST_F_CTIME] = { .n = IST("connect_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
252 [ST_F_RTIME] = { .n = IST("response_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
253 [ST_F_TTIME] = { .n = IST("total_time_average_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
Christopher Faulet37286a52021-01-20 15:20:53 +0100254 //[ST_F_AGENT_STATUS] ignored
255 //[ST_F_AGENT_CODE] ignored
256 //[ST_F_AGENT_DURATION] ignored
257 //[ST_F_CHECK_DESC] ignored
258 //[ST_F_AGENT_DESC] ignored
259 //[ST_F_CHECK_RISE] ignored
260 //[ST_F_CHECK_FALL] ignored
261 //[ST_F_CHECK_HEALTH] ignored
262 //[ST_F_AGENT_RISE] ignored
263 //[ST_F_AGENT_FALL] ignored
264 //[ST_F_AGENT_HEALTH] ignored
265 //[ST_F_ADDR] ignored
266 //[ST_F_COOKIE] ignored
267 //[ST_F_MODE] ignored
268 //[ST_F_ALGO] ignored
269 //[ST_F_CONN_RATE] ignored
William Dauchye3f7bd52021-02-14 23:22:56 +0100270 [ST_F_CONN_RATE_MAX] = { .n = IST("connections_rate_max"), .type = PROMEX_MT_GAUGE, .flags = (PROMEX_FL_FRONT_METRIC ) },
271 [ST_F_CONN_TOT] = { .n = IST("connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
272 [ST_F_INTERCEPTED] = { .n = IST("intercepted_requests_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC ) },
273 [ST_F_DCON] = { .n = IST("denied_connections_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC ) },
274 [ST_F_DSES] = { .n = IST("denied_sessions_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC ) },
275 [ST_F_WREW] = { .n = IST("failed_header_rewriting_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
276 [ST_F_CONNECT] = { .n = IST("connection_attempts_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
277 [ST_F_REUSE] = { .n = IST("connection_reuses_total"), .type = PROMEX_MT_COUNTER, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
278 [ST_F_CACHE_LOOKUPS] = { .n = IST("http_cache_lookups_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
279 [ST_F_CACHE_HITS] = { .n = IST("http_cache_hits_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_BACK_METRIC ) },
280 [ST_F_SRV_ICUR] = { .n = IST("idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
281 [ST_F_SRV_ILIM] = { .n = IST("idle_connections_limit"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
282 [ST_F_QT_MAX] = { .n = IST("max_queue_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
283 [ST_F_CT_MAX] = { .n = IST("max_connect_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
284 [ST_F_RT_MAX] = { .n = IST("max_response_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
285 [ST_F_TT_MAX] = { .n = IST("max_total_time_seconds"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
286 [ST_F_EINT] = { .n = IST("internal_errors_total"), .type = PROMEX_MT_COUNTER, .flags = (PROMEX_FL_FRONT_METRIC | PROMEX_FL_LI_METRIC | PROMEX_FL_BACK_METRIC | PROMEX_FL_SRV_METRIC) },
287 [ST_F_IDLE_CONN_CUR] = { .n = IST("unsafe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
288 [ST_F_SAFE_CONN_CUR] = { .n = IST("safe_idle_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
289 [ST_F_USED_CONN_CUR] = { .n = IST("used_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
290 [ST_F_NEED_CONN_EST] = { .n = IST("need_connections_current"), .type = PROMEX_MT_GAUGE, .flags = ( PROMEX_FL_SRV_METRIC) },
291 [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 +0100292};
293
Ilya Shipitsinacf84592021-02-06 22:29:08 +0500294/* Description of overridden stats fields */
Christopher Fauletf959d082019-02-07 15:38:42 +0100295const struct ist promex_st_metric_desc[ST_F_TOTAL_FIELDS] = {
William Dauchya1da7ba2021-02-01 13:11:52 +0100296 [ST_F_STATUS] = IST("Current status of the service, per state label value."),
William Dauchyde3c3262021-02-01 13:11:51 +0100297 [ST_F_CHECK_STATUS] = IST("Status of last health check, per state label value."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100298 [ST_F_CHECK_CODE] = IST("layer5-7 code, if available of the last health check."),
Christopher Faulet2711e512020-02-27 16:12:07 +0100299 [ST_F_CHECK_DURATION] = IST("Total duration of the latest server health check, in seconds."),
Christopher Fauletf959d082019-02-07 15:38:42 +0100300 [ST_F_QTIME] = IST("Avg. queue time for last 1024 successful connections."),
301 [ST_F_CTIME] = IST("Avg. connect time for last 1024 successful connections."),
302 [ST_F_RTIME] = IST("Avg. response time for last 1024 successful connections."),
303 [ST_F_TTIME] = IST("Avg. total time for last 1024 successful connections."),
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100304 [ST_F_QT_MAX] = IST("Maximum observed time spent in the queue"),
305 [ST_F_CT_MAX] = IST("Maximum observed time spent waiting for a connection to complete"),
306 [ST_F_RT_MAX] = IST("Maximum observed time spent waiting for a server response"),
307 [ST_F_TT_MAX] = IST("Maximum observed total request+response time (request+queue+connect+response+processing)"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100308};
309
William Dauchy69164222021-02-07 20:42:38 +0100310/* stick table base fields */
311enum sticktable_field {
312 STICKTABLE_SIZE = 0,
313 STICKTABLE_USED,
314 /* must always be the last one */
315 STICKTABLE_TOTAL_FIELDS
316};
317
318const struct promex_metric promex_sticktable_metrics[STICKTABLE_TOTAL_FIELDS] = {
319 [STICKTABLE_SIZE] = { .n = IST("size"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_STICKTABLE_METRIC },
320 [STICKTABLE_USED] = { .n = IST("used"), .type = PROMEX_MT_GAUGE, .flags = PROMEX_FL_STICKTABLE_METRIC },
321};
322
323/* stick table base description */
324const struct ist promex_sticktable_metric_desc[STICKTABLE_TOTAL_FIELDS] = {
325 [STICKTABLE_SIZE] = IST("Stick table size."),
326 [STICKTABLE_USED] = IST("Number of entries used in this stick table."),
327};
328
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100329/* Specific labels for all ST_F_HRSP_* fields */
330const struct ist promex_hrsp_code[1 + ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = {
331 [ST_F_HRSP_1XX - ST_F_HRSP_1XX] = IST("1xx"),
332 [ST_F_HRSP_2XX - ST_F_HRSP_1XX] = IST("2xx"),
333 [ST_F_HRSP_3XX - ST_F_HRSP_1XX] = IST("3xx"),
334 [ST_F_HRSP_4XX - ST_F_HRSP_1XX] = IST("4xx"),
335 [ST_F_HRSP_5XX - ST_F_HRSP_1XX] = IST("5xx"),
336 [ST_F_HRSP_OTHER - ST_F_HRSP_1XX] = IST("other"),
Christopher Fauletf959d082019-02-07 15:38:42 +0100337};
338
William Dauchy54938212021-01-27 22:40:16 +0100339enum promex_front_state {
340 PROMEX_FRONT_STATE_DOWN = 0,
341 PROMEX_FRONT_STATE_UP,
342
343 PROMEX_FRONT_STATE_COUNT /* must be last */
344};
345
346const struct ist promex_front_st[PROMEX_FRONT_STATE_COUNT] = {
347 [PROMEX_FRONT_STATE_DOWN] = IST("DOWN"),
348 [PROMEX_FRONT_STATE_UP] = IST("UP"),
349};
350
351enum promex_back_state {
352 PROMEX_BACK_STATE_DOWN = 0,
353 PROMEX_BACK_STATE_UP,
354
355 PROMEX_BACK_STATE_COUNT /* must be last */
356};
357
358const struct ist promex_back_st[PROMEX_BACK_STATE_COUNT] = {
359 [PROMEX_BACK_STATE_DOWN] = IST("DOWN"),
360 [PROMEX_BACK_STATE_UP] = IST("UP"),
361};
362
363enum promex_srv_state {
364 PROMEX_SRV_STATE_DOWN = 0,
365 PROMEX_SRV_STATE_UP,
366 PROMEX_SRV_STATE_MAINT,
367 PROMEX_SRV_STATE_DRAIN,
368 PROMEX_SRV_STATE_NOLB,
369
370 PROMEX_SRV_STATE_COUNT /* must be last */
371};
372
373const struct ist promex_srv_st[PROMEX_SRV_STATE_COUNT] = {
374 [PROMEX_SRV_STATE_DOWN] = IST("DOWN"),
375 [PROMEX_SRV_STATE_UP] = IST("UP"),
376 [PROMEX_SRV_STATE_MAINT] = IST("MAINT"),
377 [PROMEX_SRV_STATE_DRAIN] = IST("DRAIN"),
378 [PROMEX_SRV_STATE_NOLB] = IST("NOLB"),
379};
380
381/* Return the server status. */
382enum promex_srv_state promex_srv_status(struct server *sv)
Christopher Fauletf959d082019-02-07 15:38:42 +0100383{
William Dauchy54938212021-01-27 22:40:16 +0100384 int state = PROMEX_SRV_STATE_DOWN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100385
Christopher Fauletf959d082019-02-07 15:38:42 +0100386 if (sv->cur_state == SRV_ST_RUNNING || sv->cur_state == SRV_ST_STARTING) {
William Dauchy54938212021-01-27 22:40:16 +0100387 state = PROMEX_SRV_STATE_UP;
Christopher Fauletf959d082019-02-07 15:38:42 +0100388 if (sv->cur_admin & SRV_ADMF_DRAIN)
William Dauchy54938212021-01-27 22:40:16 +0100389 state = PROMEX_SRV_STATE_DRAIN;
Christopher Fauletf959d082019-02-07 15:38:42 +0100390 }
Christopher Fauletd45d1052019-09-06 16:10:19 +0200391 else if (sv->cur_state == SRV_ST_STOPPING)
William Dauchy54938212021-01-27 22:40:16 +0100392 state = PROMEX_SRV_STATE_NOLB;
Christopher Fauletd45d1052019-09-06 16:10:19 +0200393
394 if (sv->cur_admin & SRV_ADMF_MAINT)
William Dauchy54938212021-01-27 22:40:16 +0100395 state = PROMEX_SRV_STATE_MAINT;
Christopher Fauletf959d082019-02-07 15:38:42 +0100396
397 return state;
398}
399
400/* Convert a field to its string representation and write it in <out>, followed
401 * by a newline, if there is enough space. non-numeric value are converted in
William Dauchy18a2c6e2021-01-22 21:09:47 +0100402 * "NaN" because Prometheus only support numerical values (but it is unexepceted
Christopher Fauletf959d082019-02-07 15:38:42 +0100403 * to process this kind of value). It returns 1 on success. Otherwise, it
404 * returns 0. The buffer's length must not exceed <max> value.
405 */
406static int promex_metric_to_str(struct buffer *out, struct field *f, size_t max)
407{
408 int ret = 0;
409
410 switch (field_format(f, 0)) {
William Dauchy18a2c6e2021-01-22 21:09:47 +0100411 case FF_EMPTY: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100412 case FF_S32: ret = chunk_appendf(out, "%d\n", f->u.s32); break;
413 case FF_U32: ret = chunk_appendf(out, "%u\n", f->u.u32); break;
414 case FF_S64: ret = chunk_appendf(out, "%lld\n", (long long)f->u.s64); break;
415 case FF_U64: ret = chunk_appendf(out, "%llu\n", (unsigned long long)f->u.u64); break;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200416 case FF_FLT: ret = chunk_appendf(out, "%f\n", f->u.flt); break;
William Dauchy18a2c6e2021-01-22 21:09:47 +0100417 case FF_STR: ret = chunk_strcat(out, "NaN\n"); break;
418 default: ret = chunk_strcat(out, "NaN\n"); break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100419 }
420 if (!ret || out->data > max)
421 return 0;
422 return 1;
423}
424
Christopher Fauletf959d082019-02-07 15:38:42 +0100425/* Dump the header lines for <metric>. It is its #HELP and #TYPE strings. It
426 * returns 1 on success. Otherwise, if <out> length exceeds <max>, it returns 0.
427 */
428static int promex_dump_metric_header(struct appctx *appctx, struct htx *htx,
Christopher Faulet37286a52021-01-20 15:20:53 +0100429 const struct promex_metric *metric, const struct ist name,
430 struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100431{
Christopher Faulet37286a52021-01-20 15:20:53 +0100432 struct ist type;
William Dauchy82b2ce22021-02-01 13:11:55 +0100433 struct ist desc;
Christopher Faulet37286a52021-01-20 15:20:53 +0100434
435 switch (metric->type) {
436 case PROMEX_MT_COUNTER:
437 type = ist("counter");
438 break;
439 default:
440 type = ist("gauge");
441 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100442
William Dauchya191b772021-01-15 22:41:39 +0100443 if (istcat(out, ist("# HELP "), max) == -1 ||
444 istcat(out, name, max) == -1 ||
445 istcat(out, ist(" "), max) == -1)
446 goto full;
447
William Dauchy82b2ce22021-02-01 13:11:55 +0100448 if (metric->flags & PROMEX_FL_INFO_METRIC)
449 desc = ist(info_fields[appctx->st2].desc);
William Dauchy69164222021-02-07 20:42:38 +0100450 else if (metric->flags & PROMEX_FL_STICKTABLE_METRIC)
451 desc = promex_sticktable_metric_desc[appctx->st2];
William Dauchy82b2ce22021-02-01 13:11:55 +0100452 else if (!isttest(promex_st_metric_desc[appctx->st2]))
453 desc = ist(stat_fields[appctx->st2].desc);
454 else
455 desc = promex_st_metric_desc[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100456
William Dauchy82b2ce22021-02-01 13:11:55 +0100457 if (istcat(out, desc, max) == -1 ||
458 istcat(out, ist("\n# TYPE "), max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100459 istcat(out, name, max) == -1 ||
460 istcat(out, ist(" "), max) == -1 ||
Christopher Faulet37286a52021-01-20 15:20:53 +0100461 istcat(out, type, max) == -1 ||
Christopher Fauletf959d082019-02-07 15:38:42 +0100462 istcat(out, ist("\n"), max) == -1)
463 goto full;
464
465 return 1;
466
467 full:
468 return 0;
469}
470
471/* Dump the line for <metric>. It starts by the metric name followed by its
472 * labels (proxy name, server name...) between braces and finally its value. If
473 * not already done, the header lines are dumped first. It returns 1 on
474 * success. Otherwise if <out> length exceeds <max>, it returns 0.
475 */
Christopher Faulet37286a52021-01-20 15:20:53 +0100476static int promex_dump_metric(struct appctx *appctx, struct htx *htx, struct ist prefix,
William Dauchyc6464592021-01-27 22:40:17 +0100477 const struct promex_metric *metric, struct field *val,
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100478 struct promex_label *labels, struct ist *out, size_t max)
Christopher Fauletf959d082019-02-07 15:38:42 +0100479{
480 struct ist name = { .ptr = (char[PROMEX_MAX_NAME_LEN]){ 0 }, .len = 0 };
481 size_t len = out->len;
482
483 if (out->len + PROMEX_MAX_METRIC_LENGTH > max)
484 return 0;
485
Christopher Faulet37286a52021-01-20 15:20:53 +0100486 /* Fill the metric name */
487 istcat(&name, prefix, PROMEX_MAX_NAME_LEN);
488 istcat(&name, metric->n, PROMEX_MAX_NAME_LEN);
489
490
Christopher Fauletf959d082019-02-07 15:38:42 +0100491 if ((appctx->ctx.stats.flags & PROMEX_FL_METRIC_HDR) &&
Christopher Faulet37286a52021-01-20 15:20:53 +0100492 !promex_dump_metric_header(appctx, htx, metric, name, out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100493 goto full;
494
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100495 if (istcat(out, name, max) == -1)
496 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100497
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100498 if (isttest(labels[0].name)) {
499 int i;
500
501 if (istcat(out, ist("{"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100502 goto full;
Christopher Fauletf959d082019-02-07 15:38:42 +0100503
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100504 for (i = 0; isttest(labels[i].name); i++) {
505 if (!isttest(labels[i].value))
506 continue;
507
508 if ((i && istcat(out, ist(","), max) == -1) ||
509 istcat(out, labels[i].name, max) == -1 ||
510 istcat(out, ist("=\""), max) == -1 ||
511 istcat(out, labels[i].value, max) == -1 ||
512 istcat(out, ist("\""), max) == -1)
513 goto full;
514 }
515
516 if (istcat(out, ist("}"), max) == -1)
Christopher Fauletf959d082019-02-07 15:38:42 +0100517 goto full;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100518
Christopher Fauletf959d082019-02-07 15:38:42 +0100519 }
520
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100521 if (istcat(out, ist(" "), max) == -1)
522 goto full;
523
Christopher Fauletf959d082019-02-07 15:38:42 +0100524 trash.data = out->len;
Christopher Faulet37286a52021-01-20 15:20:53 +0100525 if (!promex_metric_to_str(&trash, val, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100526 goto full;
527 out->len = trash.data;
528
529 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
530 return 1;
531 full:
532 // Restore previous length
533 out->len = len;
534 return 0;
535
536}
537
538
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500539/* Dump global metrics (prefixed by "haproxy_process_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100540 * 0 if <htx> is full and -1 in case of any error. */
541static int promex_dump_global_metrics(struct appctx *appctx, struct htx *htx)
542{
543 static struct ist prefix = IST("haproxy_process_");
Christopher Faulet37286a52021-01-20 15:20:53 +0100544 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100545 struct channel *chn = si_ic(appctx->owner);
546 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200547 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
Christopher Fauletf959d082019-02-07 15:38:42 +0100548 int ret = 1;
549
Willy Tarreau0b26b382021-05-08 07:43:53 +0200550 if (!stats_fill_info(info, INF_TOTAL_FIELDS, 0))
William Dauchy5d9b8f32021-01-11 20:07:49 +0100551 return -1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100552
Christopher Faulet37286a52021-01-20 15:20:53 +0100553 for (; appctx->st2 < INF_TOTAL_FIELDS; appctx->st2++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100554 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
555
Christopher Faulet37286a52021-01-20 15:20:53 +0100556 if (!(promex_global_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
557 continue;
558
Christopher Fauletf959d082019-02-07 15:38:42 +0100559 switch (appctx->st2) {
William Dauchy5a982a72021-01-08 13:18:06 +0100560 case INF_BUILD_INFO:
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100561 labels[0].name = ist("version");
562 labels[0].value = ist(HAPROXY_VERSION);
Christopher Faulet37286a52021-01-20 15:20:53 +0100563 val = mkf_u32(FN_GAUGE, 1);
William Dauchy5a982a72021-01-08 13:18:06 +0100564 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100565
566 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100567 val = info[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100568 }
569
William Dauchyc6464592021-01-27 22:40:17 +0100570 if (!promex_dump_metric(appctx, htx, prefix, &promex_global_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100571 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100572 goto full;
573
Christopher Fauletf959d082019-02-07 15:38:42 +0100574 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Christopher Fauletf959d082019-02-07 15:38:42 +0100575 }
576
577 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200578 if (out.len) {
579 if (!htx_add_data_atonce(htx, out))
580 return -1; /* Unexpected and unrecoverable error */
581 channel_add_input(chn, out.len);
582 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100583 return ret;
584 full:
585 ret = 0;
586 goto end;
587}
588
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500589/* Dump frontends metrics (prefixed by "haproxy_frontend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100590 * 0 if <htx> is full and -1 in case of any error. */
591static int promex_dump_front_metrics(struct appctx *appctx, struct htx *htx)
592{
593 static struct ist prefix = IST("haproxy_frontend_");
594 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100595 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100596 struct channel *chn = si_ic(appctx->owner);
597 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200598 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchyb9577452021-01-17 18:27:46 +0100599 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100600 int ret = 1;
William Dauchyc6464592021-01-27 22:40:17 +0100601 enum promex_front_state state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100602
Christopher Faulet37286a52021-01-20 15:20:53 +0100603 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
604 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
605 continue;
606
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200607 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100608 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
609
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200610 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100611
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100612 labels[0].name = ist("proxy");
613 labels[0].value = ist2(px->id, strlen(px->id));
614
Christopher Fauletf959d082019-02-07 15:38:42 +0100615 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200616 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_FE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100617 goto next_px;
618
William Dauchyb9577452021-01-17 18:27:46 +0100619 if (!stats_fill_fe_stats(px, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
620 return -1;
621
Christopher Fauletf959d082019-02-07 15:38:42 +0100622 switch (appctx->st2) {
623 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100624 state = !px->disabled;
Christopher Faulet040b1192021-02-01 15:05:21 +0100625 for (; appctx->ctx.stats.st_code < PROMEX_FRONT_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100626 labels[1].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100627 labels[1].value = promex_front_st[appctx->ctx.stats.st_code];
628 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
William Dauchyc6464592021-01-27 22:40:17 +0100629 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100630 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100631 goto full;
632 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100633 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100634 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100635 case ST_F_REQ_RATE_MAX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100636 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100637 case ST_F_INTERCEPTED:
Christopher Fauletf959d082019-02-07 15:38:42 +0100638 case ST_F_CACHE_LOOKUPS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100639 case ST_F_CACHE_HITS:
Christopher Fauletf959d082019-02-07 15:38:42 +0100640 case ST_F_COMP_IN:
Christopher Fauletf959d082019-02-07 15:38:42 +0100641 case ST_F_COMP_OUT:
Christopher Fauletf959d082019-02-07 15:38:42 +0100642 case ST_F_COMP_BYP:
William Dauchyb9577452021-01-17 18:27:46 +0100643 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100644 if (px->mode != PR_MODE_HTTP)
645 goto next_px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100646 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100647 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100648 case ST_F_HRSP_1XX:
William Dauchyb9577452021-01-17 18:27:46 +0100649 case ST_F_HRSP_2XX:
650 case ST_F_HRSP_3XX:
651 case ST_F_HRSP_4XX:
652 case ST_F_HRSP_5XX:
653 case ST_F_HRSP_OTHER:
Christopher Fauletf959d082019-02-07 15:38:42 +0100654 if (px->mode != PR_MODE_HTTP)
655 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100656 if (appctx->st2 != ST_F_HRSP_1XX)
657 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100658 labels[1].name = ist("code");
659 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
660 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100661 break;
662
663 default:
Christopher Faulet37286a52021-01-20 15:20:53 +0100664 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100665 }
666
William Dauchyc6464592021-01-27 22:40:17 +0100667 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100668 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100669 goto full;
670 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200671 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100672 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100673 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200674 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100675 }
676
677 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200678 if (out.len) {
679 if (!htx_add_data_atonce(htx, out))
680 return -1; /* Unexpected and unrecoverable error */
681 channel_add_input(chn, out.len);
682 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100683 return ret;
684 full:
685 ret = 0;
686 goto end;
687}
688
William Dauchye3f7bd52021-02-14 23:22:56 +0100689/* Dump listener metrics (prefixed by "haproxy_listen_"). It returns 1 on
690 * success, 0 if <htx> is full and -1 in case of any error. */
691static int promex_dump_listener_metrics(struct appctx *appctx, struct htx *htx)
692{
693 static struct ist prefix = IST("haproxy_listener_");
694 struct proxy *px;
695 struct field val;
696 struct channel *chn = si_ic(appctx->owner);
697 struct ist out = ist2(trash.area, 0);
698 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
699 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
700 struct listener *li;
701 int ret = 1;
702 enum li_status status;
703
704 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
705 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
706 continue;
707
708 while (appctx->ctx.stats.obj1) {
709 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
710
711 px = appctx->ctx.stats.obj1;
712
713 labels[0].name = ist("proxy");
714 labels[0].value = ist2(px->id, strlen(px->id));
715
716 /* skip the disabled proxies, global frontend and non-networked ones */
717 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_FE))
718 goto next_px;
719
720 li = appctx->ctx.stats.obj2;
721 list_for_each_entry_from(li, &px->conf.listeners, by_fe) {
722
William Dauchye3f7bd52021-02-14 23:22:56 +0100723 if (!li->counters)
724 continue;
725
William Dauchybaf22732021-02-25 00:53:13 +0100726 labels[1].name = ist("listener");
727 labels[1].value = ist2(li->name, strlen(li->name));
728
William Dauchye3f7bd52021-02-14 23:22:56 +0100729 if (!stats_fill_li_stats(px, li, 0, stats,
730 ST_F_TOTAL_FIELDS, &(appctx->st2)))
731 return -1;
732
733 switch (appctx->st2) {
734 case ST_F_STATUS:
735 status = get_li_status(li);
736 for (; appctx->ctx.stats.st_code < LI_STATE_COUNT; appctx->ctx.stats.st_code++) {
737 val = mkf_u32(FO_STATUS, status == appctx->ctx.stats.st_code);
738 labels[2].name = ist("state");
739 labels[2].value = ist(li_status_st[appctx->ctx.stats.st_code]);
740 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
741 &val, labels, &out, max))
742 goto full;
743 }
744 appctx->ctx.stats.st_code = 0;
745 continue;
746 default:
747 val = stats[appctx->st2];
748 }
749
750 if (!promex_dump_metric(appctx, htx, prefix,
751 &promex_st_metrics[appctx->st2],
752 &val, labels, &out, max))
753 goto full;
754 }
755
756 next_px:
757 px = px->next;
758 appctx->ctx.stats.obj1 = px;
759 appctx->ctx.stats.obj2 = (px ? LIST_NEXT(&px->conf.listeners, struct listener *, by_fe) : NULL);
760 }
761 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
762 appctx->ctx.stats.obj1 = proxies_list;
763 appctx->ctx.stats.obj2 = LIST_NEXT(&proxies_list->conf.listeners, struct listener *, by_fe);
764 }
765
766 end:
767 if (out.len) {
768 if (!htx_add_data_atonce(htx, out))
769 return -1; /* Unexpected and unrecoverable error */
770 channel_add_input(chn, out.len);
771 }
772 return ret;
773 full:
774 appctx->ctx.stats.obj2 = li;
775 ret = 0;
776 goto end;
777}
778
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500779/* Dump backends metrics (prefixed by "haproxy_backend_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100780 * 0 if <htx> is full and -1 in case of any error. */
781static int promex_dump_back_metrics(struct appctx *appctx, struct htx *htx)
782{
783 static struct ist prefix = IST("haproxy_backend_");
784 struct proxy *px;
Christopher Faulet37286a52021-01-20 15:20:53 +0100785 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100786 struct channel *chn = si_ic(appctx->owner);
787 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200788 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchy3c6f0062021-01-25 17:29:02 +0100789 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100790 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200791 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100792 enum promex_back_state state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100793
Christopher Faulet37286a52021-01-20 15:20:53 +0100794 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
795 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
796 continue;
797
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200798 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100799 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
800
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200801 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100802
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100803 labels[0].name = ist("proxy");
804 labels[0].value = ist2(px->id, strlen(px->id));
805
Christopher Fauletf959d082019-02-07 15:38:42 +0100806 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200807 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100808 goto next_px;
809
William Dauchy3c6f0062021-01-25 17:29:02 +0100810 if (!stats_fill_be_stats(px, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
811 return -1;
812
Christopher Fauletf959d082019-02-07 15:38:42 +0100813 switch (appctx->st2) {
814 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100815 state = ((px->lbprm.tot_weight > 0 || !px->srv) ? 1 : 0);
Christopher Faulet040b1192021-02-01 15:05:21 +0100816 for (; appctx->ctx.stats.st_code < PROMEX_BACK_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100817 labels[1].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100818 labels[1].value = promex_back_st[appctx->ctx.stats.st_code];
819 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
William Dauchyc6464592021-01-27 22:40:17 +0100820 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100821 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100822 goto full;
823 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100824 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100825 goto next_px;
Christopher Fauletf959d082019-02-07 15:38:42 +0100826 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200827 secs = (double)swrate_avg(px->be_counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100828 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100829 break;
830 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200831 secs = (double)swrate_avg(px->be_counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100832 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100833 break;
834 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200835 secs = (double)swrate_avg(px->be_counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100836 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100837 break;
838 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200839 secs = (double)swrate_avg(px->be_counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100840 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100841 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100842 case ST_F_QT_MAX:
843 secs = (double)px->be_counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100844 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100845 break;
846 case ST_F_CT_MAX:
847 secs = (double)px->be_counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100848 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100849 break;
850 case ST_F_RT_MAX:
851 secs = (double)px->be_counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100852 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100853 break;
854 case ST_F_TT_MAX:
855 secs = (double)px->be_counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100856 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100857 break;
Christopher Fauletf959d082019-02-07 15:38:42 +0100858 case ST_F_REQ_TOT:
William Dauchy3c6f0062021-01-25 17:29:02 +0100859 case ST_F_CACHE_LOOKUPS:
860 case ST_F_CACHE_HITS:
861 case ST_F_COMP_IN:
862 case ST_F_COMP_OUT:
863 case ST_F_COMP_BYP:
864 case ST_F_COMP_RSP:
Christopher Fauletf959d082019-02-07 15:38:42 +0100865 if (px->mode != PR_MODE_HTTP)
866 goto next_px;
William Dauchy3c6f0062021-01-25 17:29:02 +0100867 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100868 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100869 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100870 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100871 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100872 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100873 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +0100874 case ST_F_HRSP_OTHER:
875 if (px->mode != PR_MODE_HTTP)
876 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +0100877 if (appctx->st2 != ST_F_HRSP_1XX)
878 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100879 labels[1].name = ist("code");
880 labels[1].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchy3c6f0062021-01-25 17:29:02 +0100881 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100882 break;
883
884 default:
William Dauchy3c6f0062021-01-25 17:29:02 +0100885 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +0100886 }
887
William Dauchy3c6f0062021-01-25 17:29:02 +0100888 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100889 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +0100890 goto full;
891 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200892 appctx->ctx.stats.obj1 = px->next;
Christopher Fauletf959d082019-02-07 15:38:42 +0100893 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100894 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200895 appctx->ctx.stats.obj1 = proxies_list;
Christopher Fauletf959d082019-02-07 15:38:42 +0100896 }
897
898 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +0200899 if (out.len) {
900 if (!htx_add_data_atonce(htx, out))
901 return -1; /* Unexpected and unrecoverable error */
902 channel_add_input(chn, out.len);
903 }
Christopher Fauletf959d082019-02-07 15:38:42 +0100904 return ret;
905 full:
906 ret = 0;
907 goto end;
908}
909
Ilya Shipitsince7b00f2020-03-23 22:28:40 +0500910/* Dump servers metrics (prefixed by "haproxy_server_"). It returns 1 on success,
Christopher Fauletf959d082019-02-07 15:38:42 +0100911 * 0 if <htx> is full and -1 in case of any error. */
912static int promex_dump_srv_metrics(struct appctx *appctx, struct htx *htx)
913{
914 static struct ist prefix = IST("haproxy_server_");
915 struct proxy *px;
916 struct server *sv;
Christopher Faulet37286a52021-01-20 15:20:53 +0100917 struct field val;
Christopher Fauletf959d082019-02-07 15:38:42 +0100918 struct channel *chn = si_ic(appctx->owner);
919 struct ist out = ist2(trash.area, 0);
Christopher Faulet11921e62019-07-03 11:43:17 +0200920 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
William Dauchybde2bf62021-01-25 17:29:04 +0100921 struct field *stats = stat_l[STATS_DOMAIN_PROXY];
Christopher Fauletf959d082019-02-07 15:38:42 +0100922 int ret = 1;
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200923 double secs;
William Dauchyc6464592021-01-27 22:40:17 +0100924 enum promex_srv_state state;
William Dauchyde3c3262021-02-01 13:11:51 +0100925 const char *check_state;
Christopher Fauletf959d082019-02-07 15:38:42 +0100926
Christopher Faulet37286a52021-01-20 15:20:53 +0100927 for (;appctx->st2 < ST_F_TOTAL_FIELDS; appctx->st2++) {
928 if (!(promex_st_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
929 continue;
930
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200931 while (appctx->ctx.stats.obj1) {
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100932 struct promex_label labels[PROMEX_MAX_LABELS-1] = {};
933
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200934 px = appctx->ctx.stats.obj1;
Christopher Fauletf959d082019-02-07 15:38:42 +0100935
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100936 labels[0].name = ist("proxy");
937 labels[0].value = ist2(px->id, strlen(px->id));
938
Christopher Fauletf959d082019-02-07 15:38:42 +0100939 /* skip the disabled proxies, global frontend and non-networked ones */
Willy Tarreauc3914d42020-09-24 08:39:22 +0200940 if (px->disabled || px->uuid <= 0 || !(px->cap & PR_CAP_BE))
Christopher Fauletf959d082019-02-07 15:38:42 +0100941 goto next_px;
942
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +0200943 while (appctx->ctx.stats.obj2) {
944 sv = appctx->ctx.stats.obj2;
Christopher Fauletf959d082019-02-07 15:38:42 +0100945
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100946 labels[1].name = ist("server");
947 labels[1].value = ist2(sv->id, strlen(sv->id));
948
William Dauchybde2bf62021-01-25 17:29:04 +0100949 if (!stats_fill_sv_stats(px, sv, 0, stats, ST_F_TOTAL_FIELDS, &(appctx->st2)))
950 return -1;
951
Christopher Fauleteba22942019-11-19 14:18:24 +0100952 if ((appctx->ctx.stats.flags & PROMEX_FL_NO_MAINT_SRV) && (sv->cur_admin & SRV_ADMF_MAINT))
953 goto next_sv;
954
Christopher Fauletf959d082019-02-07 15:38:42 +0100955 switch (appctx->st2) {
956 case ST_F_STATUS:
William Dauchyc6464592021-01-27 22:40:17 +0100957 state = promex_srv_status(sv);
William Dauchy64a38052021-02-14 22:26:24 +0100958 for (; appctx->ctx.stats.st_code < PROMEX_SRV_STATE_COUNT; appctx->ctx.stats.st_code++) {
Christopher Faulet040b1192021-02-01 15:05:21 +0100959 val = mkf_u32(FO_STATUS, state == appctx->ctx.stats.st_code);
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100960 labels[2].name = ist("state");
Christopher Faulet040b1192021-02-01 15:05:21 +0100961 labels[2].value = promex_srv_st[appctx->ctx.stats.st_code];
William Dauchyc6464592021-01-27 22:40:17 +0100962 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +0100963 &val, labels, &out, max))
William Dauchyc6464592021-01-27 22:40:17 +0100964 goto full;
965 }
Christopher Faulet040b1192021-02-01 15:05:21 +0100966 appctx->ctx.stats.st_code = 0;
William Dauchyc6464592021-01-27 22:40:17 +0100967 goto next_sv;
Christopher Fauletf959d082019-02-07 15:38:42 +0100968 case ST_F_QTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200969 secs = (double)swrate_avg(sv->counters.q_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100970 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100971 break;
972 case ST_F_CTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200973 secs = (double)swrate_avg(sv->counters.c_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100974 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100975 break;
976 case ST_F_RTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200977 secs = (double)swrate_avg(sv->counters.d_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100978 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100979 break;
980 case ST_F_TTIME:
Christopher Fauletaf4bf142019-09-24 16:35:19 +0200981 secs = (double)swrate_avg(sv->counters.t_time, TIME_STATS_SAMPLES) / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100982 val = mkf_flt(FN_AVG, secs);
Christopher Fauletf959d082019-02-07 15:38:42 +0100983 break;
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100984 case ST_F_QT_MAX:
985 secs = (double)sv->counters.qtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100986 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100987 break;
988 case ST_F_CT_MAX:
989 secs = (double)sv->counters.ctime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100990 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100991 break;
992 case ST_F_RT_MAX:
993 secs = (double)sv->counters.dtime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100994 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100995 break;
996 case ST_F_TT_MAX:
997 secs = (double)sv->counters.ttime_max / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +0100998 val = mkf_flt(FN_MAX, secs);
Christopher Faulet8fc027d2019-11-08 15:05:31 +0100999 break;
Christopher Fauletcf403f32019-11-21 14:35:46 +01001000 case ST_F_CHECK_STATUS:
1001 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
1002 goto next_sv;
William Dauchyde3c3262021-02-01 13:11:51 +01001003
Christopher Faulet040b1192021-02-01 15:05:21 +01001004 for (; appctx->ctx.stats.st_code < HCHK_STATUS_SIZE; appctx->ctx.stats.st_code++) {
1005 if (get_check_status_result(appctx->ctx.stats.st_code) < CHK_RES_FAILED)
William Dauchyde3c3262021-02-01 13:11:51 +01001006 continue;
Christopher Faulet040b1192021-02-01 15:05:21 +01001007 val = mkf_u32(FO_STATUS, sv->check.status == appctx->ctx.stats.st_code);
1008 check_state = get_check_status_info(appctx->ctx.stats.st_code);
William Dauchyde3c3262021-02-01 13:11:51 +01001009 labels[2].name = ist("state");
Tim Duesterhusb113b5c2021-09-15 13:58:44 +02001010 labels[2].value = ist(check_state);
William Dauchyde3c3262021-02-01 13:11:51 +01001011 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
1012 &val, labels, &out, max))
1013 goto full;
1014 }
Christopher Faulet040b1192021-02-01 15:05:21 +01001015 appctx->ctx.stats.st_code = 0;
William Dauchyde3c3262021-02-01 13:11:51 +01001016 goto next_sv;
Christopher Fauletcf403f32019-11-21 14:35:46 +01001017 case ST_F_CHECK_CODE:
1018 if ((sv->check.state & (CHK_ST_ENABLED|CHK_ST_PAUSED)) != CHK_ST_ENABLED)
1019 goto next_sv;
Christopher Faulet37286a52021-01-20 15:20:53 +01001020 val = mkf_u32(FN_OUTPUT, (sv->check.status < HCHK_STATUS_L57DATA) ? 0 : sv->check.code);
Christopher Fauletcf403f32019-11-21 14:35:46 +01001021 break;
Christopher Faulet2711e512020-02-27 16:12:07 +01001022 case ST_F_CHECK_DURATION:
1023 if (sv->check.status < HCHK_STATUS_CHECKED)
1024 goto next_sv;
1025 secs = (double)sv->check.duration / 1000.0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001026 val = mkf_flt(FN_DURATION, secs);
Christopher Faulet2711e512020-02-27 16:12:07 +01001027 break;
Marcin Deranek3c27dda2020-05-15 18:32:51 +02001028 case ST_F_REQ_TOT:
Christopher Fauletf959d082019-02-07 15:38:42 +01001029 if (px->mode != PR_MODE_HTTP)
1030 goto next_px;
William Dauchybde2bf62021-01-25 17:29:04 +01001031 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +01001032 break;
Christopher Faulet32ef48e2021-02-01 14:55:37 +01001033 case ST_F_HRSP_1XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001034 case ST_F_HRSP_2XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001035 case ST_F_HRSP_3XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001036 case ST_F_HRSP_4XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001037 case ST_F_HRSP_5XX:
Christopher Fauletf959d082019-02-07 15:38:42 +01001038 case ST_F_HRSP_OTHER:
1039 if (px->mode != PR_MODE_HTTP)
1040 goto next_px;
Christopher Faulet32ef48e2021-02-01 14:55:37 +01001041 if (appctx->st2 != ST_F_HRSP_1XX)
1042 appctx->ctx.stats.flags &= ~PROMEX_FL_METRIC_HDR;
Christopher Faulet5a2f9382021-01-28 11:24:17 +01001043 labels[2].name = ist("code");
1044 labels[2].value = promex_hrsp_code[appctx->st2 - ST_F_HRSP_1XX];
William Dauchybde2bf62021-01-25 17:29:04 +01001045 val = stats[appctx->st2];
Christopher Fauletc55a6262020-07-10 15:39:39 +02001046 break;
Christopher Fauletf959d082019-02-07 15:38:42 +01001047
1048 default:
William Dauchybde2bf62021-01-25 17:29:04 +01001049 val = stats[appctx->st2];
Christopher Fauletf959d082019-02-07 15:38:42 +01001050 }
1051
William Dauchyc6464592021-01-27 22:40:17 +01001052 if (!promex_dump_metric(appctx, htx, prefix, &promex_st_metrics[appctx->st2],
Christopher Faulet5a2f9382021-01-28 11:24:17 +01001053 &val, labels, &out, max))
Christopher Fauletf959d082019-02-07 15:38:42 +01001054 goto full;
Christopher Fauleteba22942019-11-19 14:18:24 +01001055 next_sv:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001056 appctx->ctx.stats.obj2 = sv->next;
Christopher Fauletf959d082019-02-07 15:38:42 +01001057 }
1058
1059 next_px:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001060 appctx->ctx.stats.obj1 = px->next;
1061 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +01001062 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001063 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001064 appctx->ctx.stats.obj1 = proxies_list;
1065 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletf959d082019-02-07 15:38:42 +01001066 }
1067
1068
1069 end:
Christopher Faulet0c55a152019-07-04 10:03:28 +02001070 if (out.len) {
1071 if (!htx_add_data_atonce(htx, out))
1072 return -1; /* Unexpected and unrecoverable error */
1073 channel_add_input(chn, out.len);
1074 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001075 return ret;
1076 full:
1077 ret = 0;
1078 goto end;
1079}
1080
William Dauchy69164222021-02-07 20:42:38 +01001081/* Dump stick table metrics (prefixed by "haproxy_sticktable_"). It returns 1 on success,
1082 * 0 if <htx> is full and -1 in case of any error. */
1083static int promex_dump_sticktable_metrics(struct appctx *appctx, struct htx *htx)
1084{
1085 static struct ist prefix = IST("haproxy_sticktable_");
1086 struct field val;
1087 struct channel *chn = si_ic(appctx->owner);
1088 struct ist out = ist2(trash.area, 0);
1089 size_t max = htx_get_max_blksz(htx, channel_htx_recv_max(chn, htx));
1090 int ret = 1;
1091 struct stktable *t;
1092
1093 for (; appctx->st2 < STICKTABLE_TOTAL_FIELDS; appctx->st2++) {
1094 if (!(promex_sticktable_metrics[appctx->st2].flags & appctx->ctx.stats.flags))
1095 continue;
1096
1097 while (appctx->ctx.stats.obj1) {
1098 struct promex_label labels[PROMEX_MAX_LABELS - 1] = {};
1099
1100 t = appctx->ctx.stats.obj1;
1101 if (!t->size)
1102 goto next_px;
1103
1104 labels[0].name = ist("name");
1105 labels[0].value = ist2(t->id, strlen(t->id));
1106 labels[1].name = ist("type");
1107 labels[1].value = ist2(stktable_types[t->type].kw, strlen(stktable_types[t->type].kw));
1108 switch (appctx->st2) {
1109 case STICKTABLE_SIZE:
1110 val = mkf_u32(FN_GAUGE, t->size);
1111 break;
1112 case STICKTABLE_USED:
1113 val = mkf_u32(FN_GAUGE, t->current);
1114 break;
1115 default:
1116 goto next_px;
1117 }
1118
1119 if (!promex_dump_metric(appctx, htx, prefix,
1120 &promex_sticktable_metrics[appctx->st2],
1121 &val, labels, &out, max))
1122 goto full;
1123
1124 next_px:
1125 appctx->ctx.stats.obj1 = t->next;
1126 }
1127 appctx->ctx.stats.flags |= PROMEX_FL_METRIC_HDR;
1128 appctx->ctx.stats.obj1 = stktables_list;
1129 }
1130
1131 end:
1132 if (out.len) {
1133 if (!htx_add_data_atonce(htx, out))
1134 return -1; /* Unexpected and unrecoverable error */
1135 channel_add_input(chn, out.len);
1136 }
1137 return ret;
1138 full:
1139 ret = 0;
1140 goto end;
1141}
1142
Christopher Fauletf959d082019-02-07 15:38:42 +01001143/* Dump all metrics (global, frontends, backends and servers) depending on the
1144 * dumper state (appctx->st1). It returns 1 on success, 0 if <htx> is full and
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001145 * -1 in case of any error.
1146 * Uses <appctx.ctx.stats.obj1> as a pointer to the current proxy and <obj2> as
1147 * a pointer to the current server/listener. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001148static int promex_dump_metrics(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1149{
1150 int ret;
1151
1152 switch (appctx->st1) {
1153 case PROMEX_DUMPER_INIT:
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001154 appctx->ctx.stats.obj1 = NULL;
1155 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001156 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_INFO_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001157 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001158 appctx->st2 = INF_NAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001159 appctx->st1 = PROMEX_DUMPER_GLOBAL;
1160 /* fall through */
1161
1162 case PROMEX_DUMPER_GLOBAL:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001163 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_GLOBAL) {
1164 ret = promex_dump_global_metrics(appctx, htx);
1165 if (ret <= 0) {
1166 if (ret == -1)
1167 goto error;
1168 goto full;
1169 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001170 }
1171
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001172 appctx->ctx.stats.obj1 = proxies_list;
1173 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletefde9552020-06-05 08:18:56 +02001174 appctx->ctx.stats.flags &= ~PROMEX_FL_INFO_METRIC;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001175 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_FRONT_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001176 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001177 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001178 appctx->st1 = PROMEX_DUMPER_FRONT;
1179 /* fall through */
1180
1181 case PROMEX_DUMPER_FRONT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001182 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_FRONT) {
1183 ret = promex_dump_front_metrics(appctx, htx);
1184 if (ret <= 0) {
1185 if (ret == -1)
1186 goto error;
1187 goto full;
1188 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001189 }
1190
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001191 appctx->ctx.stats.obj1 = proxies_list;
William Dauchye3f7bd52021-02-14 23:22:56 +01001192 appctx->ctx.stats.obj2 = LIST_NEXT(&proxies_list->conf.listeners, struct listener *, by_fe);
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001193 appctx->ctx.stats.flags &= ~PROMEX_FL_FRONT_METRIC;
William Dauchye3f7bd52021-02-14 23:22:56 +01001194 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_LI_METRIC);
1195 appctx->ctx.stats.st_code = 0;
1196 appctx->st2 = ST_F_PXNAME;
1197 appctx->st1 = PROMEX_DUMPER_LI;
1198 /* fall through */
1199
1200 case PROMEX_DUMPER_LI:
1201 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_LI) {
1202 ret = promex_dump_listener_metrics(appctx, htx);
1203 if (ret <= 0) {
1204 if (ret == -1)
1205 goto error;
1206 goto full;
1207 }
1208 }
1209
1210 appctx->ctx.stats.obj1 = proxies_list;
1211 appctx->ctx.stats.obj2 = NULL;
1212 appctx->ctx.stats.flags &= ~PROMEX_FL_LI_METRIC;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001213 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_BACK_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001214 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001215 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001216 appctx->st1 = PROMEX_DUMPER_BACK;
1217 /* fall through */
1218
1219 case PROMEX_DUMPER_BACK:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001220 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_BACK) {
1221 ret = promex_dump_back_metrics(appctx, htx);
1222 if (ret <= 0) {
1223 if (ret == -1)
1224 goto error;
1225 goto full;
1226 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001227 }
1228
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001229 appctx->ctx.stats.obj1 = proxies_list;
1230 appctx->ctx.stats.obj2 = (appctx->ctx.stats.obj1 ? ((struct proxy *)appctx->ctx.stats.obj1)->srv : NULL);
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001231 appctx->ctx.stats.flags &= ~PROMEX_FL_BACK_METRIC;
1232 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
Christopher Faulet040b1192021-02-01 15:05:21 +01001233 appctx->ctx.stats.st_code = 0;
Christopher Faulet37286a52021-01-20 15:20:53 +01001234 appctx->st2 = ST_F_PXNAME;
Christopher Fauletf959d082019-02-07 15:38:42 +01001235 appctx->st1 = PROMEX_DUMPER_SRV;
1236 /* fall through */
1237
1238 case PROMEX_DUMPER_SRV:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001239 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_SERVER) {
1240 ret = promex_dump_srv_metrics(appctx, htx);
1241 if (ret <= 0) {
1242 if (ret == -1)
1243 goto error;
1244 goto full;
1245 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001246 }
1247
William Dauchy69164222021-02-07 20:42:38 +01001248 appctx->ctx.stats.obj1 = stktables_list;
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001249 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletb713c4f2021-01-20 15:02:50 +01001250 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_SRV_METRIC);
William Dauchy69164222021-02-07 20:42:38 +01001251 appctx->ctx.stats.flags |= (PROMEX_FL_METRIC_HDR|PROMEX_FL_STICKTABLE_METRIC);
1252 appctx->st2 = STICKTABLE_SIZE;
1253 appctx->st1 = PROMEX_DUMPER_STICKTABLE;
1254 /* fall through */
1255
1256 case PROMEX_DUMPER_STICKTABLE:
1257 if (appctx->ctx.stats.flags & PROMEX_FL_SCOPE_STICKTABLE) {
1258 ret = promex_dump_sticktable_metrics(appctx, htx);
1259 if (ret <= 0) {
1260 if (ret == -1)
1261 goto error;
1262 goto full;
1263 }
1264 }
1265
1266 appctx->ctx.stats.obj1 = NULL;
1267 appctx->ctx.stats.obj2 = NULL;
1268 appctx->ctx.stats.flags &= ~(PROMEX_FL_METRIC_HDR|PROMEX_FL_STICKTABLE_METRIC);
Christopher Fauletf959d082019-02-07 15:38:42 +01001269 appctx->st2 = 0;
1270 appctx->st1 = PROMEX_DUMPER_DONE;
1271 /* fall through */
1272
1273 case PROMEX_DUMPER_DONE:
1274 default:
1275 break;
1276 }
1277
1278 return 1;
1279
1280 full:
1281 si_rx_room_blk(si);
1282 return 0;
1283 error:
1284 /* unrecoverable error */
Amaury Denoyelleda5b6d12020-10-02 18:32:02 +02001285 appctx->ctx.stats.obj1 = NULL;
1286 appctx->ctx.stats.obj2 = NULL;
Christopher Fauletf959d082019-02-07 15:38:42 +01001287 appctx->ctx.stats.flags = 0;
1288 appctx->st2 = 0;
1289 appctx->st1 = PROMEX_DUMPER_DONE;
1290 return -1;
1291}
1292
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001293/* Parse the query string of request URI to filter the metrics. It returns 1 on
Christopher Faulet78407ce2019-11-18 14:47:08 +01001294 * success and -1 on error. */
1295static int promex_parse_uri(struct appctx *appctx, struct stream_interface *si)
1296{
1297 struct channel *req = si_oc(si);
1298 struct channel *res = si_ic(si);
1299 struct htx *req_htx, *res_htx;
1300 struct htx_sl *sl;
William Dauchyc65f6562019-11-26 12:56:26 +01001301 char *p, *key, *value;
1302 const char *end;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001303 struct buffer *err;
1304 int default_scopes = PROMEX_FL_SCOPE_ALL;
1305 int len;
1306
1307 /* Get the query-string */
1308 req_htx = htxbuf(&req->buf);
1309 sl = http_get_stline(req_htx);
1310 if (!sl)
1311 goto error;
1312 p = http_find_param_list(HTX_SL_REQ_UPTR(sl), HTX_SL_REQ_ULEN(sl), '?');
1313 if (!p)
1314 goto end;
1315 end = HTX_SL_REQ_UPTR(sl) + HTX_SL_REQ_ULEN(sl);
Christopher Faulet78407ce2019-11-18 14:47:08 +01001316
William Dauchyc65f6562019-11-26 12:56:26 +01001317 /* copy the query-string */
1318 len = end - p;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001319 chunk_reset(&trash);
1320 memcpy(trash.area, p, len);
1321 trash.area[len] = 0;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001322 p = trash.area;
William Dauchyc65f6562019-11-26 12:56:26 +01001323 end = trash.area + len;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001324
1325 /* Parse the query-string */
William Dauchyc65f6562019-11-26 12:56:26 +01001326 while (p < end && *p && *p != '#') {
1327 value = NULL;
1328
1329 /* decode parameter name */
1330 key = p;
1331 while (p < end && *p != '=' && *p != '&' && *p != '#')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001332 ++p;
William Dauchyc65f6562019-11-26 12:56:26 +01001333 /* found a value */
1334 if (*p == '=') {
1335 *(p++) = 0;
1336 value = p;
1337 }
1338 else if (*p == '&')
1339 *(p++) = 0;
1340 else if (*p == '#')
1341 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001342 len = url_decode(key, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001343 if (len == -1)
1344 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001345
William Dauchyc65f6562019-11-26 12:56:26 +01001346 /* decode value */
1347 if (value) {
1348 while (p < end && *p != '=' && *p != '&' && *p != '#')
1349 ++p;
1350 if (*p == '=')
1351 goto error;
1352 if (*p == '&')
1353 *(p++) = 0;
1354 else if (*p == '#')
1355 *p = 0;
Willy Tarreau62ba9ba2020-04-23 17:54:47 +02001356 len = url_decode(value, 1);
William Dauchyc65f6562019-11-26 12:56:26 +01001357 if (len == -1)
1358 goto error;
1359 }
1360
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001361 if (strcmp(key, "scope") == 0) {
William Dauchyc65f6562019-11-26 12:56:26 +01001362 default_scopes = 0; /* at least a scope defined, unset default scopes */
1363 if (!value)
1364 goto error;
1365 else if (*value == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001366 appctx->ctx.stats.flags &= ~PROMEX_FL_SCOPE_ALL;
William Dauchyc65f6562019-11-26 12:56:26 +01001367 else if (*value == '*')
Christopher Faulet78407ce2019-11-18 14:47:08 +01001368 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_ALL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001369 else if (strcmp(value, "global") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001370 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_GLOBAL;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001371 else if (strcmp(value, "server") == 0)
William Dauchyc65f6562019-11-26 12:56:26 +01001372 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_SERVER;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001373 else if (strcmp(value, "backend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001374 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_BACK;
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001375 else if (strcmp(value, "frontend") == 0)
Christopher Faulet78407ce2019-11-18 14:47:08 +01001376 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_FRONT;
William Dauchye3f7bd52021-02-14 23:22:56 +01001377 else if (strcmp(value, "listener") == 0)
1378 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_LI;
William Dauchy69164222021-02-07 20:42:38 +01001379 else if (strcmp(value, "sticktable") == 0)
1380 appctx->ctx.stats.flags |= PROMEX_FL_SCOPE_STICKTABLE;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001381 else
1382 goto error;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001383 }
Tim Duesterhus8cb12a82021-01-02 22:31:55 +01001384 else if (strcmp(key, "no-maint") == 0)
Christopher Fauleteba22942019-11-19 14:18:24 +01001385 appctx->ctx.stats.flags |= PROMEX_FL_NO_MAINT_SRV;
Christopher Faulet78407ce2019-11-18 14:47:08 +01001386 }
1387
1388 end:
1389 appctx->ctx.stats.flags |= default_scopes;
1390 return 1;
1391
1392 error:
1393 err = &http_err_chunks[HTTP_ERR_400];
1394 channel_erase(res);
1395 res->buf.data = b_data(err);
1396 memcpy(res->buf.area, b_head(err), b_data(err));
1397 res_htx = htx_from_buf(&res->buf);
1398 channel_add_input(res, res_htx->data);
1399 appctx->st0 = PROMEX_ST_END;
1400 return -1;
1401}
1402
Christopher Fauletf959d082019-02-07 15:38:42 +01001403/* Send HTTP headers of the response. It returns 1 on success and 0 if <htx> is
1404 * full. */
1405static int promex_send_headers(struct appctx *appctx, struct stream_interface *si, struct htx *htx)
1406{
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001407 struct channel *chn = si_ic(appctx->owner);
Christopher Fauletf959d082019-02-07 15:38:42 +01001408 struct htx_sl *sl;
1409 unsigned int flags;
1410
1411 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);
1412 sl = htx_add_stline(htx, HTX_BLK_RES_SL, flags, ist("HTTP/1.1"), ist("200"), ist("OK"));
1413 if (!sl)
1414 goto full;
1415 sl->info.res.status = 200;
1416 if (!htx_add_header(htx, ist("Cache-Control"), ist("no-cache")) ||
Christopher Fauletf959d082019-02-07 15:38:42 +01001417 !htx_add_header(htx, ist("Content-Type"), ist("text/plain; version=0.0.4")) ||
1418 !htx_add_header(htx, ist("Transfer-Encoding"), ist("chunked")) ||
1419 !htx_add_endof(htx, HTX_BLK_EOH))
1420 goto full;
1421
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001422 channel_add_input(chn, htx->data);
Christopher Fauletf959d082019-02-07 15:38:42 +01001423 return 1;
1424 full:
1425 htx_reset(htx);
1426 si_rx_room_blk(si);
1427 return 0;
1428}
1429
1430/* The function returns 1 if the initialisation is complete, 0 if
1431 * an errors occurs and -1 if more data are required for initializing
1432 * the applet.
1433 */
1434static int promex_appctx_init(struct appctx *appctx, struct proxy *px, struct stream *strm)
1435{
1436 appctx->st0 = PROMEX_ST_INIT;
1437 return 1;
1438}
1439
1440/* The main I/O handler for the promex applet. */
1441static void promex_appctx_handle_io(struct appctx *appctx)
1442{
1443 struct stream_interface *si = appctx->owner;
1444 struct stream *s = si_strm(si);
1445 struct channel *req = si_oc(si);
1446 struct channel *res = si_ic(si);
1447 struct htx *req_htx, *res_htx;
1448 int ret;
1449
1450 res_htx = htx_from_buf(&res->buf);
Christopher Fauletf959d082019-02-07 15:38:42 +01001451 if (unlikely(si->state == SI_ST_DIS || si->state == SI_ST_CLO))
1452 goto out;
1453
Ilya Shipitsince7b00f2020-03-23 22:28:40 +05001454 /* Check if the input buffer is available. */
Christopher Fauletf959d082019-02-07 15:38:42 +01001455 if (!b_size(&res->buf)) {
1456 si_rx_room_blk(si);
1457 goto out;
1458 }
1459
1460 switch (appctx->st0) {
1461 case PROMEX_ST_INIT:
Christopher Faulet78407ce2019-11-18 14:47:08 +01001462 ret = promex_parse_uri(appctx, si);
1463 if (ret <= 0) {
1464 if (ret == -1)
1465 goto error;
1466 goto out;
1467 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001468 appctx->st0 = PROMEX_ST_HEAD;
1469 appctx->st1 = PROMEX_DUMPER_INIT;
1470 /* fall through */
1471
1472 case PROMEX_ST_HEAD:
1473 if (!promex_send_headers(appctx, si, res_htx))
1474 goto out;
1475 appctx->st0 = ((s->txn->meth == HTTP_METH_HEAD) ? PROMEX_ST_DONE : PROMEX_ST_DUMP);
1476 /* fall through */
1477
1478 case PROMEX_ST_DUMP:
1479 ret = promex_dump_metrics(appctx, si, res_htx);
1480 if (ret <= 0) {
1481 if (ret == -1)
1482 goto error;
1483 goto out;
1484 }
1485 appctx->st0 = PROMEX_ST_DONE;
1486 /* fall through */
1487
1488 case PROMEX_ST_DONE:
Christopher Fauletd1ac2b92020-12-02 19:12:22 +01001489 /* no more data are expected. Don't add TLR because mux-h1 will take care of it */
1490 res_htx->flags |= HTX_FL_EOM;
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001491 appctx->st0 = PROMEX_ST_END;
1492 /* fall through */
Christopher Fauletf959d082019-02-07 15:38:42 +01001493
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001494 case PROMEX_ST_END:
1495 if (!(res->flags & CF_SHUTR)) {
1496 res->flags |= CF_READ_NULL;
1497 si_shutr(si);
1498 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001499 }
1500
Christopher Fauletf959d082019-02-07 15:38:42 +01001501 out:
1502 htx_to_buf(res_htx, &res->buf);
Christopher Faulet9744f7c2019-03-27 15:48:53 +01001503
1504 /* eat the whole request */
1505 if (co_data(req)) {
1506 req_htx = htx_from_buf(&req->buf);
1507 co_htx_skip(req, req_htx, co_data(req));
1508 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001509 return;
1510
1511 error:
1512 res->flags |= CF_READ_NULL;
1513 si_shutr(si);
1514 si_shutw(si);
1515}
1516
1517struct applet promex_applet = {
1518 .obj_type = OBJ_TYPE_APPLET,
1519 .name = "<PROMEX>", /* used for logging */
1520 .init = promex_appctx_init,
1521 .fct = promex_appctx_handle_io,
1522};
1523
1524static enum act_parse_ret service_parse_prometheus_exporter(const char **args, int *cur_arg, struct proxy *px,
1525 struct act_rule *rule, char **err)
1526{
1527 /* Prometheus exporter service is only available on "http-request" rulesets */
1528 if (rule->from != ACT_F_HTTP_REQ) {
1529 memprintf(err, "Prometheus exporter service only available on 'http-request' rulesets");
1530 return ACT_RET_PRS_ERR;
1531 }
Christopher Fauletf959d082019-02-07 15:38:42 +01001532
1533 /* Add applet pointer in the rule. */
1534 rule->applet = promex_applet;
1535
1536 return ACT_RET_PRS_OK;
1537}
1538static void promex_register_build_options(void)
1539{
1540 char *ptr = NULL;
1541
1542 memprintf(&ptr, "Built with the Prometheus exporter as a service");
1543 hap_register_build_opts(ptr, 1);
1544}
1545
1546
1547static struct action_kw_list service_actions = { ILH, {
1548 { "prometheus-exporter", service_parse_prometheus_exporter },
1549 { /* END */ }
1550}};
1551
1552INITCALL1(STG_REGISTER, service_keywords_register, &service_actions);
1553INITCALL0(STG_REGISTER, promex_register_build_options);