X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=contrib%2Fcussh.pl;h=ae758d17b14e1600188f57386572a339c6e338f0;hb=de407dd4e036f73e9bd4658af9d71f504fc11109;hp=c19c3f3092c659a860e108b753fac6505dcba3c6;hpb=a813e8af8379bd0f55a2b46fc7918fa31de9522e;p=collectd.git

diff --git a/contrib/cussh.pl b/contrib/cussh.pl
index c19c3f30..ae758d17 100755
--- a/contrib/cussh.pl
+++ b/contrib/cussh.pl
@@ -1,7 +1,7 @@
 #!/usr/bin/perl
 #
 # collectd - contrib/cussh.pl
-# Copyright (C) 2007  Sebastian Harl
+# Copyright (C) 2007-2009  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
@@ -57,9 +57,13 @@ use Collectd::Unixsock();
 	my $sock = Collectd::Unixsock->new($path);
 
 	my $cmds = {
-		PUTVAL => \&putval,
-		GETVAL => \&getval,
-		FLUSH  => \&flush,
+		HELP    => \&cmd_help,
+		PUTVAL  => \&putval,
+		GETVAL  => \&getval,
+		GETTHRESHOLD  => \&getthreshold,
+		FLUSH   => \&flush,
+		LISTVAL => \&listval,
+		PUTNOTIF => \&putnotif,
 	};
 
 	if (! $sock) {
@@ -67,7 +71,7 @@ use Collectd::Unixsock();
 		exit 1;
 	}
 
-	print "cussh version 0.2, Copyright (C) 2007 Sebastian Harl\n"
+	print "cussh version 0.2, Copyright (C) 2007-2008 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";
@@ -76,9 +80,13 @@ use Collectd::Unixsock();
 		print "cussh> ";
 		my $line = <STDIN>;
 
-		last if ((! $line) || ($line =~ m/^quit$/i));
+		last if (! $line);
 
-		my ($cmd) = $line =~ m/^(\w+)\s+/;
+		chomp $line;
+
+		last if ($line =~ m/^quit$/i);
+
+		my ($cmd) = $line =~ m/^(\w+)\s*/;
 		$line = $';
 
 		next if (! $cmd);
@@ -103,13 +111,42 @@ use Collectd::Unixsock();
 	exit 0;
 }
 
+sub tokenize {
+	my $line     = shift || return;
+	my $line_ptr = $line;
+	my @line     = ();
+
+	my $token_pattern = qr/[^"\s]+|"[^"]+"/;
+
+	while (my ($token) = $line_ptr =~ m/^($token_pattern)\s+/) {
+		$line_ptr = $';
+		push @line, $token;
+	}
+
+	if ($line_ptr =~ m/^$token_pattern$/) {
+		push @line, $line_ptr;
+	}
+	else {
+		my ($token) = split m/ /, $line_ptr, 1;
+		print STDERR "Failed to parse line: $line\n";
+		print STDERR "Parse error near token \"$token\".\n";
+		return;
+	}
+
+	foreach my $l (@line) {
+		if ($l =~ m/^"(.*)"$/) {
+			$l = $1;
+		}
+	}
+	return @line;
+}
+
 sub getid {
 	my $string = shift || return;
 
-	print $$string . $/;
 	my ($h, $p, $pi, $t, $ti) =
-		$$string =~ m/^(\w+)\/(\w+)(?:-(\w+))?\/(\w+)(?:-(\w+))?\s+/;
-	$$string = $';
+		$string =~ m#^([^/]+)/([^/-]+)(?:-([^/]+))?/([^/-]+)(?:-([^/]+))?\s*#;
+	$string = $';
 
 	return if ((! $h) || (! $p) || (! $t));
 
@@ -117,21 +154,102 @@ sub getid {
 
 	($id{'host'}, $id{'plugin'}, $id{'type'}) = ($h, $p, $t);
 
-	$id{'plugin_instance'} = $pi if ($pi);
-	$id{'type_instance'} = $ti if ($ti);
+	$id{'plugin_instance'} = $pi if defined ($pi);
+	$id{'type_instance'} = $ti if defined ($ti);
 	return \%id;
 }
 
+sub putid {
+	my $ident = shift || return;
+
+	my $string;
+
+	$string = $ident->{'host'} . "/" . $ident->{'plugin'};
+
+	if (defined $ident->{'plugin_instance'}) {
+		$string .= "-" . $ident->{'plugin_instance'};
+	}
+
+	$string .= "/" . $ident->{'type'};
+
+	if (defined $ident->{'type_instance'}) {
+		$string .= "-" . $ident->{'type_instance'};
+	}
+	return $string;
+}
+
 =head1 COMMANDS
 
 =over 4
 
-=item B<GETVAL> I<Identifier>
+=item B<HELP>
 
-=item B<PUTVAL> I<Identifier> I<Valuelist>
+=cut
 
-These commands follow the exact same syntax as described in
-L<collectd-unixsock(5)>.
+sub cmd_help {
+	my $sock = shift;
+	my $line = shift || '';
+
+	my @line = tokenize($line);
+	my $cmd = shift (@line);
+
+	my %text = (
+		help => <<HELP,
+Available commands:
+  HELP
+  PUTVAL
+  GETVAL
+  GETTHRESHOLD
+  FLUSH
+  LISTVAL
+  PUTNOTIF
+
+See the embedded Perldoc documentation for details. To do that, run:
+  perldoc $0
+HELP
+		putval => <<HELP,
+PUTVAL <id> <value0> [<value1> ...]
+
+Submits a value to the daemon.
+HELP
+		getval => <<HELP,
+GETVAL <id>
+
+Retrieves the current value or values from the daemon.
+HELP
+		flush => <<HELP,
+FLUSH [plugin=<plugin>] [timeout=<timeout>] [identifier=<id>] [...]
+
+Sends a FLUSH command to the daemon.
+HELP
+		listval => <<HELP,
+LISTVAL
+
+Prints a list of available values.
+HELP
+		putnotif => <<HELP
+PUTNOTIF severity=<severity> [...] message=<message>
+
+Sends a notifications message to the daemon.
+HELP
+	);
+
+	if (!$cmd)
+	{
+		$cmd = 'help';
+	}
+	if (!exists ($text{$cmd}))
+	{
+		print STDOUT "Unknown command: " . uc ($cmd) . "\n\n";
+		$cmd = 'help';
+	}
+
+	print STDOUT $text{$cmd};
+
+	return 1;
+} # cmd_help
+
+=item B<PUTVAL> I<Identifier> I<Valuelist>
 
 =cut
 
@@ -139,31 +257,71 @@ sub putval {
 	my $sock = shift || return;
 	my $line = shift || return;
 
-	my $id = getid(\$line);
+	my @line = tokenize($line);
+
+	my $id;
+	my $ret;
+
+	if (! @line) {
+		return;
+	}
+
+	if (scalar(@line) < 2) {
+		print STDERR "Synopsis: PUTVAL <id> <value0> [<value1> ...]" . $/;
+		return;
+	}
+
+	$id = getid($line[0]);
 
 	if (! $id) {
-		print STDERR $sock->{'error'} . $/;
+		print STDERR "Invalid id \"$line[0]\"." . $/;
 		return;
 	}
 
 	my ($time, @values) = split m/:/, $line;
-	return $sock->putval(%$id, $time, \@values);
+	$ret = $sock->putval(%$id, time => $time, values => \@values);
+
+	if (! $ret) {
+		print STDERR "socket error: " . $sock->{'error'} . $/;
+	}
+	return $ret;
 }
 
+=item B<GETVAL> I<Identifier>
+
+=cut
+
 sub getval {
 	my $sock = shift || return;
 	my $line = shift || return;
 
-	my $id = getid(\$line);
+	my @line = tokenize($line);
+
+	my $id;
+	my $vals;
+
+	if (! @line) {
+		return;
+	}
+
+	if (scalar(@line) < 1) {
+		print STDERR "Synopsis: GETVAL <id>" . $/;
+		return;
+	}
+
+	$id = getid($line[0]);
 
 	if (! $id) {
-		print STDERR $sock->{'error'} . $/;
+		print STDERR "Invalid id \"$line[0]\"." . $/;
 		return;
 	}
 
-	my $vals = $sock->getval(%$id);
+	$vals = $sock->getval(%$id);
 
-	return if (! $vals);
+	if (! $vals) {
+		print STDERR "socket error: " . $sock->{'error'} . $/;
+		return;
+	}
 
 	foreach my $key (keys %$vals) {
 		print "\t$key: $vals->{$key}\n";
@@ -171,10 +329,58 @@ sub getval {
 	return 1;
 }
 
+=item B<GETTHRESHOLD> I<Identifier>
+
+=cut
+
+sub getthreshold {
+	my $sock = shift || return;
+	my $line = shift || return;
+
+	my @line = tokenize($line);
+
+	my $id;
+	my $vals;
+
+	if (! @line) {
+		return;
+	}
+
+	if (scalar(@line) < 1) {
+		print STDERR "Synopsis: GETTHRESHOLD <id>" . $/;
+		return;
+	}
+
+	$id = getid($line[0]);
+
+	if (! $id) {
+		print STDERR "Invalid id \"$line[0]\"." . $/;
+		return;
+	}
+
+	$vals = $sock->getthreshold(%$id);
+
+	if (! $vals) {
+		print STDERR "socket error: " . $sock->{'error'} . $/;
+		return;
+	}
+
+	foreach my $key (keys %$vals) {
+		print "\t$key: $vals->{$key}\n";
+	}
+	return 1;
+}
+
+=item B<FLUSH> [B<timeout>=I<$timeout>] [B<plugin>=I<$plugin>[ ...]]
+
+=cut
+
 sub flush {
 	my $sock = shift || return;
 	my $line = shift;
 
+	my @line = tokenize($line);
+
 	my $res;
 
 	if (! $line) {
@@ -183,7 +389,7 @@ sub flush {
 	else {
 		my %args = ();
 
-		foreach my $i (split m/ /, $line) {
+		foreach my $i (@line) {
 			my ($option, $value) = $i =~ m/^([^=]+)=(.+)$/;
 			next if (! ($option && $value));
 
@@ -193,6 +399,15 @@ sub flush {
 			elsif ($option eq "timeout") {
 				$args{"timeout"} = $value;
 			}
+			elsif ($option eq "identifier") {
+				my $id = getid ($value);
+				if (!$id)
+				{
+					print STDERR "Not a valid identifier: \"$value\"\n";
+					next;
+				}
+				push @{$args{"identifier"}}, $id;
+			}
 			else {
 				print STDERR "Invalid option \"$option\".\n";
 				return;
@@ -203,12 +418,77 @@ sub flush {
 	}
 
 	if (! $res) {
-		print STDERR $sock->{'error'} . $/;
+		print STDERR "socket error: " . $sock->{'error'} . $/;
+	}
+	return $res;
+}
+
+=item B<LISTVAL>
+
+=cut
+
+sub listval {
+	my $sock = shift || return;
+	my $line = shift;
+
+	my @res;
+
+	if ($line ne "") {
+		print STDERR "Synopsis: LISTVAL" . $/;
+		return;
+	}
+
+	@res = $sock->listval();
+
+	if (! @res) {
+		print STDERR "socket error: " . $sock->{'error'} . $/;
 		return;
 	}
+
+	foreach my $ident (@res) {
+		print $ident->{'time'} . " " . putid($ident) . $/;
+	}
 	return 1;
 }
 
+=item B<PUTNOTIF> [[B<severity>=I<$severity>] [B<message>=I<$message>] [ ...]]
+
+=cut
+
+sub putnotif {
+	my $sock = shift || return;
+	my $line = shift || return;
+
+	my @line = tokenize($line);
+
+	my $ret;
+
+	my (%values) = ();
+	foreach my $i (@line) {
+		my ($key, $val) = split m/=/, $i, 2;
+		if ($key && $val) {
+			$values{$key} = $val;
+		}
+		else {
+			$values{'message'} = defined($values{'message'})
+				? ($values{'message'} . ' ' . $key)
+				: $key;
+		}
+	}
+	$values{'time'} ||= time();
+
+	$ret = $sock->putnotif(%values);
+	if (! $ret) {
+		print STDERR "socket error: " . $sock->{'error'} . $/;
+	}
+	return $ret;
+}
+
+=back
+
+These commands follow the exact same syntax as described in
+L<collectd-unixsock(5)>.
+
 =head1 SEE ALSO
 
 L<collectd(1)>, L<collectd-unisock(5)>