Added "server-id" option to MySQL template, rewritten parse_cmdline() in ss_get_mysql_stats.php.

Author: roman-vynar

Changelog

@@ -1,6 +1,8 @@
-2013-11-20: version 1.1
+2013-11-26: version 1.1
 -------------------------
 * Added MySQL template for Zabbix 2.0.x (first release)
+* Added FreeBSD support to Nagios plugins, partially rewritten pmp-check-unix-memory (bugs 1249575, 1244081)
+* Added new options to ss_get_mysql_stats.php to better support pt-heartbeat (bugs 1253125, 1253130)
 * sql query for idle_blocker_duraction check in pmp-check-mysql-innodb did not conform sql mode of ONLY_FULL_GROUP_BY (bug #1240417)
 
 2013-10-02: version 1.0.5

cacti/definitions/mysql.def

@@ -3339,7 +3339,7 @@
       'Get MySQL Stats' => {
          hash         => 'hash_03_VER_436e47b578d778e94d10a552d7d35bdf',
          input_string =>
-            '<path_php_binary> -q <path_cacti>/scripts/ss_get_mysql_stats.php --host <hostname> --items <items> --user <username> --pass <password> --port <port>',
+            '<path_php_binary> -q <path_cacti>/scripts/ss_get_mysql_stats.php --host <hostname> --items <items> --user <username> --pass <password> --port <port> --server-id <server-id>',
          inputs => [
             {  allow_nulls => '',
                hash        => 'hash_07_VER_c8cef6437d22aa62790728f605a68d8e',
@@ -3357,6 +3357,10 @@
                hash        => 'hash_07_VER_0dde201d3dde810ddb9eeed6b444bf50',
                name        => 'password',
             },
+            {  allow_nulls => 'on',
+               hash        => 'hash_07_VER_5a1b802ba7e92609f8aa2b0521e221e1',
+               name        => 'server-id'
+            },
          ],
          outputs => {
             Aborted_clients  => 'hash_07_VER_89a607a1bcd6416e464ad38245fecfd8',

cacti/scripts/ss_get_mysql_stats.php

@@ -166,6 +166,11 @@ function array_change_key_case($arr) {
 function validate_options($options) {
    debug($options);
    $opts = array('host', 'items', 'user', 'pass', 'nocache', 'port', 'server-id');
+   # Show help
+   if ( array_key_exists('help', $options) ) {
+      usage('');
+   }
+
    # Required command-line options
    foreach ( array('host', 'items') as $option ) {
       if ( !isset($options[$option]) || !$options[$option] ) {
@@ -190,12 +195,13 @@ function usage($message) {
 Usage: php ss_get_mysql_stats.php --host <host> --items <item,...> [OPTION]
 
    --host      MySQL host
-   --port      MySQL port; defaults to $mysql_port if not given
    --items     Comma-separated list of the items whose data you want
    --user      MySQL username; defaults to $mysql_user if not given
    --pass      MySQL password; defaults to $mysql_pass if not given
+   --port      MySQL port; defaults to $mysql_port if not given
    --server-id Server id to associate with a heartbeat if heartbeat usage is enabled
    --nocache   Do not cache results in a file
+   --help      Show usage
 
 EOF;
    die($usage);
@@ -206,39 +212,19 @@ function usage($message) {
 # return them as an array ( arg => value )
 # ============================================================================
 function parse_cmdline( $args ) {
-   $result = array();
-   $cur_arg = '';
-   foreach ($args as $val) {
-      if ( strpos($val, '--') === 0 ) {
-         if ( strpos($val, '--no') === 0 ) {
-            # It's an option without an argument, but it's a --nosomething so
-            # it's OK.
-            $result[substr($val, 2)] = 1;
-            $cur_arg = '';
+   $options = array();
+   while (list($tmp, $p) = each($args)) {
+      if (strpos($p, '--') === 0) {
+         $param = substr($p, 2);
+         $value = null;
+         $nextparam = current($args);
+         if ($nextparam !== false && strpos($nextparam, '--') !==0) {
+            list($tmp, $value) = each($args);
          }
-         elseif ( $cur_arg ) { # Maybe the last --arg was an option with no arg
-            if ( $cur_arg == '--user' || $cur_arg == '--pass' || $cur_arg == '--port' ) {
-               # Special case because Cacti will pass these without an arg
-               $cur_arg = '';
-            }
-            else {
-               die("No arg: $cur_arg\n");
-            }
-         }
-         else {
-            $cur_arg = $val;
-         }
-      }
-      else {
-         $result[substr($cur_arg, 2)] = $val;
-         $cur_arg = '';
+         $options[$param] = $value;
       }
    }
-   if ( $cur_arg && ($cur_arg != '--user' && $cur_arg != '--pass' && $cur_arg != '--port') ) {
-      die("No arg: $cur_arg\n");
-   }
-   debug($result);
-   return $result;
+   return $options;
 }
 
 # ============================================================================
@@ -283,7 +269,7 @@ function ss_get_mysql_stats( $options ) {
 
    # First, check the cache.
    $fp = null;
-   if ( !isset($options['nocache']) ) {
+   if ( !array_key_exists('nocache', $options) ) {
       if ( $fp = fopen($cache_file, 'a+') ) {
          $locked = flock($fp, 1); # LOCK_SH
          if ( $locked ) {
@@ -315,14 +301,17 @@ function ss_get_mysql_stats( $options ) {
             }
          }
          else {
-            debug("Couldn't lock the cache file, ignoring it.");
             $fp = null;
+            debug("Couldn't lock the cache file, ignoring it");
          }
       }
+      else {
+         $fp = null;
+         debug("Couldn't open the cache file");
+      }
    }
    else {
-      $fp = null;
-      debug("Couldn't open the cache file");
+      debug("Not using the cache file");
    }
 
    # Set up variables.

docs/cacti/installing-templates.rst

@@ -185,17 +185,18 @@ PHP variables, but it is also possible to pass command-line arguments to the
 scripts.  If you execute the script without any options, you'll see the
 available options.  For example::
 
-   php ss_get_mysql_stats.php
+   # php ss_get_mysql_stats.php                            
    Required option --host is missing
    Usage: php ss_get_mysql_stats.php --host <host> --items <item,...> [OPTION]
 
       --host      MySQL host
-      --port      MySQL port; defaults to 3306 if not given
       --items     Comma-separated list of the items whose data you want
       --user      MySQL username; defaults to cactiuser if not given
       --pass      MySQL password; defaults to cactiuser if not given
+      --port      MySQL port; defaults to 3306 if not given
       --server-id Server id to associate with a heartbeat if heartbeat usage is enabled
       --nocache   Do not cache results in a file
+      --help      Show usage
 
 You can make Cacti pass configuration options to the script with these
 command-line options when it executes the script.  To do this, you will need to

t/cacti/mysql_stats.php

@@ -3,6 +3,26 @@
 require('../../cacti/scripts/ss_get_mysql_stats.php');
 $debug = true;
 
+is_deeply(parse_cmdline(explode(' ', '--host localhost --items jg,jh,ji,jj,jk --user  --pass  --port  --server-id 101')),
+          array('host' => 'localhost',
+                'items' => 'jg,jh,ji,jj,jk',
+                'user' => '',
+                'pass' => '',
+                'port' => '',
+                'server-id' => '101'),
+          'parse_cmdline "--host localhost --items jg,jh,ji,jj,jk --user  --pass  --port  --server-id 101"'
+);
+
+is_deeply(parse_cmdline(explode(' ', '--host localhost --items gg --user  --pass  --port 3341 --server-id ')),
+          array('host' => 'localhost',
+                'items' => 'gg',
+                'user' => '',
+                'pass' => '',
+                'port' => '3341',
+                'server-id' => ''),
+          'parse_cmdline "--host localhost --items gg --user  --pass  --port 3341 --server-id "' 
+);
+
 is(
    make_bigint('0', '1170663853'),
    '1170663853',