<p>Matt Jordan has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/11351">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">res_prometheus: Add Asterisk channel metrics<br><br>This patch adds basic Asterisk channel statistics to the res_prometheus<br>module. This includes:<br><br>* asterisk_calls_sum: A running sum of the total number of<br>  processed calls<br><br>* asterisk_calls_count: The current number of calls<br><br>* asterisk_channels_count: The current number of channels<br><br>* asterisk_channels_state: The state of any particular channel<br><br>* asterisk_channels_duration_seconds: How long a channel has existed,<br>  in seconds<br><br>In all cases, enough information is provided with each channel metric<br>to determine a unique instance of Asterisk that provided the data, as<br>well as the name, type, unique ID, and - if present - linked ID of each<br>channel.<br><br>ASTERISK-28403<br><br>Change-Id: I0db306ec94205d4f58d1e7fbabfe04b185869f59<br>---<br>M configs/samples/prometheus.conf.sample<br>M include/asterisk/res_prometheus.h<br>M res/Makefile<br>A res/prometheus/channels.c<br>A res/prometheus/prometheus_internal.h<br>M res/res_prometheus.c<br>6 files changed, 365 insertions(+), 7 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/51/11351/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/configs/samples/prometheus.conf.sample b/configs/samples/prometheus.conf.sample</span><br><span>index 63e9bd6..3ee9290 100644</span><br><span>--- a/configs/samples/prometheus.conf.sample</span><br><span>+++ b/configs/samples/prometheus.conf.sample</span><br><span>@@ -3,12 +3,9 @@</span><br><span> ;</span><br><span> </span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; Note that this configuration file is consumed by res_prometheus, which</span><br><span style="color: hsl(0, 100%, 40%);">-; provides core functionality for serving up Asterisk statistics to a</span><br><span style="color: hsl(0, 100%, 40%);">-; Prometheus server. By default, this only includes basic information about</span><br><span style="color: hsl(0, 100%, 40%);">-; the Asterisk instance that is running. Additional modules can be loaded to</span><br><span style="color: hsl(0, 100%, 40%);">-; provide specific statistics. In all cases, configuration of said statistics</span><br><span style="color: hsl(0, 100%, 40%);">-; is done through this configuration file.</span><br><span style="color: hsl(120, 100%, 40%);">+; This configuration file is consumed by res_prometheus, which</span><br><span style="color: hsl(120, 100%, 40%);">+; provides the functionality for serving up Asterisk statistics to a</span><br><span style="color: hsl(120, 100%, 40%);">+; Prometheus server.</span><br><span> ;</span><br><span> ; Because Prometheus scrapes statistics from HTTP servers, this module requires</span><br><span> ; Asterisk's built-in HTTP server to be enabled and configured properly.</span><br><span>diff --git a/include/asterisk/res_prometheus.h b/include/asterisk/res_prometheus.h</span><br><span>index cf62b7b..4b6ce16 100644</span><br><span>--- a/include/asterisk/res_prometheus.h</span><br><span>+++ b/include/asterisk/res_prometheus.h</span><br><span>@@ -84,6 +84,36 @@</span><br><span> };</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief A function table for a metrics provider</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \details</span><br><span style="color: hsl(120, 100%, 40%);">+ * It's generally nice to separate out things that provide metrics</span><br><span style="color: hsl(120, 100%, 40%);">+ * from the core of this module. For those that want to be notified</span><br><span style="color: hsl(120, 100%, 40%);">+ * when things happen in the core module, they can provide an instance</span><br><span style="color: hsl(120, 100%, 40%);">+ * of this function table using \c prometheus_metrics_provider_register</span><br><span style="color: hsl(120, 100%, 40%);">+ * and be notified when module affecting changes occur.</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+struct prometheus_metrics_provider {</span><br><span style="color: hsl(120, 100%, 40%);">+    /*!</span><br><span style="color: hsl(120, 100%, 40%);">+    * \brief Handy name of the provider for debugging purposes</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 Reload callback</span><br><span style="color: hsl(120, 100%, 40%);">+      *</span><br><span style="color: hsl(120, 100%, 40%);">+     * \param config The reloaded config</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 (* const reload_cb)(struct prometheus_general_config *config);</span><br><span style="color: hsl(120, 100%, 40%);">+    /*!</span><br><span style="color: hsl(120, 100%, 40%);">+    * \brief Unload callback.</span><br><span style="color: hsl(120, 100%, 40%);">+     */</span><br><span style="color: hsl(120, 100%, 40%);">+   void (* const unload_cb)(void);</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>  * \brief Prometheus metric type</span><br><span>  *</span><br><span>  * \note</span><br><span>@@ -438,6 +468,13 @@</span><br><span> void prometheus_callback_unregister(struct prometheus_callback *callback);</span><br><span> </span><br><span> /*!</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Register a metrics provider</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param provider The provider function table to register</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+void prometheus_metrics_provider_register(const struct prometheus_metrics_provider *provider);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*!</span><br><span>  * \brief Retrieve the current configuration of the module</span><br><span>  *</span><br><span>  * \note</span><br><span>diff --git a/res/Makefile b/res/Makefile</span><br><span>index 5ff38ad..78410ad 100644</span><br><span>--- a/res/Makefile</span><br><span>+++ b/res/Makefile</span><br><span>@@ -66,6 +66,7 @@</span><br><span> $(call MOD_ADD_C,res_snmp,snmp/agent.c)</span><br><span> $(call MOD_ADD_C,res_parking,$(wildcard parking/*.c))</span><br><span> $(call MOD_ADD_C,res_pjsip,$(wildcard res_pjsip/*.c))</span><br><span style="color: hsl(120, 100%, 40%);">+$(call MOD_ADD_C,res_prometheus,$(wildcard prometheus/*.c))</span><br><span> $(call MOD_ADD_C,res_ari,ari/cli.c ari/config.c ari/ari_websockets.c)</span><br><span> $(call MOD_ADD_C,res_ari_model,ari/ari_model_validators.c)</span><br><span> $(call MOD_ADD_C,res_stasis_recording,stasis_recording/stored.c)</span><br><span>diff --git a/res/prometheus/channels.c b/res/prometheus/channels.c</span><br><span>new file mode 100644</span><br><span>index 0000000..214726a</span><br><span>--- /dev/null</span><br><span>+++ b/res/prometheus/channels.c</span><br><span>@@ -0,0 +1,234 @@</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%);">+ * 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 Channel 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%);">+#include "asterisk/res_prometheus.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "asterisk/stasis_channels.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "asterisk/pbx.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 CHANNELS_STATE_HELP "Individual channel states. 0=down; 1=reserved; 2=offhook; 3=dialing; 4=ring; 5=ringing; 6=up; 7=busy; 8=dialing_offhook; 9=prering."</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#define CHANNELS_DURATION_HELP "Individual channel durations (in seconds)."</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 a channel's current state</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 Channel snapshot</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static void get_channel_state(struct prometheus_metric *metric, struct ast_channel_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->state);</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 function to get a channel's current duration</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%);">+ * \param snapshot Channel snapshot</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static void get_channel_duration(struct prometheus_metric *metric, struct ast_channel_snapshot *snapshot)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+   struct timeval now = ast_tvnow();</span><br><span style="color: hsl(120, 100%, 40%);">+     int64_t duration = ast_tvdiff_sec(now, snapshot->base->creationtime);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ snprintf(metric->value, sizeof(metric->value), "%" PRIu64, duration);</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 channel stats</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+struct channel_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 channel</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_channel_snapshot *snapshot);</span><br><span style="color: hsl(120, 100%, 40%);">+} channel_metric_defs[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+       {</span><br><span style="color: hsl(120, 100%, 40%);">+             .help = CHANNELS_STATE_HELP,</span><br><span style="color: hsl(120, 100%, 40%);">+          .name = "asterisk_channels_state",</span><br><span style="color: hsl(120, 100%, 40%);">+          .get_value = get_channel_state,</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%);">+             .help = CHANNELS_DURATION_HELP,</span><br><span style="color: hsl(120, 100%, 40%);">+               .name = "asterisk_channels_duration_seconds",</span><br><span style="color: hsl(120, 100%, 40%);">+               .get_value = get_channel_duration,</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%);">+static void get_total_call_count(struct prometheus_metric *metric)</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", ast_processed_calls());</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%);">+static void get_current_call_count(struct prometheus_metric *metric)</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", ast_active_calls());</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 Channel based metrics that are always available</span><br><span style="color: hsl(120, 100%, 40%);">+ */</span><br><span style="color: hsl(120, 100%, 40%);">+static struct prometheus_metric global_channel_metrics[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+       PROMETHEUS_METRIC_STATIC_INITIALIZATION(</span><br><span style="color: hsl(120, 100%, 40%);">+              PROMETHEUS_METRIC_COUNTER,</span><br><span style="color: hsl(120, 100%, 40%);">+            "asterisk_calls_sum",</span><br><span style="color: hsl(120, 100%, 40%);">+               "Total call count.",</span><br><span style="color: hsl(120, 100%, 40%);">+                &get_total_call_count</span><br><span style="color: hsl(120, 100%, 40%);">+     ),</span><br><span style="color: hsl(120, 100%, 40%);">+    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_calls_count",</span><br><span style="color: hsl(120, 100%, 40%);">+             "Current call count.",</span><br><span style="color: hsl(120, 100%, 40%);">+              &get_current_call_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 channels_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 *channels;</span><br><span style="color: hsl(120, 100%, 40%);">+       struct ao2_iterator it_chans;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct ast_channel_snapshot *snapshot;</span><br><span style="color: hsl(120, 100%, 40%);">+        struct prometheus_metric *channel_metrics;</span><br><span style="color: hsl(120, 100%, 40%);">+    char eid_str[32];</span><br><span style="color: hsl(120, 100%, 40%);">+     int num_channels;</span><br><span style="color: hsl(120, 100%, 40%);">+     int i, j;</span><br><span style="color: hsl(120, 100%, 40%);">+     struct prometheus_metric channel_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_channels_count",</span><br><span style="color: hsl(120, 100%, 40%);">+          "Current channel 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%);">+     channels = ast_channel_cache_all();</span><br><span style="color: hsl(120, 100%, 40%);">+   num_channels = ao2_container_count(channels);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+       /* Channel count */</span><br><span style="color: hsl(120, 100%, 40%);">+   PROMETHEUS_METRIC_SET_LABEL(&channel_count, 0, "eid", eid_str);</span><br><span style="color: hsl(120, 100%, 40%);">+ snprintf(channel_count.value, sizeof(channel_count.value), "%d", num_channels);</span><br><span style="color: hsl(120, 100%, 40%);">+     prometheus_metric_to_string(&channel_count, response);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+  if (num_channels == 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+              ao2_ref(channels, -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%);">+   /* Global call values */</span><br><span style="color: hsl(120, 100%, 40%);">+      for (i = 0; i < ARRAY_LEN(global_channel_metrics); i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+          PROMETHEUS_METRIC_SET_LABEL(&global_channel_metrics[i], 0, "eid", eid_str);</span><br><span style="color: hsl(120, 100%, 40%);">+             global_channel_metrics[i].get_metric_value(&global_channel_metrics[i]);</span><br><span style="color: hsl(120, 100%, 40%);">+           prometheus_metric_to_string(&global_channel_metrics[i], 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%);">+   /* Channel dependent values */</span><br><span style="color: hsl(120, 100%, 40%);">+        channel_metrics = ast_calloc(ARRAY_LEN(channel_metric_defs) * num_channels, sizeof(*channel_metrics));</span><br><span style="color: hsl(120, 100%, 40%);">+        if (!channel_metrics) {</span><br><span style="color: hsl(120, 100%, 40%);">+               ao2_ref(channels, -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%);">+   for (i = 0; i < ARRAY_LEN(channel_metric_defs); i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+             it_chans = ao2_iterator_init(channels, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+            for (j = 0; (snapshot = ao2_iterator_next(&it_chans)); ao2_ref(snapshot, -1), j++) {</span><br><span style="color: hsl(120, 100%, 40%);">+                      int index = i * num_channels + j;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+                   channel_metrics[index].type = PROMETHEUS_METRIC_GAUGE;</span><br><span style="color: hsl(120, 100%, 40%);">+                        ast_copy_string(channel_metrics[index].name, channel_metric_defs[i].name, sizeof(channel_metrics[index].name));</span><br><span style="color: hsl(120, 100%, 40%);">+                       channel_metrics[index].help = channel_metric_defs[i].help;</span><br><span style="color: hsl(120, 100%, 40%);">+                    PROMETHEUS_METRIC_SET_LABEL(&channel_metrics[index], 0, "eid", eid_str);</span><br><span style="color: hsl(120, 100%, 40%);">+                        PROMETHEUS_METRIC_SET_LABEL(&channel_metrics[index], 1, "name", (snapshot->base->name));</span><br><span style="color: hsl(120, 100%, 40%);">+                  PROMETHEUS_METRIC_SET_LABEL(&channel_metrics[index], 2, "id", (snapshot->base->uniqueid));</span><br><span style="color: hsl(120, 100%, 40%);">+                        PROMETHEUS_METRIC_SET_LABEL(&channel_metrics[index], 3, "type", (snapshot->base->type));</span><br><span style="color: hsl(120, 100%, 40%);">+                  if (snapshot->peer) {</span><br><span style="color: hsl(120, 100%, 40%);">+                              PROMETHEUS_METRIC_SET_LABEL(&channel_metrics[index], 4, "linkedid", (snapshot->peer->linkedid));</span><br><span style="color: hsl(120, 100%, 40%);">+                  }</span><br><span style="color: hsl(120, 100%, 40%);">+                     channel_metric_defs[i].get_value(&channel_metrics[index], snapshot);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+                    if (j > 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+                               AST_LIST_INSERT_TAIL(&channel_metrics[i * num_channels].children, &channel_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_iterator_destroy(&it_chans);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+                prometheus_metric_to_string(&channel_metrics[i * num_channels], 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%);">+   ast_free(channel_metrics);</span><br><span style="color: hsl(120, 100%, 40%);">+    ao2_ref(channels, -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 channels_callback = {</span><br><span style="color: hsl(120, 100%, 40%);">+ .name = "Channels callback",</span><br><span style="color: hsl(120, 100%, 40%);">+        .callback_fn = channels_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 channel_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(&channels_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 = "channels",</span><br><span style="color: hsl(120, 100%, 40%);">+ .unload_cb = channel_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 channel_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(&channels_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/prometheus_internal.h b/res/prometheus/prometheus_internal.h</span><br><span>new file mode 100644</span><br><span>index 0000000..06cff98</span><br><span>--- /dev/null</span><br><span>+++ b/res/prometheus/prometheus_internal.h</span><br><span>@@ -0,0 +1,41 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/*</span><br><span style="color: hsl(120, 100%, 40%);">+ * Prometheus Internal API</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%);">+#ifndef PROMETHEUS_INTERNAL_H__</span><br><span style="color: hsl(120, 100%, 40%);">+#define PROMETHEUS_INTERNAL_H__</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 prometheus_internal</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * \brief Prometheus Metric Internal API</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This module provides internal APIs for \file res_prometheus.</span><br><span style="color: hsl(120, 100%, 40%);">+ * It should not be used outsize of that module, and should</span><br><span style="color: hsl(120, 100%, 40%);">+ * typically only provide intialization functions for units that</span><br><span style="color: hsl(120, 100%, 40%);">+ * want to register metrics / handlers with the core API.</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%);">+ * \brief Initialize channel 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 channel_metrics_init(void);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#endif /* #define PROMETHEUS_INTERNAL_H__ */</span><br><span>diff --git a/res/res_prometheus.c b/res/res_prometheus.c</span><br><span>index 03f66d4..ef5a7dd 100644</span><br><span>--- a/res/res_prometheus.c</span><br><span>+++ b/res/res_prometheus.c</span><br><span>@@ -128,6 +128,8 @@</span><br><span> #include "asterisk/buildinfo.h"</span><br><span> #include "asterisk/res_prometheus.h"</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+#include "prometheus/prometheus_internal.h"</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! \brief Lock that protects data structures during an HTTP scrape */</span><br><span> AST_MUTEX_DEFINE_STATIC(scrape_lock);</span><br><span> </span><br><span>@@ -135,6 +137,8 @@</span><br><span> </span><br><span> AST_VECTOR(, struct prometheus_callback *) callbacks;</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+AST_VECTOR(, const struct prometheus_metrics_provider *) providers;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! \brief The actual module config */</span><br><span> struct module_config {</span><br><span>         /*! \brief General settings */</span><br><span>@@ -815,6 +819,11 @@</span><br><span>        }</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+void prometheus_metrics_provider_register(const struct prometheus_metrics_provider *provider)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+  AST_VECTOR_APPEND(&providers, provider);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> static int unload_module(void)</span><br><span> {</span><br><span>     SCOPED_MUTEX(lock, &scrape_lock);</span><br><span>@@ -822,6 +831,16 @@</span><br><span> </span><br><span>     ast_http_uri_unlink(&prometheus_uri);</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ for (i = 0; i < AST_VECTOR_SIZE(&providers); i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+            const struct prometheus_metrics_provider *provider = AST_VECTOR_GET(&providers, i);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+             if (!provider->unload_cb) {</span><br><span style="color: hsl(120, 100%, 40%);">+                        continue;</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%);">+           provider->unload_cb();</span><br><span style="color: hsl(120, 100%, 40%);">+     }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>  for (i = 0; i < AST_VECTOR_SIZE(&metrics); i++) {</span><br><span>             struct prometheus_metric *metric = AST_VECTOR_GET(&metrics, i);</span><br><span> </span><br><span>@@ -830,7 +849,7 @@</span><br><span>        AST_VECTOR_FREE(&metrics);</span><br><span> </span><br><span>   AST_VECTOR_FREE(&callbacks);</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+      AST_VECTOR_FREE(&providers);</span><br><span>     aco_info_destroy(&cfg_info);</span><br><span>     ao2_global_obj_release(global_config);</span><br><span> </span><br><span>@@ -839,11 +858,31 @@</span><br><span> </span><br><span> static int reload_module(void) {</span><br><span>   SCOPED_MUTEX(lock, &scrape_lock);</span><br><span style="color: hsl(120, 100%, 40%);">+ int i;</span><br><span style="color: hsl(120, 100%, 40%);">+        struct prometheus_general_config *general_config;</span><br><span> </span><br><span>        ast_http_uri_unlink(&prometheus_uri);</span><br><span>    if (aco_process_config(&cfg_info, 1) == ACO_PROCESS_ERROR) {</span><br><span>             return -1;</span><br><span>   }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+   /* Our config should be all reloaded now */</span><br><span style="color: hsl(120, 100%, 40%);">+   general_config = prometheus_general_config_get();</span><br><span style="color: hsl(120, 100%, 40%);">+     for (i = 0; i < AST_VECTOR_SIZE(&providers); i++) {</span><br><span style="color: hsl(120, 100%, 40%);">+            const struct prometheus_metrics_provider *provider = AST_VECTOR_GET(&providers, i);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+             if (!provider->reload_cb) {</span><br><span style="color: hsl(120, 100%, 40%);">+                        continue;</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%);">+           if (provider->reload_cb(general_config)) {</span><br><span style="color: hsl(120, 100%, 40%);">+                 ast_log(AST_LOG_WARNING, "Failed to reload metrics provider %s\n", provider->name);</span><br><span style="color: hsl(120, 100%, 40%);">+                      ao2_ref(general_config, -1);</span><br><span style="color: hsl(120, 100%, 40%);">+                  return -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%);">+     ao2_ref(general_config, -1);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>       if (ast_http_uri_link(&prometheus_uri)) {</span><br><span>                ast_log(AST_LOG_WARNING, "Failed to re-register Prometheus Metrics URI during reload\n");</span><br><span>          return -1;</span><br><span>@@ -864,6 +903,10 @@</span><br><span>            goto cleanup;</span><br><span>        }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if (AST_VECTOR_INIT(&providers, 8)) {</span><br><span style="color: hsl(120, 100%, 40%);">+             goto cleanup;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>  if (aco_info_init(&cfg_info)) {</span><br><span>          goto cleanup;</span><br><span>        }</span><br><span>@@ -877,6 +920,10 @@</span><br><span>             goto cleanup;</span><br><span>        }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if (channel_metrics_init()) {</span><br><span style="color: hsl(120, 100%, 40%);">+         goto cleanup;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>  if (ast_http_uri_link(&prometheus_uri)) {</span><br><span>                goto cleanup;</span><br><span>        }</span><br><span>@@ -888,6 +935,7 @@</span><br><span>      aco_info_destroy(&cfg_info);</span><br><span>     AST_VECTOR_FREE(&metrics);</span><br><span>       AST_VECTOR_FREE(&callbacks);</span><br><span style="color: hsl(120, 100%, 40%);">+      AST_VECTOR_FREE(&providers);</span><br><span> </span><br><span>         return AST_MODULE_LOAD_DECLINE;</span><br><span> }</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/11351">change 11351</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/+/11351"/><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: I0db306ec94205d4f58d1e7fbabfe04b185869f59 </div>
<div style="display:none"> Gerrit-Change-Number: 11351 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Matt Jordan <mjordan@digium.com> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>