<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/18138">View Change</a></p><div style="white-space:pre-wrap">Approvals:
laforge: Looks good to me, approved
pespin: Looks good to me, but someone else must approve
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">stats: Support regular stats flush<br><br>Reliable monitoring requires regular flush of all stat values, even<br>if they have not changed. Otherwise (1) the monitoring app has to<br>maintain state and (2) can go out of sync if it's restarted while<br>the app is still running.<br><br>Change-Id: I04f1e7bdf0d6f20e4f15571e94191de61c47ddad<br>---<br>M include/osmocom/core/stats.h<br>M src/stats.c<br>M src/vty/stats_vty.c<br>3 files changed, 59 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/core/stats.h b/include/osmocom/core/stats.h</span><br><span>index e01016d..b9edac2 100644</span><br><span>--- a/include/osmocom/core/stats.h</span><br><span>+++ b/include/osmocom/core/stats.h</span><br><span>@@ -73,6 +73,7 @@</span><br><span> char *bind_addr_str; /*!< local bind IP address */</span><br><span> int dest_port; /*!< destination (UDP) port */</span><br><span> int mtu; /*!< Maximum Transmission Unit */</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int flush_period; /*!< period between regular flushes */</span><br><span> </span><br><span> /*! Maximum class/index to report. FIXME: More details! */</span><br><span> enum osmo_stats_class max_class;</span><br><span>@@ -87,7 +88,8 @@</span><br><span> int fd; /*!< file descriptor of socket */</span><br><span> struct msgb *buffer; /*!< message buffer for log output */</span><br><span> int agg_enabled; /*!< is aggregation enabled? */</span><br><span style="color: hsl(0, 100%, 40%);">- int force_single_flush;</span><br><span style="color: hsl(120, 100%, 40%);">+ int force_single_flush; /*!< set to 1 to force a flush (send even unchanged stats values) */</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int flush_period_counter; /*!< count sends between forced flushes */</span><br><span> </span><br><span> struct llist_head list;</span><br><span> int (*open)(struct osmo_stats_reporter *srep);</span><br><span>@@ -129,6 +131,7 @@</span><br><span> int osmo_stats_reporter_set_name_prefix(struct osmo_stats_reporter *srep, const char *prefix);</span><br><span> int osmo_stats_reporter_enable(struct osmo_stats_reporter *srep);</span><br><span> int osmo_stats_reporter_disable(struct osmo_stats_reporter *srep);</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_stats_reporter_set_flush_period(struct osmo_stats_reporter *srep, unsigned int period);</span><br><span> </span><br><span> /* reporter creation */</span><br><span> struct osmo_stats_reporter *osmo_stats_reporter_create_log(const char *name);</span><br><span>diff --git a/src/stats.c b/src/stats.c</span><br><span>index 61b7df8..5954167 100644</span><br><span>--- a/src/stats.c</span><br><span>+++ b/src/stats.c</span><br><span>@@ -341,6 +341,25 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Set the regular flush period for a given stats_reporter</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * Send all stats even if they have not changed (i.e. force the flush)</span><br><span style="color: hsl(120, 100%, 40%);">+ * every N-th reporting interval. Set to 0 to disable regular flush,</span><br><span style="color: hsl(120, 100%, 40%);">+ * set to 1 to flush every time, set to 2 to flush every 2nd time, etc.</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] srep stats_reporter to set flush period for</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] period Reporting interval in seconds</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns 0 on success; negative on error */</span><br><span style="color: hsl(120, 100%, 40%);">+int osmo_stats_reporter_set_flush_period(struct osmo_stats_reporter *srep, unsigned int period)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ srep->flush_period = period;</span><br><span style="color: hsl(120, 100%, 40%);">+ srep->flush_period_counter = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* force the flush now if it's not disabled by period=0 */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (period > 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ srep->force_single_flush = 1;</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 style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! Set the name prefix of a given stats_reporter.</span><br><span> * \param[in] srep stats_reporter whose name prefix is to be set</span><br><span> * \param[in] prefix NAme perfix to pre-pend for any reported value</span><br><span>@@ -706,7 +725,17 @@</span><br><span> continue;</span><br><span> </span><br><span> osmo_stats_reporter_send_buffer(srep);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ /* reset force_single_flush first */</span><br><span> srep->force_single_flush = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* and schedule a new flush if it's time for it */</span><br><span style="color: hsl(120, 100%, 40%);">+ if (srep->flush_period > 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ srep->flush_period_counter++;</span><br><span style="color: hsl(120, 100%, 40%);">+ if (srep->flush_period_counter >= srep->flush_period) {</span><br><span style="color: hsl(120, 100%, 40%);">+ srep->force_single_flush = 1;</span><br><span style="color: hsl(120, 100%, 40%);">+ srep->flush_period_counter = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> }</span><br><span> }</span><br><span> </span><br><span>diff --git a/src/vty/stats_vty.c b/src/vty/stats_vty.c</span><br><span>index a512703..4628281 100644</span><br><span>--- a/src/vty/stats_vty.c</span><br><span>+++ b/src/vty/stats_vty.c</span><br><span>@@ -245,6 +245,27 @@</span><br><span> return CMD_SUCCESS;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+DEFUN(cfg_stats_reporter_flush_period, cfg_stats_reporter_flush_period_cmd,</span><br><span style="color: hsl(120, 100%, 40%);">+ "flush-period <0-65535>",</span><br><span style="color: hsl(120, 100%, 40%);">+ CFG_STATS_STR "Send all stats even if they have not changed (i.e. force the flush)"</span><br><span style="color: hsl(120, 100%, 40%);">+ "every N-th reporting interval. Set to 0 to disable regular flush (default).\n"</span><br><span style="color: hsl(120, 100%, 40%);">+ "0 to disable regular flush (default), 1 to flush every time, 2 to flush every 2nd time, etc\n")</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+ unsigned int period = atoi(argv[0]);</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_stats_reporter *srep = osmo_stats_vty2srep(vty);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(srep);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_stats_reporter_set_flush_period(srep, period);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, "%% Unable to set force flush period: %s%s",</span><br><span style="color: hsl(120, 100%, 40%);">+ strerror(-rc), VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+ return CMD_WARNING;</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%);">+ return CMD_SUCCESS;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> DEFUN(cfg_stats_reporter_statsd, cfg_stats_reporter_statsd_cmd,</span><br><span> "stats reporter statsd",</span><br><span> CFG_STATS_STR CFG_REPORTER_STR "Report to a STATSD server\n")</span><br><span>@@ -588,6 +609,10 @@</span><br><span> else</span><br><span> vty_out(vty, " no prefix%s", VTY_NEWLINE);</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if (srep->flush_period > 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, " flush-period %d%s",</span><br><span style="color: hsl(120, 100%, 40%);">+ srep->flush_period, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> if (srep->enabled)</span><br><span> vty_out(vty, " enable%s", VTY_NEWLINE);</span><br><span> </span><br><span>@@ -637,6 +662,7 @@</span><br><span> install_element(CFG_STATS_NODE, &cfg_stats_reporter_level_cmd);</span><br><span> install_element(CFG_STATS_NODE, &cfg_stats_reporter_enable_cmd);</span><br><span> install_element(CFG_STATS_NODE, &cfg_stats_reporter_disable_cmd);</span><br><span style="color: hsl(120, 100%, 40%);">+ install_element(CFG_STATS_NODE, &cfg_stats_reporter_flush_period_cmd);</span><br><span> </span><br><span> install_element_ve(&show_stats_asciidoc_table_cmd);</span><br><span> install_element_ve(&show_rate_counters_cmd);</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/18138">change 18138</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.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.osmocom.org/c/libosmocore/+/18138"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I04f1e7bdf0d6f20e4f15571e94191de61c47ddad </div>
<div style="display:none"> Gerrit-Change-Number: 18138 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: ipse <Alexander.Chemeris@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: ipse <Alexander.Chemeris@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>