MINOR: stats: update ambiguous "metrics" naming to "stat_cols"

The name "metrics" was chosen to represent the various list of haproxy
exposed statistics. However, it is deemed as ambiguous as some stats are
indeed metric in the true sense, but some are not, as highlighted by
various "enum field_origin" values.

Replace it by the new name "stat_cols" for statistic columns. Along with
the already existing notion of stat lines it should better reflect its
purpose.

diff --git a/addons/promex/service-prometheus.c b/addons/promex/service-prometheus.c
index 4e20b761b5a666cf2aabf0cba81a331dc32a9c91..82427e2dce4e62a2033de587203bd21379363559 100644 (file)
--- a/addons/promex/service-prometheus.c
+++ b/addons/promex/service-prometheus.c
@@ -579,7 +579,7 @@ static int promex_dump_global_metrics(struct appctx *appctx, struct htx *htx)
                        continue;
 
                name = promex_global_metrics[ctx->field_num].n;
-               desc = ist(metrics_info[ctx->field_num].desc);
+               desc = ist(stat_cols_info[ctx->field_num].desc);
 
                if (promex_filter_metric(appctx, prefix, name))
                        continue;
@@ -641,7 +641,7 @@ static int promex_dump_front_metrics(struct appctx *appctx, struct htx *htx)
                if (!isttest(name))
                        name = promex_st_metrics[ctx->field_num].n;
                if (!isttest(desc))
-                       desc = ist(metrics_px[ctx->field_num].desc);
+                       desc = ist(stat_cols_px[ctx->field_num].desc);
 
                if (promex_filter_metric(appctx, prefix, name))
                        continue;
@@ -828,7 +828,7 @@ static int promex_dump_listener_metrics(struct appctx *appctx, struct htx *htx)
                if (!isttest(name))
                        name = promex_st_metrics[ctx->field_num].n;
                if (!isttest(desc))
-                       desc = ist(metrics_px[ctx->field_num].desc);
+                       desc = ist(stat_cols_px[ctx->field_num].desc);
 
                if (promex_filter_metric(appctx, prefix, name))
                        continue;
@@ -1016,7 +1016,7 @@ static int promex_dump_back_metrics(struct appctx *appctx, struct htx *htx)
                if (!isttest(name))
                        name = promex_st_metrics[ctx->field_num].n;
                if (!isttest(desc))
-                       desc = ist(metrics_px[ctx->field_num].desc);
+                       desc = ist(stat_cols_px[ctx->field_num].desc);
 
                if (promex_filter_metric(appctx, prefix, name))
                        continue;
@@ -1282,7 +1282,7 @@ static int promex_dump_srv_metrics(struct appctx *appctx, struct htx *htx)
                if (!isttest(name))
                        name = promex_st_metrics[ctx->field_num].n;
                if (!isttest(desc))
-                       desc = ist(metrics_px[ctx->field_num].desc);
+                       desc = ist(stat_cols_px[ctx->field_num].desc);
 
                if (promex_filter_metric(appctx, prefix, name))
                        continue;

diff --git a/include/haproxy/stats.h b/include/haproxy/stats.h
index 902dd83e682b407a1a04c356c6a0bb358ebe8a43..4f08ad1bd4896a13ef255165b0d9ed9aedf08001 100644 (file)
--- a/include/haproxy/stats.h
+++ b/include/haproxy/stats.h
@@ -38,14 +38,14 @@ struct stconn;
 /* These two structs contains all column names and descriptions according to
  * the the number of entries in "enum stat_idx_px" and "enum stat_idx_info"
  */
-extern const struct name_desc metrics_px[];
-extern const struct name_desc metrics_info[];
+extern const struct name_desc stat_cols_px[];
+extern const struct name_desc stat_cols_info[];
 extern const char *stat_status_codes[];
 extern struct applet http_stats_applet;
 extern struct list stats_module_list[];
 extern THREAD_LOCAL struct field stat_line_info[];
 extern THREAD_LOCAL struct field *stat_lines[];
-extern struct name_desc *metrics[STATS_DOMAIN_COUNT];
+extern struct name_desc *stat_cols[STATS_DOMAIN_COUNT];
 
 struct htx;
 int stats_putchk(struct appctx *appctx, struct buffer *buf, struct htx *htx);

diff --git a/src/hlua_fcn.c b/src/hlua_fcn.c
index 8e18f722cca26384c17ada8201044405d5510e0a..52db1af5ec787837e485d0a3129a3df1a319f657 100644 (file)
--- a/src/hlua_fcn.c
+++ b/src/hlua_fcn.c
@@ -378,7 +378,7 @@ static int hlua_get_info(lua_State *L)
 
        lua_newtable(L);
        for (i=0; i<ST_I_INF_MAX; i++) {
-               lua_pushstring(L, metrics_info[i].name);
+               lua_pushstring(L, stat_cols_info[i].name);
                hlua_fcn_pushfield(L, &stats[i]);
                lua_settable(L, -3);
        }
@@ -1163,7 +1163,7 @@ int hlua_listener_get_stats(lua_State *L)
 
        lua_newtable(L);
        for (i=0; i<ST_I_PX_MAX; i++) {
-               lua_pushstring(L, metrics_px[i].name);
+               lua_pushstring(L, stat_cols_px[i].name);
                hlua_fcn_pushfield(L, &stats[i]);
                lua_settable(L, -3);
        }
@@ -1209,7 +1209,7 @@ int hlua_server_get_stats(lua_State *L)
 
        lua_newtable(L);
        for (i=0; i<ST_I_PX_MAX; i++) {
-               lua_pushstring(L, metrics_px[i].name);
+               lua_pushstring(L, stat_cols_px[i].name);
                hlua_fcn_pushfield(L, &stats[i]);
                lua_settable(L, -3);
        }
@@ -2057,7 +2057,7 @@ int hlua_proxy_get_stats(lua_State *L)
                stats_fill_fe_line(px, stats, STATS_LEN, NULL);
        lua_newtable(L);
        for (i=0; i<ST_I_PX_MAX; i++) {
-               lua_pushstring(L, metrics_px[i].name);
+               lua_pushstring(L, stat_cols_px[i].name);
                hlua_fcn_pushfield(L, &stats[i]);
                lua_settable(L, -3);
        }

diff --git a/src/stats-json.c b/src/stats-json.c
index b10bde449497eb198051e8a25d780a2c7ae5efa6..b493853866fcfdc3edd7193a1de6c80b576f3c13 100644 (file)
--- a/src/stats-json.c
+++ b/src/stats-json.c
@@ -189,7 +189,7 @@ int stats_dump_fields_json(struct buffer *out,
                old_len = out->data;
                if (domain == STATS_DOMAIN_PROXY) {
                        stats_print_proxy_field_json(out, &line[i],
-                                                    metrics[domain][i].name,
+                                                    stat_cols[domain][i].name,
                                                     i,
                                                     line[ST_I_PX_TYPE].u.u32,
                                                     line[ST_I_PX_IID].u.u32,
@@ -197,7 +197,7 @@ int stats_dump_fields_json(struct buffer *out,
                                                     line[ST_I_PX_PID].u.u32);
                } else if (domain == STATS_DOMAIN_RESOLVERS) {
                        stats_print_rslv_field_json(out, &line[i],
-                                                   metrics[domain][i].name,
+                                                   stat_cols[domain][i].name,
                                                    i);
                }
 
@@ -269,7 +269,7 @@ int stats_dump_json_info_fields(struct buffer *out,
                chunk_appendf(out,
                              "{\"field\":{\"pos\":%d,\"name\":\"%s\"},"
                              "\"processNum\":%u,",
-                             i, metrics_info[i].name,
+                             i, stat_cols_info[i].name,
                              info[ST_I_INF_PROCESS_NUM].u.u32);
                if (old_len == out->data)
                        goto err;

diff --git a/src/stats.c b/src/stats.c
index 488792cbbd13785e9f410e24122811143b483270..2502b9e09fa3d830214665da0a8a1e61b3fec406 100644 (file)
--- a/src/stats.c
+++ b/src/stats.c
@@ -81,11 +81,11 @@ const char *stat_status_codes[STAT_STATUS_SIZE] = {
        [STAT_STATUS_IVAL] = "IVAL",
 };
 
-/* These are the metric names for each ST_I_INF_* field position. Please pay attention
+/* These are the column names for each ST_I_INF_* field position. Please pay attention
  * to always use the exact same name except that the strings for new names must
  * be lower case or CamelCase while the enum entries must be upper case.
  */
-const struct name_desc metrics_info[ST_I_INF_MAX] = {
+const struct name_desc stat_cols_info[ST_I_INF_MAX] = {
        [ST_I_INF_NAME]                           = { .name = "Name",                        .desc = "Product name" },
        [ST_I_INF_VERSION]                        = { .name = "Version",                     .desc = "Product version" },
        [ST_I_INF_RELEASE_DATE]                   = { .name = "Release_date",                .desc = "Date of latest source code update" },
@@ -167,7 +167,7 @@ const struct name_desc metrics_info[ST_I_INF_MAX] = {
 /* one line of info */
 THREAD_LOCAL struct field stat_line_info[ST_I_INF_MAX];
 
-const struct name_desc metrics_px[ST_I_PX_MAX] = {
+const struct name_desc stat_cols_px[ST_I_PX_MAX] = {
        [ST_I_PX_PXNAME]                        = { .name = "pxname",                      .desc = "Proxy name" },
        [ST_I_PX_SVNAME]                        = { .name = "svname",                      .desc = "Server name" },
        [ST_I_PX_QCUR]                          = { .name = "qcur",                        .desc = "Number of current queued connections" },
@@ -286,11 +286,11 @@ const struct name_desc metrics_px[ST_I_PX_MAX] = {
 /* one line for stats */
 THREAD_LOCAL struct field *stat_lines[STATS_DOMAIN_COUNT];
 
-/* Unified storage for metrics from all stats module
+/* Unified storage for statistics from all module
  * TODO merge info stats into it as global statistic domain.
  */
-struct name_desc *metrics[STATS_DOMAIN_COUNT];
-static size_t metrics_len[STATS_DOMAIN_COUNT];
+struct name_desc *stat_cols[STATS_DOMAIN_COUNT];
+static size_t stat_cols_len[STATS_DOMAIN_COUNT];
 
 /* list of all registered stats module */
 struct list stats_module_list[STATS_DOMAIN_COUNT] = {
@@ -402,9 +402,9 @@ static void stats_dump_csv_header(enum stats_domain domain, struct buffer *out)
        int i;
 
        chunk_appendf(out, "# ");
-       if (metrics[domain]) {
-               for (i = 0; i < metrics_len[domain]; ++i) {
-                       chunk_appendf(out, "%s,", metrics[domain][i].name);
+       if (stat_cols[domain]) {
+               for (i = 0; i < stat_cols_len[domain]; ++i) {
+                       chunk_appendf(out, "%s,", stat_cols[domain][i].name);
 
                        /* print special delimiter on proxy stats to mark end of
                           static fields */
@@ -553,13 +553,13 @@ static int stats_dump_fields_typed(struct buffer *out,
                                      '?',
                                      line[ST_I_PX_IID].u.u32, line[ST_I_PX_SID].u.u32,
                                      i,
-                                     metrics[domain][i].name,
+                                     stat_cols[domain][i].name,
                                      line[ST_I_PX_PID].u.u32);
                        break;
 
                case STATS_DOMAIN_RESOLVERS:
                        chunk_appendf(out, "N.%d.%s:", i,
-                                     metrics[domain][i].name);
+                                     stat_cols[domain][i].name);
                        break;
 
                default:
@@ -572,7 +572,7 @@ static int stats_dump_fields_typed(struct buffer *out,
                        return 0;
 
                if (flags & STAT_F_SHOW_FDESC &&
-                   !chunk_appendf(out, ":\"%s\"", metrics[domain][i].desc)) {
+                   !chunk_appendf(out, ":\"%s\"", stat_cols[domain][i].desc)) {
                        return 0;
                }
 
@@ -844,7 +844,7 @@ static int stats_dump_fe_line(struct stconn *sc, struct proxy *px)
        if ((ctx->flags & STAT_F_BOUND) && !(ctx->type & (1 << STATS_TYPE_FE)))
                return 0;
 
-       memset(line, 0, sizeof(struct field) * metrics_len[STATS_DOMAIN_PROXY]);
+       memset(line, 0, sizeof(struct field) * stat_cols_len[STATS_DOMAIN_PROXY]);
 
        if (!stats_fill_fe_line(px, line, ST_I_PX_MAX, NULL))
                return 0;
@@ -1014,7 +1014,7 @@ static int stats_dump_li_line(struct stconn *sc, struct proxy *px, struct listen
        struct stats_module *mod;
        size_t stats_count = ST_I_PX_MAX;
 
-       memset(line, 0, sizeof(struct field) * metrics_len[STATS_DOMAIN_PROXY]);
+       memset(line, 0, sizeof(struct field) * stat_cols_len[STATS_DOMAIN_PROXY]);
 
        if (!stats_fill_li_line(px, l, ctx->flags, line,
                                ST_I_PX_MAX, NULL))
@@ -1530,7 +1530,7 @@ static int stats_dump_sv_line(struct stconn *sc, struct proxy *px, struct server
        struct field *line = stat_lines[STATS_DOMAIN_PROXY];
        size_t stats_count = ST_I_PX_MAX;
 
-       memset(line, 0, sizeof(struct field) * metrics_len[STATS_DOMAIN_PROXY]);
+       memset(line, 0, sizeof(struct field) * stat_cols_len[STATS_DOMAIN_PROXY]);
 
        if (!stats_fill_sv_line(px, sv, ctx->flags, line,
                                ST_I_PX_MAX, NULL))
@@ -1867,7 +1867,7 @@ static int stats_dump_be_line(struct stconn *sc, struct proxy *px)
        if ((ctx->flags & STAT_F_BOUND) && !(ctx->type & (1 << STATS_TYPE_BE)))
                return 0;
 
-       memset(line, 0, sizeof(struct field) * metrics_len[STATS_DOMAIN_PROXY]);
+       memset(line, 0, sizeof(struct field) * stat_cols_len[STATS_DOMAIN_PROXY]);
 
        if (!stats_fill_be_line(px, ctx->flags, line, ST_I_PX_MAX, NULL))
                return 0;
@@ -2230,7 +2230,7 @@ int stats_dump_stat_to_buffer(struct stconn *sc, struct buffer *buf, struct htx
                switch (domain) {
                case STATS_DOMAIN_RESOLVERS:
                        if (!stats_dump_resolvers(sc, stat_lines[domain],
-                                                 metrics_len[domain],
+                                                 stat_cols_len[domain],
                                                  &stats_module_list[domain])) {
                                return 0;
                        }
@@ -2286,11 +2286,11 @@ static int stats_dump_info_fields(struct buffer *out,
                if (!field_format(line, i))
                        continue;
 
-               if (!chunk_appendf(out, "%s: ", metrics_info[i].name))
+               if (!chunk_appendf(out, "%s: ", stat_cols_info[i].name))
                        return 0;
                if (!stats_emit_raw_data_field(out, &line[i]))
                        return 0;
-               if ((flags & STAT_F_SHOW_FDESC) && !chunk_appendf(out, ":\"%s\"", metrics_info[i].desc))
+               if ((flags & STAT_F_SHOW_FDESC) && !chunk_appendf(out, ":\"%s\"", stat_cols_info[i].desc))
                        return 0;
                if (!chunk_strcat(out, "\n"))
                        return 0;
@@ -2310,7 +2310,7 @@ static int stats_dump_typed_info_fields(struct buffer *out,
                if (!field_format(line, i))
                        continue;
 
-               if (!chunk_appendf(out, "%d.%s.%u:", i, metrics_info[i].name,
+               if (!chunk_appendf(out, "%d.%s.%u:", i, stat_cols_info[i].name,
                                   line[ST_I_INF_PROCESS_NUM].u.u32)) {
                        return 0;
                }
@@ -2318,7 +2318,7 @@ static int stats_dump_typed_info_fields(struct buffer *out,
                        return 0;
                if (!stats_emit_typed_data_field(out, &line[i]))
                        return 0;
-               if ((flags & STAT_F_SHOW_FDESC) && !chunk_appendf(out, ":\"%s\"", metrics_info[i].desc))
+               if ((flags & STAT_F_SHOW_FDESC) && !chunk_appendf(out, ":\"%s\"", stat_cols_info[i].desc))
                        return 0;
                if (!chunk_strcat(out, "\n"))
                        return 0;
@@ -2816,7 +2816,7 @@ void stats_register_module(struct stats_module *m)
        const uint8_t domain = stats_get_domain(m->domain_flags);
 
        LIST_APPEND(&stats_module_list[domain], &m->list);
-       metrics_len[domain] += m->stats_count;
+       stat_cols_len[domain] += m->stats_count;
 }
 
 
@@ -2827,20 +2827,20 @@ static int allocate_stats_px_postcheck(void)
        int err_code = 0;
        struct proxy *px;
 
-       metrics_len[STATS_DOMAIN_PROXY] += ST_I_PX_MAX;
+       stat_cols_len[STATS_DOMAIN_PROXY] += ST_I_PX_MAX;
 
-       metrics[STATS_DOMAIN_PROXY] = malloc(metrics_len[STATS_DOMAIN_PROXY] * sizeof(struct name_desc));
-       if (!metrics[STATS_DOMAIN_PROXY]) {
+       stat_cols[STATS_DOMAIN_PROXY] = malloc(stat_cols_len[STATS_DOMAIN_PROXY] * sizeof(struct name_desc));
+       if (!stat_cols[STATS_DOMAIN_PROXY]) {
                ha_alert("stats: cannot allocate all fields for proxy statistics\n");
                err_code |= ERR_ALERT | ERR_FATAL;
                return err_code;
        }
 
-       memcpy(metrics[STATS_DOMAIN_PROXY], metrics_px,
+       memcpy(stat_cols[STATS_DOMAIN_PROXY], stat_cols_px,
               ST_I_PX_MAX * sizeof(struct name_desc));
 
        list_for_each_entry(mod, &stats_module_list[STATS_DOMAIN_PROXY], list) {
-               memcpy(metrics[STATS_DOMAIN_PROXY] + i,
+               memcpy(stat_cols[STATS_DOMAIN_PROXY] + i,
                       mod->stats,
                       mod->stats_count * sizeof(struct name_desc));
                i += mod->stats_count;
@@ -2867,15 +2867,15 @@ static int allocate_stats_rslv_postcheck(void)
        size_t i = 0;
        int err_code = 0;
 
-       metrics[STATS_DOMAIN_RESOLVERS] = malloc(metrics_len[STATS_DOMAIN_RESOLVERS] * sizeof(struct name_desc));
-       if (!metrics[STATS_DOMAIN_RESOLVERS]) {
+       stat_cols[STATS_DOMAIN_RESOLVERS] = malloc(stat_cols_len[STATS_DOMAIN_RESOLVERS] * sizeof(struct name_desc));
+       if (!stat_cols[STATS_DOMAIN_RESOLVERS]) {
                ha_alert("stats: cannot allocate all fields for resolver statistics\n");
                err_code |= ERR_ALERT | ERR_FATAL;
                return err_code;
        }
 
        list_for_each_entry(mod, &stats_module_list[STATS_DOMAIN_RESOLVERS], list) {
-               memcpy(metrics[STATS_DOMAIN_RESOLVERS] + i,
+               memcpy(stat_cols[STATS_DOMAIN_RESOLVERS] + i,
                       mod->stats,
                       mod->stats_count * sizeof(struct name_desc));
                i += mod->stats_count;
@@ -2901,7 +2901,7 @@ static int allocate_stat_lines_per_thread(void)
        for (i = 0; i < STATS_DOMAIN_COUNT; ++i) {
                const int domain = domains[i];
 
-               stat_lines[domain] = malloc(metrics_len[domain] * sizeof(struct field));
+               stat_lines[domain] = malloc(stat_cols_len[domain] * sizeof(struct field));
                if (!stat_lines[domain])
                        return 0;
        }
@@ -2959,8 +2959,8 @@ static void deinit_stats(void)
        for (i = 0; i < STATS_DOMAIN_COUNT; ++i) {
                const int domain = domains[i];
 
-               if (metrics[domain])
-                       free(metrics[domain]);
+               if (stat_cols[domain])
+                       free(stat_cols[domain]);
        }
 }