<p>Friendly Automation <strong>merged</strong> this change.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/11374">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Matt Jordan: Looks good to me, approved
Friendly Automation: Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">res_prometheus: Add Asterisk bridge metrics<br><br>This patch adds basic Asterisk bridge statistics to the res_prometheus<br>module. This includes:<br><br>* asterisk_bridges_count: The current number of bridges active on the<br> system.<br><br>* asterisk_bridges_channels_count: The number of channels active in a<br> bridge.<br><br>In all cases, enough information is provided with each bridge metric<br>to determine a unique instance of Asterisk that provided the data, along<br>with the technology, subclass, and creator of the bridge.<br><br>ASTERISK-28403<br><br>Change-Id: Ie27417dd72c5bc7624eb2a7a6a8829d7551788dc<br>---<br>A res/prometheus/bridges.c<br>M res/prometheus/endpoints.c<br>M res/prometheus/prometheus_internal.h<br>M res/res_prometheus.c<br>4 files changed, 197 insertions(+), 3 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/res/prometheus/bridges.c b/res/prometheus/bridges.c</span><br><span>new file mode 100644</span><br><span>index 0000000..81e51d4</span><br><span>--- /dev/null</span><br><span>+++ b/res/prometheus/bridges.c</span><br><span>@@ -0,0 +1,182 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Asterisk -- An open source telephony toolkit.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Copyright (C) 2019 Sangoma, Inc.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Matt Jordan <mjordan@digium.com></span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * See http://www.asterisk.org for more information about</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Asterisk project. Please do not directly contact</span><br><span style="color: hsl(120, 100%, 40%);">+ * any of the maintainers of this project for assistance;</span><br><span style="color: hsl(120, 100%, 40%);">+ * the project provides a web site, mailing lists and IRC</span><br><span style="color: hsl(120, 100%, 40%);">+ * channels for your use.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software, distributed under the terms of</span><br><span style="color: hsl(120, 100%, 40%);">+ * the GNU General Public License Version 2. See the LICENSE file</span><br><span style="color: hsl(120, 100%, 40%);">+ * at the top of the source tree.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \file</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Prometheus Bridge Metrics</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \author Matt Jordan <mjordan@digium.com></span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include "asterisk.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include "asterisk/stasis_bridges.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "asterisk/res_prometheus.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "prometheus_internal.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define BRIDGES_CHANNELS_COUNT_HELP "Number of channels in the bridge."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Callback function to get the number of channels in a bridge</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param metric The metric to populate</span><br><span style="color: hsl(120, 100%, 40%);">+ * \snapshot Bridge snapshot</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static void get_bridge_channel_count(struct prometheus_metric *metric, struct ast_bridge_snapshot *snapshot)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ snprintf(metric->value, sizeof(metric->value), "%d", snapshot->num_channels);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Helper struct for generating individual bridge stats</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+struct bridge_metric_defs {</span><br><span style="color: hsl(120, 100%, 40%);">+ /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Help text to display</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *help;</span><br><span style="color: hsl(120, 100%, 40%);">+ /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Name of the metric</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *name;</span><br><span style="color: hsl(120, 100%, 40%);">+ /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Callback function to generate a metric value for a given bridge</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+ void (* const get_value)(struct prometheus_metric *metric, struct ast_bridge_snapshot *snapshot);</span><br><span style="color: hsl(120, 100%, 40%);">+} bridge_metric_defs[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+ {</span><br><span style="color: hsl(120, 100%, 40%);">+ .help = BRIDGES_CHANNELS_COUNT_HELP,</span><br><span style="color: hsl(120, 100%, 40%);">+ .name = "asterisk_bridges_channels_count",</span><br><span style="color: hsl(120, 100%, 40%);">+ .get_value = get_bridge_channel_count,</span><br><span style="color: hsl(120, 100%, 40%);">+ },</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Callback invoked when Prometheus scrapes the server</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param response The response to populate with formatted metrics</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static void bridges_scrape_cb(struct ast_str **response)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ao2_container *bridges;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ao2_iterator it_bridges;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_bridge *bridge;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct prometheus_metric *bridge_metrics;</span><br><span style="color: hsl(120, 100%, 40%);">+ char eid_str[32];</span><br><span style="color: hsl(120, 100%, 40%);">+ int i, j, num_bridges;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct prometheus_metric bridge_count = PROMETHEUS_METRIC_STATIC_INITIALIZATION(</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_GAUGE,</span><br><span style="color: hsl(120, 100%, 40%);">+ "asterisk_bridges_count",</span><br><span style="color: hsl(120, 100%, 40%);">+ "Current bridge count.",</span><br><span style="color: hsl(120, 100%, 40%);">+ NULL</span><br><span style="color: hsl(120, 100%, 40%);">+ );</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_eid_to_str(eid_str, sizeof(eid_str), &ast_eid_default);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ bridges = ast_bridges();</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!bridges) {</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ num_bridges = ao2_container_count(bridges);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Current endpoint count */</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_SET_LABEL(&bridge_count, 0, "eid", eid_str);</span><br><span style="color: hsl(120, 100%, 40%);">+ snprintf(bridge_count.value, sizeof(bridge_count.value), "%d", num_bridges);</span><br><span style="color: hsl(120, 100%, 40%);">+ prometheus_metric_to_string(&bridge_count, response);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (num_bridges == 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_ref(bridges, -1);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ bridge_metrics = ast_calloc(ARRAY_LEN(bridge_metric_defs) * num_bridges, sizeof(*bridge_metrics));</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!bridge_metrics) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_ref(bridges, -1);</span><br><span style="color: hsl(120, 100%, 40%);">+ return;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* Bridge dependent values */</span><br><span style="color: hsl(120, 100%, 40%);">+ it_bridges = ao2_iterator_init(bridges, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+ for (i = 0; (bridge = ao2_iterator_next(&it_bridges)); ao2_ref(bridge, -1), i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_bridge_snapshot *snapshot = ast_bridge_get_snapshot(bridge);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ for (j = 0; j < ARRAY_LEN(bridge_metric_defs); j++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ int index = i * ARRAY_LEN(bridge_metric_defs) + j;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ bridge_metrics[index].type = PROMETHEUS_METRIC_GAUGE;</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_copy_string(bridge_metrics[index].name, bridge_metric_defs[j].name, sizeof(bridge_metrics[index].name));</span><br><span style="color: hsl(120, 100%, 40%);">+ bridge_metrics[index].help = bridge_metric_defs[j].help;</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_SET_LABEL(&bridge_metrics[index], 0, "eid", eid_str);</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_SET_LABEL(&bridge_metrics[index], 1, "id", (snapshot->uniqueid));</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_SET_LABEL(&bridge_metrics[index], 2, "tech", (snapshot->technology));</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_SET_LABEL(&bridge_metrics[index], 3, "subclass", (snapshot->subclass));</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_SET_LABEL(&bridge_metrics[index], 4, "creator", (snapshot->creator));</span><br><span style="color: hsl(120, 100%, 40%);">+ PROMETHEUS_METRIC_SET_LABEL(&bridge_metrics[index], 5, "name", (snapshot->name));</span><br><span style="color: hsl(120, 100%, 40%);">+ bridge_metric_defs[j].get_value(&bridge_metrics[index], snapshot);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (i > 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ AST_LIST_INSERT_TAIL(&bridge_metrics[j].children, &bridge_metrics[index], entry);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_ref(snapshot, -1);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_iterator_destroy(&it_bridges);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ for (j = 0; j < ARRAY_LEN(bridge_metric_defs); j++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ prometheus_metric_to_string(&bridge_metrics[j], response);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_free(bridge_metrics);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_ref(bridges, -1);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+struct prometheus_callback bridges_callback = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .name = "bridges callback",</span><br><span style="color: hsl(120, 100%, 40%);">+ .callback_fn = bridges_scrape_cb,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Callback invoked when the core module is unloaded</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static void bridge_metrics_unload_cb(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ prometheus_callback_unregister(&bridges_callback);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \internal</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Metrics provider definition</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static struct prometheus_metrics_provider provider = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .name = "bridges",</span><br><span style="color: hsl(120, 100%, 40%);">+ .unload_cb = bridge_metrics_unload_cb,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int bridge_metrics_init(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ prometheus_metrics_provider_register(&provider);</span><br><span style="color: hsl(120, 100%, 40%);">+ prometheus_callback_register(&bridges_callback);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return 0;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span>\ No newline at end of file</span><br><span>diff --git a/res/prometheus/endpoints.c b/res/prometheus/endpoints.c</span><br><span>index 37ddd81..e4c7e1d 100644</span><br><span>--- a/res/prometheus/endpoints.c</span><br><span>+++ b/res/prometheus/endpoints.c</span><br><span>@@ -136,8 +136,9 @@</span><br><span> /* Endpoint dependent values */</span><br><span> it_endpoints = ao2_iterator_init(endpoints, 0);</span><br><span> for (i = 0; (message = ao2_iterator_next(&it_endpoints)); ao2_ref(message, -1), i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_endpoint_snapshot *snapshot = stasis_message_data(message);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> for (j = 0; j < ARRAY_LEN(endpoint_metric_defs); j++) {</span><br><span style="color: hsl(0, 100%, 40%);">- struct ast_endpoint_snapshot *snapshot = stasis_message_data(message);</span><br><span> int index = i * ARRAY_LEN(endpoint_metric_defs) + j;</span><br><span> </span><br><span> endpoint_metrics[index].type = PROMETHEUS_METRIC_GAUGE;</span><br><span>@@ -153,8 +154,9 @@</span><br><span> AST_LIST_INSERT_TAIL(&endpoint_metrics[j].children, &endpoint_metrics[index], entry);</span><br><span> }</span><br><span> }</span><br><span style="color: hsl(0, 100%, 40%);">- ao2_iterator_destroy(&it_endpoints);</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_ref(snapshot, -1);</span><br><span> }</span><br><span style="color: hsl(120, 100%, 40%);">+ ao2_iterator_destroy(&it_endpoints);</span><br><span> </span><br><span> for (j = 0; j < ARRAY_LEN(endpoint_metric_defs); j++) {</span><br><span> prometheus_metric_to_string(&endpoint_metrics[j], response);</span><br><span>diff --git a/res/prometheus/prometheus_internal.h b/res/prometheus/prometheus_internal.h</span><br><span>index 7eb4457..5ee96aa 100644</span><br><span>--- a/res/prometheus/prometheus_internal.h</span><br><span>+++ b/res/prometheus/prometheus_internal.h</span><br><span>@@ -46,4 +46,12 @@</span><br><span> */</span><br><span> int endpoint_metrics_init(void);</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Initialize bridge metrics</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval 0 success</span><br><span style="color: hsl(120, 100%, 40%);">+ * \retval -1 error</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+int bridge_metrics_init(void);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> #endif /* #define PROMETHEUS_INTERNAL_H__ */</span><br><span>diff --git a/res/res_prometheus.c b/res/res_prometheus.c</span><br><span>index 41f449d..8a61ad9 100644</span><br><span>--- a/res/res_prometheus.c</span><br><span>+++ b/res/res_prometheus.c</span><br><span>@@ -917,7 +917,9 @@</span><br><span> goto cleanup;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- if (channel_metrics_init() || endpoint_metrics_init()) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (channel_metrics_init()</span><br><span style="color: hsl(120, 100%, 40%);">+ || endpoint_metrics_init()</span><br><span style="color: hsl(120, 100%, 40%);">+ || bridge_metrics_init()) {</span><br><span> goto cleanup;</span><br><span> }</span><br><span> </span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/11374">change 11374</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/11374"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ie27417dd72c5bc7624eb2a7a6a8829d7551788dc </div>
<div style="display:none"> Gerrit-Change-Number: 11374 </div>
<div style="display:none"> Gerrit-PatchSet: 5 </div>
<div style="display:none"> Gerrit-Owner: Matt Jordan <mjordan@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Benjamin Keith Ford <bford@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Friendly Automation </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Matt Jordan <mjordan@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>