Working mikoomi-mongodb-plugin.php

mikoomi-mongodb-plugin.php

<?php

/**********************************************************************
                       Mikoomi MIT License
**********************************************************************
Copyright (c) 2011 by Jayesh Thakrar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

************************************************************************/

error_reporting(E_PARSE) ;

$options = getopt("Dh:p:z:u:x:") ;
$command_name = basename($argv[0]) ;
$command_version = "0.3" ;

// Get data collection start time (we will use this to compute the total data collection time)
$start_time = time() ;

// At a minimum, we need to get the Zabbix hostname. If not, display usage message.
if (empty($options) or empty($options['z']) ) {
    echo "
$command_name Version $command_version
Usage : $command_name [-D] [-h <mongoDB Server Host>] [-p <mongoDB Port>] [-u <username>] [-x <password>] -z <Zabbix_Name>
where
   -D = Run in detail/debug mode
   -h = Hostname or IP address of server running mongoDBB
   -p = Port number on which to connect to the mongod or mongos process
   -z = Name (hostname) of mongoDB instance or cluster in the Zabbix UI
   -u = User name for database authentication
   -x = Password for database authentication
"  ;

exit ;
}

//-------------------------------------------------------------------------//
// Setup log file, data file and zabbix hostname.
//-------------------------------------------------------------------------//
$zabbix_name = $options['z'] ;

$debug_mode = isset($options['D']) ;

// Log file : contains execution and diagnostic information
$log_file_name = "/tmp/${command_name}_${zabbix_name}.log" ;
$log_file_handle = fopen($log_file_name, 'w') ;
$log_file_data = array() ;

// Data file : contains data to send to Zabbix and corresponds to data items in template
$data_file_name = "/tmp/${command_name}_${zabbix_name}.data" ;
$data_file_handle = fopen($data_file_name, 'w') ;

if (!($data_file_handle)) {
    write_to_log_file("$command_name:There was an error in opening data file $data_file_name\n") ;
    exit ;
}

$md5_checksum_string = md5_file($argv[0]) ;

if ($debug_mode) {
    write_to_log_file("$command_name version $command_version\n") ;
}
//-------------------------------------------------------------------------//

//-------------------------------------------------------------------------//
function write_to_log_file($output_line)
//-------------------------------------------------------------------------//
{
    global $command_name ;
    global $log_file_handle ;
    fwrite($log_file_handle, "$output_line\n") ;
}
//-------------------------------------------------------------------------//



//-------------------------------------------------------------------------//
function debug_output($output_line)
//-------------------------------------------------------------------------//
{
    global $debug_mode ;
    global $command_name ;
    global $log_file_handle ;
    if ($debug_mode) {
        fwrite($log_file_handle, "$output_line\n") ;
    }
}
//-------------------------------------------------------------------------//


//-------------------------------------------------------------------------//
function write_to_data_file($output_line)
//-------------------------------------------------------------------------//
{
    global $data_file_handle ;
    fwrite($data_file_handle, "$output_line\n") ;
}
//-------------------------------------------------------------------------//


//-------------------------------------------------------------------------//
// Now starts the heart of mongoDB monitoring !!
//-------------------------------------------------------------------------//

//-----------------------------
// Setup connection to mongoDB
//-----------------------------
$mongodb_host = empty($options['h']) ? Mongo::DEFAULT_HOST : $options['h'] ;
$mongodb_port = empty($options['p']) ? Mongo::DEFAULT_PORT : $options['p']  ;

if ((!empty($options['u'])) && (!empty($options['x']))) {
    $connect_string = $options['u'] . ':' . $options['x'] . '@' . $mongodb_host . ':' . $mongodb_port  ;
}
else {
    $connect_string = $mongodb_host . ':' . $mongodb_port ;
}

$mongo_connection = new Mongo("mongodb://$connect_string") ;

if (is_null($mongo_connection)) {
    write_to_log_file("$command_name:Error in connection to mongoDB using connect string $connect_string") ;
    exit ;
}
else {
    write_to_log_file("$command_name:Successfully connected to mongoDB using connect string $connect_string") ;
}


//-----------------------------
// Get server statistics
//-----------------------------
$mongo_db_handle = $mongo_connection->selectDB("config") ;

$server_status = $mongo_db_handle->command(array('serverStatus'=>1)) ;

if (!isset($server_status['ok'])) {
    write_to_log_file("$command_name:Error in executing $command.") ;
    exit ;
}

$mongo_version = $server_status['version'] ;
write_to_data_file("$zabbix_name mongodb_version $mongo_version") ;

$uptime = $server_status['uptime'] ;
write_to_data_file("$zabbix_name uptime $uptime") ;

//$globalLock_totalTime = $server_status['globalLock']['totalTime'] ;
//write_to_data_file("$zabbix_name globalLock_totalTime $globalLock_totalTime") ;

$globalLock_lockTime = $server_status['globalLock']['lockTime'] ;
write_to_data_file("$zabbix_name globalLock_lockTime $globalLock_lockTime") ;

$globalLock_currentQueue_total = $server_status['globalLock']['currentQueue']['total'] ;
write_to_data_file("$zabbix_name globalLock_currentQueue_total $globalLock_currentQueue_total") ;

$globalLock_currentQueue_readers = $server_status['globalLock']['currentQueue']['readers'] ;
write_to_data_file("$zabbix_name globalLock_currentQueue_readers $globalLock_currentQueue_readers") ;

$globalLock_currentQueue_writers = $server_status['globalLock']['currentQueue']['writers'] ;
write_to_data_file("$zabbix_name globalLock_currentQueue_writers $globalLock_currentQueue_writers") ;

$mem_bits = $server_status['mem']['bits'] ;
write_to_data_file("$zabbix_name mem_bits $mem_bits") ;

$mem_resident = $server_status['mem']['resident'] ;
write_to_data_file("$zabbix_name mem_resident $mem_resident") ;

$mem_virtual = $server_status['mem']['virtual'] ;
write_to_data_file("$zabbix_name mem_virtual $mem_virtual") ;

$connections_current = $server_status['connections']['current'] ;
write_to_data_file("$zabbix_name connections_current $connections_current") ;

$connections_available = $server_status['connections']['available'] ;
write_to_data_file("$zabbix_name connections_available $connections_available") ;

$extra_info_heap_usage = round(($server_status['extra_info']['heap_usage_bytes'])/(1024*124), 2) ;
write_to_data_file("$zabbix_name extra_info_heap_usage $extra_info_heap_usage") ;

$extra_info_page_faults = $server_status['extra_info']['page_faults'] ;
write_to_data_file("$zabbix_name extra_info_page_faults $extra_info_page_faults") ;

$indexCounters_btree_accesses = $server_status['indexCounters']['btree']['accesses'] ;
write_to_data_file("$zabbix_name indexCounters_btree_accesses $indexCounters_btree_accesses") ;

$indexCounters_btree_hits = $server_status['indexCounters']['btree']['hits'] ;
write_to_data_file("$zabbix_name indexCounters_btree_hits $indexCounters_btree_hits") ;

$indexCounters_btree_misses = $server_status['indexCounters']['btree']['misses'] ;
write_to_data_file("$zabbix_name indexCounters_btree_misses $indexCounters_btree_misses") ;

$indexCounters_btree_resets = $server_status['indexCounters']['btree']['resets'] ;
write_to_data_file("$zabbix_name indexCounters_btree_resets $indexCounters_btree_resets") ;

$indexCounters_btree_missRatio = $server_status['indexCounters']['btree']['missRatio'] ;
write_to_data_file("$zabbix_name indexCounters_btree_missRatio $indexCounters_btree_missRatio") ;

$backgroundFlushing_flushes = $server_status['backgroundFlushing']['flushes'] ;
write_to_data_file("$zabbix_name backgroundFlushing_flushes $backgroundFlushing_flushes") ;

$backgroundFlushing_total_ms = $server_status['backgroundFlushing']['total_ms'] ;
write_to_data_file("$zabbix_name backgroundFlushing_total_ms $backgroundFlushing_total_ms") ;

$backgroundFlushing_average_ms = $server_status['backgroundFlushing']['average_ms'] ;
write_to_data_file("$zabbix_name backgroundFlushing_average_ms $backgroundFlushing_average_ms") ;

$backgroundFlushing_last_ms = $server_status['backgroundFlushing']['last_ms'] ;
write_to_data_file("$zabbix_name backgroundFlushing_last_ms $backgroundFlushing_last_ms") ;

$cursors_totalOpen = $server_status['cursors']['totalOpen'] ;
write_to_data_file("$zabbix_name cursors_totalOpen $cursors_totalOpen") ;

$cursors_clientCursors_size = $server_status['cursors']['clientCursors_size'] ;
write_to_data_file("$zabbix_name cursors_clientCursors_size $cursors_clientCursors_size") ;

$cursors_timedOut = $server_status['cursors']['timedOut'] ;
write_to_data_file("$zabbix_name cursors_timedOut $cursors_timedOut") ;

$opcounters_insert = $server_status['opcounters']['insert'] ;
write_to_data_file("$zabbix_name opcounters_insert $opcounters_insert") ;

$opcounters_query = $server_status['opcounters']['query'] ;
write_to_data_file("$zabbix_name opcounters_query $opcounters_query") ;

$opcounters_update = $server_status['opcounters']['update'] ;
write_to_data_file("$zabbix_name opcounters_update $opcounters_update") ;

$opcounters_delete = $server_status['opcounters']['delete'] ;
write_to_data_file("$zabbix_name opcounters_delete $opcounters_delete") ;

$opcounters_getmore = $server_status['opcounters']['getmore'] ;
write_to_data_file("$zabbix_name opcounters_getmore $opcounters_getmore") ;

$opcounters_command = $server_status['opcounters']['command'] ;
write_to_data_file("$zabbix_name opcounters_command $opcounters_command") ;

$asserts_regular = $server_status['asserts']['regular'] ;
write_to_data_file("$zabbix_name asserts_regular $asserts_regular") ;

$asserts_warning = $server_status['asserts']['warning'] ;
write_to_data_file("$zabbix_name asserts_warning $asserts_warning") ;

$asserts_msg = $server_status['asserts']['msg'] ;
write_to_data_file("$zabbix_name asserts_msg $asserts_msg") ;

$asserts_user = $server_status['asserts']['user'] ;
write_to_data_file("$zabbix_name asserts_user $asserts_user") ;

$asserts_rollovers = $server_status['asserts']['rollovers'] ;
write_to_data_file("$zabbix_name asserts_rollovers $asserts_rollovers") ;

$network_inbound_traffic_mb = ($server_status['network']['bytesIn'])/(1024*1024) ;
write_to_data_file("$zabbix_name network_inbound_traffic_mb $network_inbound_traffic_mb") ;

$network_outbound_traffic_mb = ($server_status['network']['bytesOut'])/(1024*1024) ;
write_to_data_file("$zabbix_name network_outbound_traffic_mb $network_outbound_traffic_mb") ;

$network_requests = $server_status['network']['numRequests'] ;
write_to_data_file("$zabbix_name network_requests $network_requests") ;

$write_backs_queued = $server_status['writeBacksQueued'] ? 1:0 ;
write_to_data_file("$zabbix_name write_backs_queued $write_backs_queued") ;

$logging_commits = $server_status['dur']['commits'] ;
write_to_data_file("$zabbix_name logging_commits $logging_commits") ;

$logging_journal_writes_mb = $server_status['dur']['journaledMB'] ;
write_to_data_file("$zabbix_name logging_journal_writes_mb $logging_journal_writes_mb") ;

$logging_datafile_writes_mb = $server_status['dur']['writeToDataFilesMB'] ;
write_to_data_file("$zabbix_name logging_datafile_writes_mb $logging_datafile_writes_mb") ;

$logging_commits_in_writelock = $server_status['dur']['commitsInWriteLock'] ;
write_to_data_file("$zabbix_name logging_commits_in_writelock $logging_commits_in_writelock") ;

$logging_early_commits = $server_status['dur']['earlyCommits'] ;
write_to_data_file("$zabbix_name logging_early_commits $logging_early_commits") ;

$logging_log_buffer_prep_time_ms = $server_status['dur']['timeMs']['prepLogBuffer'] ;
write_to_data_file("$zabbix_name logging_log_buffer_prep_time_ms $logging_log_buffer_prep_time_ms") ;

$logging_journal_write_time_ms = $server_status['dur']['timeMs']['writeToJournal'] ;
write_to_data_file("$zabbix_name logging_journal_write_time_ms $logging_journal_write_time_ms") ;

$logging_datafile_write_time_ms = $server_status['dur']['timeMs']['writeToDataFiles'] ;
write_to_data_file("$zabbix_name logging_datafile_write_time_ms $logging_datafile_write_time_ms") ;

//-----------------------------
// Get DB list and cumulative DB info
//-----------------------------
$db_list = $mongo_connection->listDBs() ;

$db_count = count($db_list) ;
write_to_data_file("$zabbix_name db_count $db_count") ;

$totalSize = round(($db_list['totalSize'])/(1024*1024), 2) ;
write_to_data_file("$zabbix_name totalSize_mb $totalSize") ;

$sharded_db_count = 0 ;
$total_collection_count = 0 ;
$total_object_count = 0 ;
$total_index_count = 0 ;

$is_sharded = 'No' ;

$db_info_array = '' ;
$db_info_collections = '' ;
$db_info_objects = '' ;
$db_info_indexes = '' ;
$db_info_avgObjSize = '' ;
$db_info_dataSize = '' ;
$db_info_indexSize = '' ;
$db_info_storageSize = '' ;
$db_info_numExtents_array = '' ;
$db_info_fileSize = '' ;


foreach($db_list['databases'] as $db) {
    if(isset($db['shards'])) {
        $is_sharded = 'Yes' ;
    }
    else {
       // Do nothing !
    }

    $mongo_db_handle = $mongo_connection->selectDB($db['name']) ;
    $db_stats = $mongo_db_handle->command(array('dbStats'=>1)) ;

    $execute_status = $db_stats['ok'] ;

    if ($execute_status == 0) {
        write_to_log_file("$command_name:Error in executing $command for database".$db['name']) ;
        exit ;
    }

    $total_collection_count += $db_stats['collections'] ;
    $total_object_count += $db_stats['objects'] ;
    $total_index_count += $db_stats['indexes'] ;

    $db_info_array[$db['name']] .= ' collections=' . $db_stats['collections'] .
                                  ', objects=' . $db_stats['objects'] .
                                  ', indexes=' . $db_stats['indexes']  .
                                  ', avgObjSize=' . $db_stats['avgObjSize']  .
                                  ', dataSize=' . $db_stats['dataSize']  .
                                  ', indexSize=' . $db_stats['indexSize']  .
                                  ', storageSize=' . $db_stats['storageSize']  .
                                  ', numExtents=' . $db_stats['numExtents']  .
                                  ', fileSize=' . $db_stats['fileSize']  ;

    $db_info_collections .= $db['name'] . '=' . $db_stats['collections'] . ' || ' ;
    $db_info_objects .= $db['name'] . '=' . $db_stats['objects'] . ' || ' ;
    $db_info_indexes .= $db['name'] . '=' . $db_stats['indexes'] . ' || ' ;
    $db_info_avgObjSize .= $db['name'] . '=' . $db_stats['avgObjSize'] . ' || ';
    $db_info_dataSize .= $db['name'] . '=' . $db_stats['dataSize'] . ' || ';
    $db_info_indexSize .= $db['name'] . '=' . $db_stats['indexSize'] . ' || ';
    $db_info_storageSize .= $db['name'] . '=' . $db_stats['storageSize'] . ' || ';
    $db_info_numExtents_array .= $db['name'] . '=' . $db_stats['numExtents'] . ' || ';
    $db_info_fileSize .= $db['name'] . '=' . $db_stats['fileSize'] . ' || ';
}

foreach($db_info_array as $key=>$value) {
   $db_info .= $key . ':' . $value . ' || ' ;
}

write_to_data_file("$zabbix_name database_info $db_info") ;

write_to_data_file("$zabbix_name is_sharded $is_sharded") ;

write_to_data_file("$zabbix_name total_collection_count $total_collection_count") ;

write_to_data_file("$zabbix_name total_object_count $total_object_count") ;

write_to_data_file("$zabbix_name total_index_count $total_index_count") ;

write_to_data_file("$zabbix_name db_collections $db_info_collections") ;
write_to_data_file("$zabbix_name db_objects $db_info_objects") ;
write_to_data_file("$zabbix_name db_indexes $db_info_indexes") ;
write_to_data_file("$zabbix_name db_avgObjSize $db_info_avgObjSize") ;
write_to_data_file("$zabbix_name db_dataSize $db_info_dataSize") ;
write_to_data_file("$zabbix_name db_indexSize $db_info_indexSize") ;
write_to_data_file("$zabbix_name db_storageSize $db_info_storageSize") ;
write_to_data_file("$zabbix_name db_numExtents $db_info_numExtents_array") ;
write_to_data_file("$zabbix_name db_fileSize $db_info_fileSize") ;


//-----------------------------
// Check for replication / replicaSets
//-----------------------------
if ($is_sharded == 'No') {
   $mongo_db_handle = $mongo_connection->selectDB('admin') ;
   $rs_status = $mongo_db_handle->command(array('replSetGetStatus'=>1)) ;

   if (!($rs_status)) {
       write_to_data_file("$zabbix_name is_replica_set No") ;
   }
   else {
       write_to_data_file("$zabbix_name is_replica_set Yes") ;
       write_to_data_file("$zabbix_name replica_set_name ".$rs_status['set']) ;
       write_to_data_file("$zabbix_name replica_set_member_count " . count($rs_status['members']) )  ;
   
       foreach ($rs_status['members'] as $repl_set_member) {
           $repl_set_member_names .= 'host#' . $repl_set_member['_id'] . ' = ' . $repl_set_member['name'] . ' || ' ;
       }
       write_to_data_file("$zabbix_name replica_set_hosts " . $repl_set_member_names)  ;
   
       //$col_name = "oplog.rs" ;
       //$mongo_collection = $mongo_db_handle->$t ;
       //echo "aaa\n" ;
       //$rs_status = $mongo_collection->count() ;
       //echo "aaa\n" ;
       //write_to_data_file("$zabbix_name oplog.rs_count " . $rs_status)  ;
   
       //$rs_status = $mongo_db_handle->execute("$command") ;
       $repl_member_attention_state_count = 0 ;
       $repl_member_attenntion_state_info = '' ;
       foreach($rs_status['members'] as $member) {
           $member_state = $member['state'] ;
           if($member_state == 0 or $member_state == 3 or $member_state == 4 or $member_state == 5 or $member_state == 6 or $member_state == 8) {
               // 0 = Starting up, phase 1
               // 1 = primary
               // 2 = secondary
               // 3 = recovering
               // 4 = fatal error
               // 5 = starting up, phase 2
               // 6 = unknown state
               // 7 = arbiter
       echo "aaa\n" ;
               // 8 = down
               $repl_member_attention_state_count++ ;
               switch ($member_state) {
                   case 0: $member_state = 'starting up, phase 1' ;
                           break ;
                   case 3: $member_state = 'recovering' ;
                           break ;
                   case 4: $member_state = 'fatal error' ;
                           break ;
                   case 5: $member_state = 'starting up, phase 2' ;
                           break ;
                   case 6: $member_state = 'unknown' ;
                           break ;
                   case 8: $member_state = 'down' ;
                           break ;
                   default: $member_state = 'unknown' ;
                           break ;
               }
               $repl_member_attention_state_info .= $member['name'] . ' is in state ' . $member_state . ' ||' ;
           }
       }
       write_to_data_file("$zabbix_name repl_member_attention_state_count " . $repl_member_attention_state_count) ;
       write_to_data_file("$zabbix_name repl_member_attention_state_info " . ($repl_member_attention_state_count > 0 ? $repl_member_attention_state_info : 'empty') ) ;
   }

}

//-----------------------------
// Check for sharding
//-----------------------------
if ($is_sharded == 'Yes') {
    $mongo_db_handle = $mongo_connection->selectDB('config') ;

    $mongo_collection = $mongo_db_handle->chunks ;
    $shard_info = $mongo_collection->count() ;
    write_to_data_file("$zabbix_name shard_chunk_count " . $shard_info) ;

    $mongo_collection = $mongo_db_handle->collections ;
    $shard_info = $mongo_collection->count() ;
    write_to_data_file("$zabbix_name sharded_collections_count " . $shard_info) ;

    $collection = $mongo_connection->selectDB('config')->selectCollection('collections') ;
    $cursor = $collection->find() ;
    $collection_array = iterator_to_array($cursor) ;
    $collection_info = '' ;
    foreach ($collection_array as $shard) {
        $collection_info .= $shard['_id'] . ' || ' ;
    }
    write_to_data_file("$zabbix_name sharded_collection_info " . $collection_info) ;


    $command = "db.shards.count" ;
    $mongo_collection = $mongo_db_handle->shards ;
    $shard_info = $mongo_collection->count() ;
    write_to_data_file("$zabbix_name shard_count " . $shard_info) ;

    $collection = $mongo_connection->selectDB('config')->selectCollection('shards') ;
    $cursor = $collection->find() ;
    $shards_array = iterator_to_array($cursor) ;
    $shard_info = '' ;
    foreach ($shards_array as $shard) {
        $shard_info .= $shard['_id'] . ' = ' . $shard['host'] . ' || ' ;
    }
    write_to_data_file("$zabbix_name shard_info " . $shard_info) ;

    $collection = $mongo_connection->selectDB('config')->selectCollection('databases') ;
    $cursor = $collection->find() ;
    $db_array = iterator_to_array($cursor) ;
    $db_info = '' ;
    foreach ($db_array as $db) {
        if( $db['partitioned'] ) {
            $partitioned = 'yes' ;
        }
        else {
            $partitioned = 'no' ;
        }
        $db_info .= $db['_id'] . ' : ' . 'partitioned = ' . $partitioned . ', primary = ' . $db['primary'] . ' || ' ;
    }
    write_to_data_file("$zabbix_name db_info " . $db_info) ;


}

//-------------------------------------------------------------------------//

$db = $mongo_connection->local;
$collectionName = "oplog.rs";
$co = $db->$collectionName;
$oplog_rs_count = $co->count();
write_to_data_file("$zabbix_name oplog_rs_count " . $oplog_rs_count);


// Get data collection end time (we will use this to compute the total data collection time)
$end_time = time() ;
$data_collection_time = $end_time - $start_time ;
write_to_data_file("$zabbix_name mongoDB_plugin_data_collection_time $data_collection_time") ;

write_to_data_file("$zabbix_name mongoDB_plugin_version $command_version") ;
write_to_data_file("$zabbix_name mongoDB_plugin_checksum $md5_checksum_string") ;

fclose($data_file_handle) ;

exec("zabbix_sender -vv -z 127.0.0.1 -i $data_file_name 2>&1", $log_file_data) ;

foreach ($log_file_data as $log_line) {
    write_to_log_file("$log_line\n") ;
}

fclose($log_file_handle) ;

exit ;

?>