From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Tue, 21 Jul 2009 06:09:29 +0000 (+0200)
Subject: collectd.conf(5), collectd.conf.in: Add the FreeSWITCH plugin.
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=70ed224ef14e48a164e20653f73725e57210b141;p=collectd.git

collectd.conf(5), collectd.conf.in: Add the FreeSWITCH plugin.
---

diff --git a/src/collectd.conf.in b/src/collectd.conf.in
index 0f01f4e5..20459244 100644
--- a/src/collectd.conf.in
+++ b/src/collectd.conf.in
@@ -70,6 +70,7 @@ FQDNLookup   true
 #@BUILD_PLUGIN_ENTROPY_TRUE@LoadPlugin entropy
 #@BUILD_PLUGIN_EXEC_TRUE@LoadPlugin exec
 #@BUILD_PLUGIN_FILECOUNT_TRUE@LoadPlugin filecount
+#@BUILD_PLUGIN_FREESWITCH_TRUE@LoadPlugin freeswitch
 #@BUILD_PLUGIN_FSCACHE_TRUE@LoadPlugin fscache
 #@BUILD_PLUGIN_GMOND_TRUE@LoadPlugin gmond
 #@BUILD_PLUGIN_HDDTEMP_TRUE@LoadPlugin hddtemp
@@ -284,6 +285,21 @@ FQDNLookup   true
 #	</Directory>
 #</Plugin>
 
+#<Plugin freeswitch>
+#  Host "127.0.0.1"
+#  Port "8021"
+#  Password "ClueCon"
+#  <Command "api sofia status profile res-public">
+#    Instance "profile-sofia-res-public"
+#    <Match>
+#      Instance "calls-in"
+#      Regex "CALLS-IN\\s+([0-9]+)"
+#      DSType "GaugeLast"
+#      Type "gauge"
+#    </Match>
+#  </Command>
+#</Plugin>
+
 #<Plugin "gmond">
 #  MCReceiveFrom "239.2.11.71" "8649"
 #  <Metric "swap_total">
diff --git a/src/collectd.conf.pod b/src/collectd.conf.pod
index e401d42a..6081f4a8 100644
--- a/src/collectd.conf.pod
+++ b/src/collectd.conf.pod
@@ -1066,6 +1066,73 @@ Controls whether or not to recurse into subdirectories. Enabled by default.
 
 =back
 
+=head2 Plugin C<freeswitch>
+
+The I<freeswitch> plugin connects to the management port of the FreeSWITCH
+daemon and issues commands periodically. The returned output can be parsed
+using the "matches" framework, used for example in the I<cURL> and I<tail>
+plugins.
+
+Synopsis:
+
+ <Plugin freeswitch>                                                                    
+   Host "127.0.0.1"                                                               
+   Port "8021"                                                                    
+   Password "ClueCon"                                                                 
+   <Command "api sofia status profile res-public">                                
+     Instance "profile-sofia-res-public"                                    
+     <Match>                                                                
+       Instance "calls-in"                                            
+       Regex "CALLS-IN\\s+([0-9]+)"                                   
+       DSType "GaugeLast"                                             
+       Type "gauge"                                                   
+     </Match>                                                               
+   </Command>                                                                     
+ </Plugin>                                                                              
+
+Available configuration options:
+
+=over 4
+
+=item B<Host> I<Hostname>
+
+Specifies the hostname or IP-address to connect to. Defaults to "127.0.0.1".
+
+=item B<Port> I<Port>
+
+Specifies the service name or port to connect to. Must be given as a string,
+even when the port is configured in its numeric form! Defaults to "8021".
+
+=item B<Password> I<Password>
+
+Specifies the password to use when connecting.
+
+=item B<Command> I<Command>
+
+B<Command> blocks configure the command to issue every I<interval> seconds and
+how to parse the returned information. The block opening contains the
+I<command> while the block body holds the match configuration.
+
+Inside the B<E<lt>CommandE<nbsp>/E<gt>> block the following configuration
+options are recognized:
+
+=over 4
+
+=item B<Instance> I<Instance>
+
+Sets the plugin instance to use for values returned by the following matches.
+
+=item B<Match>
+
+Each B<Command> block contains one or more B<Match> blocks which specify how to
+parse the output returned by the daemon. The infrastructure and configuration
+used here is exactly identical to the I<tail> plugin. Please see
+L<Plugin C<tail>> for a detailed description of these blocks.
+
+=back
+
+=back
+
 =head2 Plugin C<gmond>
 
 The I<gmond> plugin received the multicast traffic sent by B<gmond>, the