From: Sebastian Harl <sh@tokkee.org>
Date: Thu, 27 Sep 2007 16:24:40 +0000 (+0200)
Subject: Added MyPlugin.pm to contrib/examples/.
X-Git-Tag: collectd-4.1.3~4^2~5
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=1ff419f97e259936d93474a0e50551f4e05911a1;p=collectd.git

Added MyPlugin.pm to contrib/examples/.

This is a sample/template Perl plugin.

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

diff --git a/contrib/examples/MyPlugin.pm b/contrib/examples/MyPlugin.pm
new file mode 100644
index 00000000..1b98d5b8
--- /dev/null
+++ b/contrib/examples/MyPlugin.pm
@@ -0,0 +1,125 @@
+# /usr/share/doc/collectd/examples/MyPlugin.pm
+#
+# A Perl plugin template for collectd.
+#
+# Written by Sebastian Harl <sh@tokkee.org>
+#
+# This 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.
+
+# Notes:
+# - each of the functions below (and the corresponding plugin_register call)
+#   is optional
+
+package Collectd::Plugin::MyPlugin;
+
+use strict;
+use warnings;
+
+# data set definition:
+# see section "DATA TYPES" in collectd-perl(5) for details
+my $dataset =
+[
+	{
+		name => 'my_ds',
+		type => Collectd::DS_TYPE_GAUGE,
+		min  => 0,
+		max  => 65535,
+	},
+];
+
+# This code is executed after loading the plugin to register it with collectd.
+Collectd::plugin_register (Collectd::TYPE_LOG, 'myplugin', \&my_log);
+Collectd::plugin_register (Collectd::TYPE_DATASET, 'myplugin', $dataset);
+Collectd::plugin_register (Collectd::TYPE_INIT, 'myplugin', \&my_init);
+Collectd::plugin_register (Collectd::TYPE_READ, 'myplugin', \&my_read);
+Collectd::plugin_register (Collectd::TYPE_WRITE, 'myplugin', \&my_write);
+Collectd::plugin_register (Collectd::TYPE_SHUTDOWN, 'myplugin', \&my_shutdown);
+
+# For each of the functions below see collectd-perl(5) for details about
+# arguments and the like.
+
+# This function is called once upon startup to initialize the plugin.
+sub my_init
+{
+	# open sockets, initialize data structures, ...
+
+	# A false return value indicates an error and causes the plugin to be
+	# disabled.
+	return 1;
+} # my_init ()
+
+# This function is called in regular intervals to collectd the data.
+sub my_read
+{
+	# value list to dispatch to collectd:
+	# see section "DATA TYPES" in collectd-perl(5) for details
+	my $vl = {};
+
+	# do the magic to read the data:
+	# the number of values has to match the number of data sources defined in
+	# the registered data set
+	$vl->{'values'} = [ rand(65535) ];
+	$vl->{'plugin'} = 'myplugin';
+	# any other elements are optional
+
+	# dispatch the values to collectd which passes them on to all registered
+	# write functions - the first argument is used to lookup the data set
+	# definition
+	Collectd::plugin_dispatch_values ('myplugin', $vl);
+
+	# A false return value indicates an error and the plugin will be skipped
+	# for an increasing amount of time.
+	return 1;
+} # my_read ()
+
+# This function is called after values have been dispatched to collectd.
+sub my_write
+{
+	my $type = shift;
+	my $ds   = shift;
+	my $vl   = shift;
+
+	if (scalar (@$ds) != scalar (@{$vl->{'values'}})) {
+		Collectd::plugin_log (Collectd::LOG_WARNING,
+			"DS number does not match values length");
+		return;
+	}
+
+	for (my $i = 0; $i < scalar (@$ds); ++$i) {
+		# do the magic to output the data
+		print "$vl->{'host'}: $vl->{'plugin'}: ";
+
+		if (defined $vl->{'plugin_instance'}) {
+			print "$vl->{'plugin_instance'}: ";
+		}
+
+		print "$type: ";
+
+		if (defined $vl->{'type_instance'}) {
+			print "$vl->{'type_instance'}: ";
+		}
+
+		print "$vl->{'values'}->[$i]\n";
+	}
+	return 1;
+} # my_write()
+
+# This function is called before shutting down collectd.
+sub my_shutdown
+{
+	# close sockets, ...
+	return 1;
+} # my_shutdown ()
+
+# This function is called when plugin_log () has been used.
+sub my_log
+{
+	my $level = shift;
+	my $msg   = shift;
+
+	print "LOG: $level - $msg\n";
+	return 1;
+} # my_log ()
+