Merge branch 'collectd-4.4' into collectd-4.5

[collectd.git] / contrib / examples / MyPlugin.pm

diff --git a/contrib/examples/MyPlugin.pm b/contrib/examples/MyPlugin.pm
index b852272..13806ee 100644 (file)
--- a/contrib/examples/MyPlugin.pm
+++ b/contrib/examples/MyPlugin.pm
@@ -21,7 +21,12 @@ use Collectd qw( :all );
 
 # data set definition:
 # see section "DATA TYPES" in collectd-perl(5) for details
-# (take a look at the types.db file for a large list of predefined data-sets)
+#
+# NOTE: If you're defining a custom data-set, you have to make that known to
+# any servers as well. Else, the server is not able to store values using the
+# type defined by that data-set.
+# It is strongly recommended to use one of the types and data-sets pre-defined
+# in the types.db file.
 my $dataset =
 [
        {
@@ -34,6 +39,7 @@ my $dataset =
 
 # This code is executed after loading the plugin to register it with collectd.
 plugin_register (TYPE_LOG, 'myplugin', 'my_log');
+plugin_register (TYPE_NOTIF, 'myplugin', 'my_notify');
 plugin_register (TYPE_DATASET, 'myplugin', $dataset);
 plugin_register (TYPE_INIT, 'myplugin', 'my_init');
 plugin_register (TYPE_READ, 'myplugin', 'my_read');
@@ -69,7 +75,8 @@ sub my_read
 
        # 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
+       # definition (it is strongly recommended to use a type defined in the
+       # types.db file)
        plugin_dispatch_values ('myplugin', $vl);
 
        # A false return value indicates an error and the plugin will be skipped
@@ -85,8 +92,7 @@ sub my_write
        my $vl   = shift;
 
        if (scalar (@$ds) != scalar (@{$vl->{'values'}})) {
-               plugin_log (LOG_WARNING,
-                       "DS number does not match values length");
+               plugin_log (LOG_WARNING, "DS number does not match values length");
                return;
        }
 
@@ -126,3 +132,38 @@ sub my_log
        return 1;
 } # my_log ()
 
+# This function is called when plugin_dispatch_notification () has been used
+sub my_notify
+{
+       my $notif = shift;
+
+       my ($sec, $min, $hour, $mday, $mon, $year) = localtime ($notif->{'time'});
+
+       printf "NOTIF (%04d-%02d-%02d %02d:%02d:%02d): %d - ",
+                       $year + 1900, $mon + 1, $mday, $hour, $min, $sec,
+                       $notif->{'severity'};
+
+       if (defined $notif->{'host'}) {
+               print "$notif->{'host'}: ";
+       }
+
+       if (defined $notif->{'plugin'}) {
+               print "$notif->{'plugin'}: ";
+       }
+
+       if (defined $notif->{'plugin_instance'}) {
+               print "$notif->{'plugin_instance'}: ";
+       }
+
+       if (defined $notif->{'type'}) {
+               print "$notif->{'type'}: ";
+       }
+
+       if (defined $notif->{'type_instance'}) {
+               print "$notif->{'type_instance'}: ";
+       }
+
+       print "$notif->{'message'}\n";
+       return 1;
+} # my_notify ()
+