From 98cb04f7cbba2a8cf87b88e2fc5f74ba8a0d1900 Mon Sep 17 00:00:00 2001 From: John-John Tedro Date: Sun, 29 Sep 2013 16:48:52 +0000 Subject: [PATCH] [doc] Added documentation for adding of meta information using PUTNOTIF --- src/collectd-exec.pod | 13 +++++++++++++ src/collectd-unixsock.pod | 17 +++++++++++++++-- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/src/collectd-exec.pod b/src/collectd-exec.pod index 2c596302..41f967e9 100644 --- a/src/collectd-exec.pod +++ b/src/collectd-exec.pod @@ -169,6 +169,19 @@ table. All the options are optional, but B without B or B without B doesn't make much sense and should be avoided. +=item BI + +Sets user defined meta information. The B key is a single character +defining the type of the meta information. + +The current supported types are: + +=over 8 + +=item B A string passed as-is. + +=back + =back =back diff --git a/src/collectd-unixsock.pod b/src/collectd-unixsock.pod index 40626d37..7cc6e704 100644 --- a/src/collectd-unixsock.pod +++ b/src/collectd-unixsock.pod @@ -176,11 +176,24 @@ table. All the options are optional, but B without B or B without B doesn't make much sense and should be avoided. -Please note that this is the same format as used in the B, see -L. +=item BI + +Sets user defined meta information. The B key is a single character +defining the type of the meta information. + +The current supported types are: + +=over 8 + +=item B A string passed as-is. =back +=back + +Please note that this is the same format as used in the B, see +L. + Example: -> | PUTNOTIF type=temperature severity=warning time=1201094702 message=The roof is on fire! <- | 0 Success -- 2.11.0