3 # collectd - contrib/cussh.pl
4 # Copyright (C) 2007-2008 Sebastian Harl
6 # This program is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by the
8 # Free Software Foundation; only version 2 of the License is applicable.
10 # This program is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 # General Public License for more details.
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 # Sebastian Harl <sh at tokkee.org>
25 cussh - collectd UNIX socket shell
29 B<cussh> [I<E<lt>pathE<gt>>]
33 B<collectd>'s unixsock plugin allows external programs to access the values it
34 has collected or received and to submit own values. This is a little
35 interactive frontend for this plugin.
41 =item I<E<lt>pathE<gt>>
43 The path to the UNIX socket provided by collectd's unixsock plugin. (Default:
44 F</var/run/collectd-unixsock>)
53 use Collectd::Unixsock();
56 my $path = $ARGV[0] || "/var/run/collectd-unixsock";
57 my $sock = Collectd::Unixsock->new($path);
68 print STDERR "Unable to connect to $path!\n";
72 print "cussh version 0.2, Copyright (C) 2007-2008 Sebastian Harl\n"
73 . "cussh comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
74 . "and you are welcome to redistribute it under certain conditions.\n"
75 . "See the GNU General Public License 2 for more details.\n\n";
85 last if ($line =~ m/^quit$/i);
87 my ($cmd) = $line =~ m/^(\w+)\s*/;
94 if (defined $cmds->{$cmd}) {
98 print STDERR "ERROR: Unknown command $cmd!\n";
102 if (! $f->($sock, $line)) {
103 print STDERR "ERROR: Command failed!\n";
113 my $string = shift || return;
116 my ($h, $p, $pi, $t, $ti) =
117 $$string =~ m#^([^/]+)/([^/-]+)(?:-([^/]+))?/([^/-]+)(?:-([^/]+))?\s*#;
120 return if ((! $h) || (! $p) || (! $t));
124 ($id{'host'}, $id{'plugin'}, $id{'type'}) = ($h, $p, $t);
126 $id{'plugin_instance'} = $pi if defined ($pi);
127 $id{'type_instance'} = $ti if defined ($ti);
132 my $ident = shift || return;
136 $string = $ident->{'host'} . "/" . $ident->{'plugin'};
138 if (defined $ident->{'plugin_instance'}) {
139 $string .= "-" . $ident->{'plugin_instance'};
142 $string .= "/" . $ident->{'type'};
144 if (defined $ident->{'type_instance'}) {
145 $string .= "-" . $ident->{'type_instance'};
167 See the embedded Perldoc documentation for details. To do that, run:
173 =item B<GETVAL> I<Identifier>
178 my $sock = shift || return;
179 my $line = shift || return;
181 my $id = getid(\$line);
184 print STDERR $sock->{'error'} . $/;
188 my ($time, @values) = split m/:/, $line;
189 return $sock->putval(%$id, time => $time, values => \@values);
192 =item B<PUTVAL> I<Identifier> I<Valuelist>
197 my $sock = shift || return;
198 my $line = shift || return;
200 my $id = getid(\$line);
203 print STDERR $sock->{'error'} . $/;
207 my $vals = $sock->getval(%$id);
210 print STDERR $sock->{'error'} . $/;
214 foreach my $key (keys %$vals) {
215 print "\t$key: $vals->{$key}\n";
220 =item B<FLUSH> [B<timeout>=I<$timeout>] [B<plugin>=I<$plugin>[ ...]]
225 my $sock = shift || return;
231 $res = $sock->flush();
236 foreach my $i (split m/ /, $line) {
237 my ($option, $value) = $i =~ m/^([^=]+)=(.+)$/;
238 next if (! ($option && $value));
240 if ($option eq "plugin") {
241 push @{$args{"plugins"}}, $value;
243 elsif ($option eq "timeout") {
244 $args{"timeout"} = $value;
246 elsif ($option eq "identifier") {
247 my $id = getid (\$value);
250 print STDERR "Not a valid identifier: \"$value\"\n";
253 push @{$args{"identifier"}}, $id;
256 print STDERR "Invalid option \"$option\".\n";
261 $res = $sock->flush(%args);
265 print STDERR $sock->{'error'} . $/;
276 my $sock = shift || return;
280 @res = $sock->listval();
283 print STDERR $sock->{'error'} . $/;
287 foreach my $ident (@res) {
288 print $ident->{'time'} . " " . putid($ident) . $/;
295 These commands follow the exact same syntax as described in
296 L<collectd-unixsock(5)>.
300 L<collectd(1)>, L<collectd-unisock(5)>
304 Written by Sebastian Harl E<lt>sh@tokkee.orgE<gt>.
306 B<collectd> has been written by Florian Forster and others.
310 Copyright (C) 2007 Sebastian Harl.
312 This program is free software; you can redistribute it and/or modify it under
313 the terms of the GNU General Public License as published by the Free Software
314 Foundation; only version 2 of the License is applicable.
318 # vim: set sw=4 ts=4 tw=78 noexpandtab :