From: Sebastian Harl <sh@tokkee.org>
Date: Tue, 12 Jun 2007 19:18:18 +0000 (+0200)
Subject: Added initial version off cussh.pl to contrib/.
X-Git-Tag: collectd-4.1.0~54
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=647b4b4a28f339364bd80b72e88209ed7dd23de9;p=collectd.git

Added initial version off cussh.pl to contrib/.

cussh (Collectd Unix Socket SHell) is a little interactive frontend for
the unixsock plugin. It supports two commands - GETVAL and PUTVAL - just
as the unixsock plugin itself.

Signed-off-by: Sebastian Harl <sh@tokkee.org>
Signed-off-by: Florian Forster <octo@huhu.verplant.org>
---

diff --git a/contrib/cussh.pl b/contrib/cussh.pl
new file mode 100755
index 00000000..65c634e0
--- /dev/null
+++ b/contrib/cussh.pl
@@ -0,0 +1,185 @@
+#!/usr/bin/perl
+#
+# collectd - contrib/cussh.pl
+# Copyright (C) 2007  Sebastian Harl
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; only version 2 of the License is applicable.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+#
+# Author:
+#   Sebastian Harl <sh at tokkee.org>
+#
+
+=head1 NAME
+
+cussh - collectd UNIX socket shell
+
+=head1 SYNOPSIS
+
+B<cussh> [I<E<lt>pathE<gt>>]
+
+=head1 DESCRIPTION
+
+B<collectd>'s unixsock plugin allows external programs to access the values it
+has collected or received and to submit own values. This is a little
+interactive frontend for this plugin.
+
+=head1 OPTIONS
+
+=over 4
+
+=item I<E<lt>pathE<gt>>
+
+The path to the UNIX socket provided by collectd's unixsock plugin. (Default:
+F</var/run/collectd-unixsock>)
+
+=back
+
+=cut
+
+use strict;
+use warnings;
+
+use Collectd::Unixsock();
+
+{ # main
+	my $path = $ARGV[0] || "/var/run/collectd-unixsock";
+	my $sock = Collectd::Unixsock->new($path);
+
+	if (! $sock) {
+		print STDERR "Unable to connect to $path!\n";
+		exit 1;
+	}
+
+	print "cussh version 0.1, Copyright (C) 2007 Sebastian Harl\n"
+		. "cussh comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
+		. "and you are welcome to redistribute it under certain conditions.\n"
+		. "See the GNU General Public License 2 for more details.\n\n";
+
+	while (1) {
+		print "cussh> ";
+		my $line = <STDIN>;
+
+		last if ((! $line) || ($line =~ m/^quit$/i));
+
+		my ($cmd) = $line =~ m/^(\w+)\s+/;
+		$line = $';
+
+		next if (! $cmd);
+		$cmd = uc $cmd;
+
+		my $f = undef;
+		if ($cmd eq "PUTVAL") {
+			$f = \&putval;
+		}
+		elsif ($cmd eq "GETVAL") {
+			$f = \&getval;
+		}
+		else {
+			print STDERR "ERROR: Unknown command $cmd!\n";
+			next;
+		}
+
+		if (! $f->($sock, $line)) {
+			print STDERR "ERROR: Command failed!\n";
+			next;
+		}
+	}
+
+	$sock->destroy();
+	exit 0;
+}
+
+sub getid {
+	my $string = shift || return;
+
+	print $$string . $/;
+	my ($h, $p, $pi, $t, $ti) =
+		$$string =~ m/^(\w+)\/(\w+)(?:-(\w+))?\/(\w+)(?:-(\w+))?\s+/;
+	$$string = $';
+
+	return if ((! $h) || (! $p) || (! $t));
+
+	my %id = ();
+
+	($id{'host'}, $id{'plugin'}, $id{'type'}) = ($h, $p, $t);
+
+	$id{'plugin_instance'} = $pi if ($pi);
+	$id{'type_instance'} = $ti if ($ti);
+	return \%id;
+}
+
+=head1 COMMANDS
+
+=over 4
+
+=item B<GETVAL> I<Identifier>
+
+=item B<PUTVAL> I<Identifier> I<Valuelist>
+
+These commands follow the exact same syntax as described in
+L<collectd-unixsock(5)>.
+
+=cut
+
+sub putval {
+	my $sock = shift || return;
+	my $line = shift || return;
+
+	my $id = getid(\$line);
+
+	return if (! $id);
+
+	my ($time, @values) = split m/:/, $line;
+	return $sock->putval(%$id, $time, \@values);
+}
+
+sub getval {
+	my $sock = shift || return;
+	my $line = shift || return;
+
+	my $id = getid(\$line);
+
+	return if (! $id);
+
+	my $vals = $sock->getval(%$id);
+
+	return if (! $vals);
+
+	foreach my $key (keys %$vals) {
+		print "\t$key: $vals->{$key}\n";
+	}
+	return 1;
+}
+
+=head1 SEE ALSO
+
+L<collectd(1)>, L<collectd-unisock(5)>
+
+=head1 AUTHOR
+
+Written by Sebastian Harl E<lt>sh@tokkee.orgE<gt>.
+
+B<collectd> has been written by Florian Forster and others.
+
+=head1 COPYRIGHT
+
+Copyright (C) 2007 Sebastian Harl.
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; only version 2 of the License is applicable.
+
+=cut
+
+# vim: set sw=4 ts=4 tw=78 noexpandtab :