<p>Pau Espin Pedrol <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/13304">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
Harald Welte: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Add vty option to print output of shell cmd on every poll step<br><br>Change-Id: I005773b75f81fa5f6c90f53af508fc6debea208b<br>---<br>M doc/examples/osmo-sysmon.cfg<br>M src/Makefile.am<br>M src/osysmon.h<br>M src/osysmon_main.c<br>A src/osysmon_shellcmd.c<br>5 files changed, 185 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/examples/osmo-sysmon.cfg b/doc/examples/osmo-sysmon.cfg</span><br><span>index f944f72..22c27cb 100644</span><br><span>--- a/doc/examples/osmo-sysmon.cfg</span><br><span>+++ b/doc/examples/osmo-sysmon.cfg</span><br><span>@@ -14,3 +14,4 @@</span><br><span> ping example.com</span><br><span> openvpn 127.0.0.1 1234</span><br><span> file os-image /etc/image-datetime</span><br><span style="color: hsl(120, 100%, 40%);">+shellcmd kernel uname -a</span><br><span>diff --git a/src/Makefile.am b/src/Makefile.am</span><br><span>index f9b79f2..a4663fd 100644</span><br><span>--- a/src/Makefile.am</span><br><span>+++ b/src/Makefile.am</span><br><span>@@ -42,6 +42,7 @@</span><br><span> osysmon_file.c \</span><br><span> osysmon_ping.c \</span><br><span> osysmon_openvpn.c \</span><br><span style="color: hsl(120, 100%, 40%);">+ osysmon_shellcmd.c \</span><br><span> osysmon_main.c \</span><br><span> $(NULL)</span><br><span> </span><br><span>diff --git a/src/osysmon.h b/src/osysmon.h</span><br><span>index 2f82c47..36cd608 100644</span><br><span>--- a/src/osysmon.h</span><br><span>+++ b/src/osysmon.h</span><br><span>@@ -13,6 +13,8 @@</span><br><span> </span><br><span> struct osysmon_state {</span><br><span> struct rtnl_client_state *rcs;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* list of 'struct osysmon_cmd' */</span><br><span style="color: hsl(120, 100%, 40%);">+ struct llist_head shellcmds;</span><br><span> /* list of 'struct ctrl client' */</span><br><span> struct llist_head ctrl_clients;</span><br><span> /* list of 'struct openvpn_client' */</span><br><span>@@ -21,6 +23,7 @@</span><br><span> struct llist_head netdevs;</span><br><span> /* list of 'struct osysmon_file' */</span><br><span> struct llist_head files;</span><br><span style="color: hsl(120, 100%, 40%);">+ /* list of ping contexts */</span><br><span> struct ping_state *pings;</span><br><span> };</span><br><span> </span><br><span>@@ -36,7 +39,6 @@</span><br><span> PING_NODE,</span><br><span> };</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> int osysmon_ctrl_go_parent(struct vty *vty);</span><br><span> int osysmon_ctrl_init();</span><br><span> int osysmon_ctrl_poll(struct value_node *parent);</span><br><span>@@ -56,3 +58,6 @@</span><br><span> </span><br><span> int osysmon_file_init();</span><br><span> int osysmon_file_poll(struct value_node *parent);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+int osysmon_shellcmd_init();</span><br><span style="color: hsl(120, 100%, 40%);">+int osysmon_shellcmd_poll(struct value_node *parent);</span><br><span>diff --git a/src/osysmon_main.c b/src/osysmon_main.c</span><br><span>index 1ba3753..fb01f5e 100644</span><br><span>--- a/src/osysmon_main.c</span><br><span>+++ b/src/osysmon_main.c</span><br><span>@@ -207,6 +207,7 @@</span><br><span> osysmon_ping_poll(root);</span><br><span> </span><br><span> osysmon_file_poll(root);</span><br><span style="color: hsl(120, 100%, 40%);">+ osysmon_shellcmd_poll(root);</span><br><span> </span><br><span> display_update(root);</span><br><span> value_node_del(root);</span><br><span>@@ -221,6 +222,7 @@</span><br><span> osmo_init_logging2(NULL, &log_info);</span><br><span> </span><br><span> g_oss = talloc_zero(NULL, struct osysmon_state);</span><br><span style="color: hsl(120, 100%, 40%);">+ INIT_LLIST_HEAD(&g_oss->shellcmds);</span><br><span> INIT_LLIST_HEAD(&g_oss->ctrl_clients);</span><br><span> INIT_LLIST_HEAD(&g_oss->openvpn_clients);</span><br><span> INIT_LLIST_HEAD(&g_oss->netdevs);</span><br><span>@@ -229,6 +231,7 @@</span><br><span> vty_init(&vty_info);</span><br><span> handle_options(argc, argv);</span><br><span> osysmon_sysinfo_init();</span><br><span style="color: hsl(120, 100%, 40%);">+ osysmon_shellcmd_init();</span><br><span> osysmon_ctrl_init();</span><br><span> osysmon_openvpn_init();</span><br><span> osysmon_rtnl_init();</span><br><span>diff --git a/src/osysmon_shellcmd.c b/src/osysmon_shellcmd.c</span><br><span>new file mode 100644</span><br><span>index 0000000..347b982</span><br><span>--- /dev/null</span><br><span>+++ b/src/osysmon_shellcmd.c</span><br><span>@@ -0,0 +1,174 @@</span><br><span style="color: hsl(120, 100%, 40%);">+/* Simple Osmocom System Monitor (osysmon): Support for monitoring through shell commands */</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/* (C) 2019 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de></span><br><span style="color: hsl(120, 100%, 40%);">+ * All Rights Reserved.</span><br><span style="color: hsl(120, 100%, 40%);">+ * Author: Pau Espin Pedrol <pespin@sysmocom.de></span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * SPDX-License-Identifier: GPL-2.0+</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is free software; you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+ * it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+ * the Free Software Foundation; either version 2 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+ * (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+ * but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+ * GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+ *</span><br><span style="color: hsl(120, 100%, 40%);">+ * You should have received a copy of the GNU General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+ * along with this program; if not, write to the Free Software</span><br><span style="color: hsl(120, 100%, 40%);">+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,</span><br><span style="color: hsl(120, 100%, 40%);">+ * MA 02110-1301, USA.</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 <string.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <stdio.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <errno.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <sys/sysinfo.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/vty/vty.h></span><br><span style="color: hsl(120, 100%, 40%);">+#include <osmocom/vty/command.h></span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#include "osysmon.h"</span><br><span style="color: hsl(120, 100%, 40%);">+#include "value_node.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%);">+ * Data model</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 osysmon_shellcmd {</span><br><span style="color: hsl(120, 100%, 40%);">+ struct llist_head list;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct {</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *name;</span><br><span style="color: hsl(120, 100%, 40%);">+ const char *cmd;</span><br><span style="color: hsl(120, 100%, 40%);">+ } cfg;</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 struct osysmon_shellcmd *osysmon_shellcmd_find(const char *name)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osysmon_shellcmd *oc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_for_each_entry(oc, &g_oss->shellcmds, list) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!strcmp(oc->cfg.name, name))</span><br><span style="color: hsl(120, 100%, 40%);">+ return oc;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+ return 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%);">+static struct osysmon_shellcmd *osysmon_shellcmd_add(const char *name, const char *cmd)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osysmon_shellcmd *oc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (osysmon_shellcmd_find(name))</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ oc = talloc_zero(g_oss, struct osysmon_shellcmd);</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_ASSERT(oc);</span><br><span style="color: hsl(120, 100%, 40%);">+ oc->cfg.name = talloc_strdup(oc, name);</span><br><span style="color: hsl(120, 100%, 40%);">+ oc->cfg.cmd = talloc_strdup(oc, cmd);</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_add_tail(&oc->list, &g_oss->shellcmds);</span><br><span style="color: hsl(120, 100%, 40%);">+ return oc;</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 osysmon_shellcmd_destroy(struct osysmon_shellcmd *oc)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_del(&oc->list);</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(oc);</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 osysmon_shellcmd_run(struct osysmon_shellcmd *oc, struct value_node *parent)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ char buf[512];</span><br><span style="color: hsl(120, 100%, 40%);">+ FILE *f;</span><br><span style="color: hsl(120, 100%, 40%);">+ char *p = buf;</span><br><span style="color: hsl(120, 100%, 40%);">+ long offset = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ f = popen(oc->cfg.cmd, "r");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!f) {</span><br><span style="color: hsl(120, 100%, 40%);">+ snprintf(buf, sizeof(buf), "<popen failed (%d)>", errno);</span><br><span style="color: hsl(120, 100%, 40%);">+ value_node_add(parent, oc->cfg.name, buf);</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%);">+ while ((offset = fread(p, 1, sizeof(buf) - 1 - (p - buf), f)) != 0) {</span><br><span style="color: hsl(120, 100%, 40%);">+ p += offset;</span><br><span style="color: hsl(120, 100%, 40%);">+ *p = '\0';</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%);">+ pclose(f);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (buf != p) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (*(p - 1) == '\n') /* Remove final new line if exists */</span><br><span style="color: hsl(120, 100%, 40%);">+ *(p - 1) = '\0';</span><br><span style="color: hsl(120, 100%, 40%);">+ value_node_add(parent, oc->cfg.name, buf);</span><br><span style="color: hsl(120, 100%, 40%);">+ } else {</span><br><span style="color: hsl(120, 100%, 40%);">+ value_node_add(parent, oc->cfg.name, "<EMPTY>");</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%);">+ * VTY</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%);">+#define CMD_STR "Configure a shell command to be executed\n"</span><br><span style="color: hsl(120, 100%, 40%);">+DEFUN(cfg_shellcmd, cfg_shellcmd_cmd,</span><br><span style="color: hsl(120, 100%, 40%);">+ "shellcmd NAME .TEXT",</span><br><span style="color: hsl(120, 100%, 40%);">+ CMD_STR "Name of this shell command snippet\n" "Command to run\n")</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osysmon_shellcmd *oc;</span><br><span style="color: hsl(120, 100%, 40%);">+ char *concat = argv_concat(argv, argc, 1);</span><br><span style="color: hsl(120, 100%, 40%);">+ oc = osysmon_shellcmd_add(argv[0], concat);</span><br><span style="color: hsl(120, 100%, 40%);">+ talloc_free(concat);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!oc) {</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, "Couldn't add shell cmd, maybe it exists?%s", 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%);">+ return CMD_SUCCESS;</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%);">+DEFUN(cfg_no_shellcmd, cfg_no_shellcmd_cmd,</span><br><span style="color: hsl(120, 100%, 40%);">+ "no shellcmd NAME",</span><br><span style="color: hsl(120, 100%, 40%);">+ NO_STR CMD_STR "Name of this shell command snippet\n")</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osysmon_shellcmd *oc;</span><br><span style="color: hsl(120, 100%, 40%);">+ oc = osysmon_shellcmd_find(argv[0]);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!oc) {</span><br><span style="color: hsl(120, 100%, 40%);">+ vty_out(vty, "Cannot find shell cmd for '%s'%s", argv[0], 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%);">+ osysmon_shellcmd_destroy(oc);</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 style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void osysmon_shellcmd_vty_init(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ install_element(CONFIG_NODE, &cfg_shellcmd_cmd);</span><br><span style="color: hsl(120, 100%, 40%);">+ install_element(CONFIG_NODE, &cfg_no_shellcmd_cmd);</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%);">+ * Runtime Code</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%);">+/* called once on startup before config file parsing */</span><br><span style="color: hsl(120, 100%, 40%);">+int osysmon_shellcmd_init()</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ osysmon_shellcmd_vty_init();</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 style="color: hsl(120, 100%, 40%);">+/* called periodically */</span><br><span style="color: hsl(120, 100%, 40%);">+int osysmon_shellcmd_poll(struct value_node *parent)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct value_node *vn_file;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osysmon_shellcmd *oc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ vn_file = value_node_add(parent, "shellcmd", NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ llist_for_each_entry(oc, &g_oss->shellcmds, list)</span><br><span style="color: hsl(120, 100%, 40%);">+ osysmon_shellcmd_run(oc, vn_file);</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></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/13304">change 13304</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/13304"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmo-sysmon </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I005773b75f81fa5f6c90f53af508fc6debea208b </div>
<div style="display:none"> Gerrit-Change-Number: 13304 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: Pau Espin Pedrol <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Max <msuraev@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Pau Espin Pedrol <pespin@sysmocom.de> </div>