source: branches/0.4/jobmond/jobmond.py @ 784

Last change on this file since 784 was 784, checked in by ramonb, 9 years ago
  • more error checking if the config file exists and is readable
  • Property svn:executable set to *
  • Property svn:keywords set to Id
File size: 57.8 KB
Line 
1#!/usr/bin/env python
2#
3# This file is part of Jobmonarch
4#
5# Copyright (C) 2006-2013  Ramon Bastiaans
6# Copyright (C) 2007, 2009  Dave Love  (SGE code)
7#
8# Jobmonarch is free software; you can redistribute it and/or modify
9# it under the terms of the GNU General Public License as published by
10# the Free Software Foundation; either version 2 of the License, or
11# (at your option) any later version.
12#
13# Jobmonarch is distributed in the hope that it will be useful,
14# but WITHOUT ANY WARRANTY; without even the implied warranty of
15# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16# GNU General Public License for more details.
17#
18# You should have received a copy of the GNU General Public License
19# along with this program; if not, write to the Free Software
20# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21#
22# SVN $Id: jobmond.py 784 2013-04-04 14:01:03Z ramonb $
23#
24
25# vi :set ts=4
26
27import sys, getopt, ConfigParser, time, os, socket, string, re
28import xdrlib, socket, syslog, xml, xml.sax, shlex, os.path
29from xml.sax.handler import feature_namespaces
30from collections import deque
31from glob import glob
32
33VERSION='0.4+SVN'
34
35def usage( ver ):
36
37    print 'jobmond %s' %VERSION
38
39    if ver:
40        return 0
41
42    print
43    print 'Purpose:'
44    print '  The Job Monitoring Daemon (jobmond) reports batch jobs information and statistics'
45    print '  to Ganglia, which can be viewed with Job Monarch web frontend'
46    print
47    print 'Usage:    jobmond [OPTIONS]'
48    print
49    print '  -c, --config=FILE    The configuration file to use (default: /etc/jobmond.conf)'
50    print '  -p, --pidfile=FILE    Use pid file to store the process id'
51    print '  -h, --help        Print help and exit'
52    print '  -v, --version      Print version and exit'
53    print
54
55def processArgs( args ):
56
57    SHORT_L      = 'p:hvc:'
58    LONG_L       = [ 'help', 'config=', 'pidfile=', 'version' ]
59
60    global PIDFILE, JOBMOND_CONF
61    PIDFILE      = None
62
63    JOBMOND_CONF = '/etc/jobmond.conf'
64
65    try:
66
67        opts, args    = getopt.getopt( args, SHORT_L, LONG_L )
68
69    except getopt.GetoptError, detail:
70
71        print detail
72        usage()
73        sys.exit( 1 )
74
75    for opt, value in opts:
76
77        if opt in [ '--config', '-c' ]:
78       
79            JOBMOND_CONF = value
80
81        if opt in [ '--pidfile', '-p' ]:
82
83            PIDFILE      = value
84       
85        if opt in [ '--help', '-h' ]:
86 
87            usage( False )
88            sys.exit( 0 )
89
90        if opt in [ '--version', '-v' ]:
91
92            usage( True )
93            sys.exit( 0 )
94
95    return loadConfig( JOBMOND_CONF )
96
97class GangliaConfigParser:
98
99    def __init__( self, filename ):
100
101        self.conf_lijst   = [ ]
102        self.conf_dict    = { }
103        self.filename     = filename
104        self.file_pointer = file( filename, 'r' )
105        self.lexx         = shlex.shlex( self.file_pointer )
106        self.lexx.whitespace_split = True
107
108        self.parse()
109
110    def __del__( self ):
111
112        """
113        Cleanup: close file descriptor
114        """
115
116        self.file_pointer.close()
117        del self.lexx
118        del self.conf_lijst
119
120    def removeQuotes( self, value ):
121
122        clean_value = value
123        clean_value = clean_value.replace( "'", "" )
124        clean_value = clean_value.replace( '"', '' )
125        clean_value = clean_value.strip()
126
127        return clean_value
128
129    def removeBraces( self, value ):
130
131        clean_value = value
132        clean_value = clean_value.replace( "(", "" )
133        clean_value = clean_value.replace( ')', '' )
134        clean_value = clean_value.strip()
135
136        return clean_value
137
138    def parse( self ):
139
140        """
141        Parse self.filename using shlex scanning.
142        - Removes /* comments */
143        - Traverses (recursively) through all include () statements
144        - Stores complete valid config tokens in self.conf_list
145
146        i.e.:
147            ['globals',
148             '{',
149             'daemonize',
150             '=',
151             'yes',
152             'setuid',
153             '=',
154             'yes',
155             'user',
156             '=',
157             'ganglia',
158             'debug_level',
159             '=',
160             '0',
161             <etc> ]
162        """
163
164        t = 'bogus'
165        c = False
166        i = False
167
168        while t != self.lexx.eof:
169            #print 'get token'
170            t = self.lexx.get_token()
171
172            if len( t ) >= 2:
173
174                if len( t ) >= 4:
175
176                    if t[:2] == '/*' and t[-2:] == '*/':
177
178                        #print 'comment line'
179                        #print 'skipping: %s' %t
180                        continue
181
182                if t == '/*' or t[:2] == '/*':
183                    c = True
184                    #print 'comment start'
185                    #print 'skipping: %s' %t
186                    continue
187
188                if t == '*/' or t[-2:] == '*/':
189                    c = False
190                    #print 'skipping: %s' %t
191                    #print 'comment end'
192                    continue
193
194            if c:
195                #print 'skipping: %s' %t
196                continue
197
198            if t == 'include':
199                i = True
200                #print 'include start'
201                #print 'skipping: %s' %t
202                continue
203
204            if i:
205
206                #print 'include start: %s' %t
207
208                t2 = self.removeQuotes( t )
209                t2 = self.removeBraces( t )
210
211                for in_file in glob( self.removeQuotes(t2) ):
212
213                    #print 'including file: %s' %in_file
214                    parse_infile = GangliaConfigParser( in_file )
215
216                    self.conf_lijst = self.conf_lijst + parse_infile.getConfLijst()
217
218                    del parse_infile
219
220                i = False
221                #print 'include end'
222                #print 'skipping: %s' %t
223                continue
224
225            #print 'keep: %s' %t
226            self.conf_lijst.append( self.removeQuotes(t) )
227
228    def getConfLijst( self ):
229
230        return self.conf_lijst
231
232    def confListToDict( self, parent_list=None ):
233
234        """
235        Recursively traverses a conf_list and creates dictionary from it
236        """
237
238        new_dict = { }
239        count    = 0
240        skip     = 0
241
242        if not parent_list:
243            parent_list = self.conf_lijst
244
245        #print 'entering confListToDict(): (parent) list size %s' %len(parent_list)
246
247        for n, c in enumerate( parent_list ):
248
249            count = count + 1
250
251            #print 'CL: n %d c %s' %(n, c)
252
253            if skip > 0:
254
255                #print '- skipped'
256                skip = skip - 1
257                continue
258
259            if (n+1) <= (len( parent_list )-1):
260
261                if parent_list[(n+1)] == '{':
262
263                    if not new_dict.has_key( c ):
264                        new_dict[ c ] = [ ]
265
266                    (temp_new_dict, skip) = self.confListToDict( parent_list[(n+2):] )
267                    new_dict[ c ].append( temp_new_dict )
268
269                if parent_list[(n+1)] == '=' and (n+2) <= (len( parent_list )-1):
270
271                    if not new_dict.has_key( c ):
272                        new_dict[ c ] = [ ]
273
274                    new_dict[ c ].append( parent_list[ (n+2) ] )
275
276                    skip = 2
277
278                if parent_list[n] == '}':
279
280                    #print 'leaving confListToDict(): new dict = %s' %new_dict
281                    return (new_dict, count)
282
283    def makeConfDict( self ):
284
285        """
286        Walks through self.conf_list and creates a dictionary based upon config values
287
288        i.e.:
289            'tcp_accept_channel': [{'acl': [{'access': [{'action': ['"allow"'],
290                                                         'ip': ['"127.0.0.1"'],
291                                                         'mask': ['32']}]}],
292                                    'port': ['8649']}],
293            'udp_recv_channel': [{'port': ['8649']}],
294            'udp_send_channel': [{'host': ['145.101.32.3'],
295                                  'port': ['8649']},
296                                 {'host': ['145.101.32.207'],
297                                  'port': ['8649']}]}
298        """
299
300        new_dict = { }
301        skip     = 0
302
303        #print 'entering makeConfDict()'
304
305        for n, c in enumerate( self.conf_lijst ):
306
307            #print 'M: n %d c %s' %(n, c)
308
309            if skip > 0:
310
311                #print '- skipped'
312                skip = skip - 1
313                continue
314
315            if (n+1) <= (len( self.conf_lijst )-1):
316
317                if self.conf_lijst[(n+1)] == '{':
318
319                    if not new_dict.has_key( c ):
320                        new_dict[ c ] = [ ]
321
322                    ( temp_new_dict, skip ) = self.confListToDict( self.conf_lijst[(n+2):] )
323                    new_dict[ c ].append( temp_new_dict )
324
325                if self.conf_lijst[(n+1)] == '=' and (n+2) <= (len( self.conf_lijst )-1):
326
327                    if not new_dict.has_key( c ):
328                        new_dict[ c ] = [ ]
329
330                    new_dict[ c ].append( self.conf_lijst[ (n+2) ] )
331
332                    skip = 2
333
334        self.conf_dict = new_dict
335        #print 'leaving makeConfDict(): conf dict size %d' %len( self.conf_dict )
336
337    def checkConfDict( self ):
338
339        if len( self.conf_lijst ) == 0:
340
341            raise Exception("Something went wrong generating conf list for %s" %self.file_name )
342
343        if len( self.conf_dict ) == 0:
344
345            self.makeConfDict()
346
347    def getConfDict( self ):
348
349        self.checkConfDict()
350        return self.conf_dict
351
352    def getUdpSendChannels( self ):
353
354        self.checkConfDict()
355
356        udp_send_channels = [ ] # IP:PORT
357
358        if not self.conf_dict.has_key( 'udp_send_channel' ):
359            return None
360
361        for u in self.conf_dict[ 'udp_send_channel' ]:
362
363            if u.has_key( 'mcast_join' ):
364
365                ip = u['mcast_join'][0]
366
367            elif u.has_key( 'host' ):
368
369                ip = u['host'][0]
370
371            port = u['port'][0]
372
373            udp_send_channels.append( ( ip, port ) )
374
375        if len( udp_send_channels ) == 0:
376            return None
377
378        return udp_send_channels
379
380    def getSectionLastOption( self, section, option ):
381
382        """
383        Get last option set in a config section that could be set multiple times in multiple (include) files.
384
385        i.e.: getSectionLastOption( 'globals', 'send_metadata_interval' )
386        """
387
388        self.checkConfDict()
389        value = None
390
391        if not self.conf_dict.has_key( section ):
392
393            return None
394
395        # Could be set multiple times in multiple (include) files: get last one set
396        for c in self.conf_dict[ section ]:
397
398                if c.has_key( option ):
399
400                    value = c[ option ][0]
401
402        return value
403
404    def getClusterName( self ):
405
406        return self.getSectionLastOption( 'cluster', 'name' )
407
408    def getVal( self, section, option ):
409
410        return self.getSectionLastOption( section, option )
411
412    def getInt( self, section, valname ):
413
414        value    = self.getVal( section, valname )
415
416        if not value:
417            return None
418
419        return int( value )
420
421    def getStr( self, section, valname ):
422
423        value    = self.getVal( section, valname )
424
425        if not value:
426            return None
427
428        return str( value )
429
430def findGmetric():
431
432    for dir in os.path.expandvars( '$PATH' ).split( ':' ):
433
434        guess    = '%s/%s' %( dir, 'gmetric' )
435
436        if os.path.exists( guess ):
437
438            return guess
439
440    return False
441
442def loadConfig( filename ):
443
444    def getlist( cfg_string ):
445
446        my_list = [ ]
447
448        for item_txt in cfg_string.split( ',' ):
449
450            sep_char = None
451
452            item_txt = item_txt.strip()
453
454            for s_char in [ "'", '"' ]:
455
456                if item_txt.find( s_char ) != -1:
457
458                    if item_txt.count( s_char ) != 2:
459
460                        print 'Missing quote: %s' %item_txt
461                        sys.exit( 1 )
462
463                    else:
464
465                        sep_char = s_char
466                        break
467
468            if sep_char:
469
470                item_txt = item_txt.split( sep_char )[1]
471
472            my_list.append( item_txt )
473
474        return my_list
475
476    if not os.path.isfile( JOBMOND_CONF ):
477
478        print "Is not a file or does not exist: '%s'" %JOBMOND_CONF
479        sys.exit( 1 )
480
481    try:
482        f = open( JOBMOND_CONF, 'r' )
483    except IOError, detail:
484        print "Cannot read config file: '%s'" %JOBMOND_CONF
485        sys.exit( 1 )
486    else:
487        f.close()
488
489    cfg        = ConfigParser.ConfigParser()
490
491    cfg.read( filename )
492
493    global DEBUG_LEVEL, DAEMONIZE, BATCH_SERVER, BATCH_POLL_INTERVAL
494    global GMOND_CONF, DETECT_TIME_DIFFS, BATCH_HOST_TRANSLATE
495    global BATCH_API, QUEUE, GMETRIC_TARGET, USE_SYSLOG
496    global SYSLOG_LEVEL, SYSLOG_FACILITY, GMETRIC_BINARY
497    global METRIC_MAX_VAL_LEN, GMOND_UDP_SEND_CHANNELS
498
499    DEBUG_LEVEL = cfg.getint( 'DEFAULT', 'DEBUG_LEVEL' )
500
501    DAEMONIZE   = cfg.getboolean( 'DEFAULT', 'DAEMONIZE' )
502
503    SYSLOG_LEVEL    = -1
504    SYSLOG_FACILITY = None
505
506    try:
507        USE_SYSLOG  = cfg.getboolean( 'DEFAULT', 'USE_SYSLOG' )
508
509    except ConfigParser.NoOptionError:
510
511        USE_SYSLOG  = True
512
513        debug_msg( 0, 'ERROR: no option USE_SYSLOG found: assuming yes' )
514
515    if USE_SYSLOG:
516
517        try:
518            SYSLOG_LEVEL = cfg.getint( 'DEFAULT', 'SYSLOG_LEVEL' )
519
520        except ConfigParser.NoOptionError:
521
522            debug_msg( 0, 'ERROR: no option SYSLOG_LEVEL found: assuming level 0' )
523            SYSLOG_LEVEL = 0
524
525        try:
526
527            SYSLOG_FACILITY = eval( 'syslog.LOG_' + cfg.get( 'DEFAULT', 'SYSLOG_FACILITY' ) )
528
529        except ConfigParser.NoOptionError:
530
531            SYSLOG_FACILITY = syslog.LOG_DAEMON
532
533            debug_msg( 0, 'ERROR: no option SYSLOG_FACILITY found: assuming facility DAEMON' )
534
535    try:
536
537        BATCH_SERVER = cfg.get( 'DEFAULT', 'BATCH_SERVER' )
538
539    except ConfigParser.NoOptionError:
540
541        # Backwards compatibility for old configs
542        #
543
544        BATCH_SERVER = cfg.get( 'DEFAULT', 'TORQUE_SERVER' )
545        api_guess    = 'pbs'
546   
547    try:
548   
549        BATCH_POLL_INTERVAL = cfg.getint( 'DEFAULT', 'BATCH_POLL_INTERVAL' )
550
551    except ConfigParser.NoOptionError:
552
553        # Backwards compatibility for old configs
554        #
555
556        BATCH_POLL_INTERVAL = cfg.getint( 'DEFAULT', 'TORQUE_POLL_INTERVAL' )
557        api_guess           = 'pbs'
558   
559    try:
560
561        GMOND_CONF          = cfg.get( 'DEFAULT', 'GMOND_CONF' )
562
563    except ConfigParser.NoOptionError:
564
565        # Not specified: assume /etc/ganglia/gmond.conf
566        #
567        GMOND_CONF          = '/etc/ganglia/gmond.conf'
568
569    ganglia_cfg             = GangliaConfigParser( GMOND_CONF )
570    GMETRIC_TARGET          = None
571
572    GMOND_UDP_SEND_CHANNELS = ganglia_cfg.getUdpSendChannels()
573
574    if not GMOND_UDP_SEND_CHANNELS:
575
576        debug_msg( 0, "WARNING: Can't parse udp_send_channel from: '%s' - Trying: %s" %( GMOND_CONF, JOBMOND_CONF ) )
577
578        # Couldn't figure it out: let's see if it's in our jobmond.conf
579        #
580        try:
581
582            GMETRIC_TARGET    = cfg.get( 'DEFAULT', 'GMETRIC_TARGET' )
583
584        # Guess not: now just give up
585       
586        except ConfigParser.NoOptionError:
587
588            GMETRIC_TARGET    = None
589
590            debug_msg( 0, "ERROR: GMETRIC_TARGET not set: internal Gmetric handling aborted. Failing back to DEPRECATED use of gmond.conf/gmetric binary. This will slow down jobmond significantly!" )
591
592            gmetric_bin    = findGmetric()
593
594            if gmetric_bin:
595
596                GMETRIC_BINARY     = gmetric_bin
597            else:
598                debug_msg( 0, "WARNING: Can't find gmetric binary anywhere in $PATH" )
599
600                try:
601
602                    GMETRIC_BINARY = cfg.get( 'DEFAULT', 'GMETRIC_BINARY' )
603
604                except ConfigParser.NoOptionError:
605
606                    debug_msg( 0, "FATAL ERROR: GMETRIC_BINARY not set and not in $PATH" )
607                    sys.exit( 1 )
608
609    #TODO: is this really still needed or should be automatic
610    DETECT_TIME_DIFFS    = cfg.getboolean( 'DEFAULT', 'DETECT_TIME_DIFFS' )
611
612    BATCH_HOST_TRANSLATE = getlist( cfg.get( 'DEFAULT', 'BATCH_HOST_TRANSLATE' ) )
613
614    try:
615
616        BATCH_API    = cfg.get( 'DEFAULT', 'BATCH_API' )
617
618    except ConfigParser.NoOptionError, detail:
619
620        if BATCH_SERVER and api_guess:
621
622            BATCH_API    = api_guess
623        else:
624            debug_msg( 0, "FATAL ERROR: BATCH_API not set and can't make guess" )
625            sys.exit( 1 )
626
627    try:
628
629        QUEUE        = getlist( cfg.get( 'DEFAULT', 'QUEUE' ) )
630
631    except ConfigParser.NoOptionError, detail:
632
633        QUEUE        = None
634
635    METRIC_MAX_VAL_LEN = ganglia_cfg.getInt( 'globals', 'max_udp_msg_len' )
636
637    return True
638
639def fqdn_parts (fqdn):
640
641    """Return pair of host and domain for fully-qualified domain name arg."""
642
643    parts = fqdn.split (".")
644
645    return (parts[0], string.join(parts[1:], "."))
646
647class DataProcessor:
648
649    """Class for processing of data"""
650
651    binary = None
652
653    def __init__( self, binary=None ):
654
655        """Remember alternate binary location if supplied"""
656
657        global GMETRIC_BINARY, GMOND_CONF
658
659        if binary:
660            self.binary = binary
661
662        if not self.binary and not GMETRIC_TARGET and not GMOND_UDP_SEND_CHANNELS:
663            self.binary = GMETRIC_BINARY
664
665        # Timeout for XML
666        #
667        # From ganglia's documentation:
668        #
669        # 'A metric will be deleted DMAX seconds after it is received, and
670        # DMAX=0 means eternal life.'
671
672        self.dmax = str( int( int( BATCH_POLL_INTERVAL ) * 2 ) )
673
674        if GMOND_CONF and not GMETRIC_TARGET and not GMOND_UDP_SEND_CHANNELS:
675
676            incompatible = self.checkGmetricVersion()
677
678            if incompatible:
679
680                debug_msg( 0, 'Gmetric version not compatible, please upgrade to at least 3.4.0' )
681                sys.exit( 1 )
682
683    def checkGmetricVersion( self ):
684
685        """
686        Check version of gmetric is at least 3.4.0
687        for the syntax we use
688        """
689
690        global METRIC_MAX_VAL_LEN, GMETRIC_TARGET
691
692        incompatible    = 0
693
694        gfp        = os.popen( self.binary + ' --version' )
695        lines      = gfp.readlines()
696
697        gfp.close()
698
699        for line in lines:
700
701            line = line.split( ' ' )
702
703            if len( line ) == 2 and str( line ).find( 'gmetric' ) != -1:
704           
705                gmetric_version    = line[1].split( '\n' )[0]
706
707                version_major    = int( gmetric_version.split( '.' )[0] )
708                version_minor    = int( gmetric_version.split( '.' )[1] )
709                version_patch    = int( gmetric_version.split( '.' )[2] )
710
711                incompatible    = 0
712
713                if version_major < 3:
714
715                    incompatible = 1
716               
717                elif version_major == 3:
718
719                    if version_minor < 4:
720
721                        incompatible = 1
722
723        return incompatible
724
725    def multicastGmetric( self, metricname, metricval, valtype='string', units='' ):
726
727        """Call gmetric binary and multicast"""
728
729        cmd = self.binary
730
731        if GMOND_UDP_SEND_CHANNELS:
732
733            for c_ip, c_port  in GMOND_UDP_SEND_CHANNELS:
734
735                metric_debug        = "[gmetric %s:%s] name: %s - val: %s - dmax: %s" %( str(c_ip), str(c_port), str( metricname ), str( metricval ), str( self.dmax ) )
736
737                debug_msg( 10, printTime() + ' ' + metric_debug)
738
739                gm = Gmetric( c_ip, c_port )
740
741                gm.send( str( metricname ), str( metricval ), str( self.dmax ), valtype, units )
742
743        elif GMETRIC_TARGET:
744
745            GMETRIC_TARGET_HOST    = GMETRIC_TARGET.split( ':' )[0]
746            GMETRIC_TARGET_PORT    = GMETRIC_TARGET.split( ':' )[1]
747
748            metric_debug        = "[gmetric] name: %s - val: %s - dmax: %s" %( str( metricname ), str( metricval ), str( self.dmax ) )
749
750            debug_msg( 10, printTime() + ' ' + metric_debug)
751
752            gm = Gmetric( GMETRIC_TARGET_HOST, GMETRIC_TARGET_PORT )
753
754            gm.send( str( metricname ), str( metricval ), str( self.dmax ), valtype, units )
755
756        else:
757            try:
758                cmd = cmd + ' -c' + GMOND_CONF
759
760            except NameError:
761
762                debug_msg( 10, 'Assuming /etc/ganglia/gmond.conf for gmetric cmd' )
763
764            cmd = cmd + ' -n' + str( metricname )+ ' -v"' + str( metricval )+ '" -t' + str( valtype ) + ' -d' + str( self.dmax )
765
766            if len( units ) > 0:
767
768                cmd = cmd + ' -u"' + units + '"'
769
770            debug_msg( 10, printTime() + ' ' + cmd )
771
772            os.system( cmd )
773
774class DataGatherer:
775
776    """Skeleton class for batch system DataGatherer"""
777
778    def printJobs( self, jobs ):
779
780        """Print a jobinfo overview"""
781
782        for name, attrs in self.jobs.items():
783
784            print 'job %s' %(name)
785
786            for name, val in attrs.items():
787
788                print '\t%s = %s' %( name, val )
789
790    def printJob( self, jobs, job_id ):
791
792        """Print job with job_id from jobs"""
793
794        print 'job %s' %(job_id)
795
796        for name, val in jobs[ job_id ].items():
797
798            print '\t%s = %s' %( name, val )
799
800    def getAttr( self, attrs, name ):
801
802        """Return certain attribute from dictionary, if exists"""
803
804        if attrs.has_key( name ):
805
806            return attrs[ name ]
807        else:
808            return ''
809
810    def jobDataChanged( self, jobs, job_id, attrs ):
811
812        """Check if job with attrs and job_id in jobs has changed"""
813
814        if jobs.has_key( job_id ):
815
816            oldData = jobs[ job_id ]   
817        else:
818            return 1
819
820        for name, val in attrs.items():
821
822            if oldData.has_key( name ):
823
824                if oldData[ name ] != attrs[ name ]:
825
826                    return 1
827
828            else:
829                return 1
830
831        return 0
832
833    def submitJobData( self ):
834
835        """Submit job info list"""
836
837        global BATCH_API
838
839        self.dp.multicastGmetric( 'zplugin_monarch_heartbeat', str( int( int( self.cur_time ) + int( self.timeoffset ) ) ) )
840
841        running_jobs = 0
842        queued_jobs  = 0
843
844        # Count how many running/queued jobs we found
845        #
846        for jobid, jobattrs in self.jobs.items():
847
848            if jobattrs[ 'status' ] == 'Q':
849
850                queued_jobs += 1
851
852            elif jobattrs[ 'status' ] == 'R':
853
854                running_jobs += 1
855
856        # Report running/queued jobs as seperate metric for a nice RRD graph
857        #
858        self.dp.multicastGmetric( 'zplugin_monarch_rj', str( running_jobs ), 'uint32', 'jobs' )
859        self.dp.multicastGmetric( 'zplugin_monarch_qj', str( queued_jobs ), 'uint32', 'jobs' )
860
861        # Report down/offline nodes in batch (PBS only ATM)
862        #
863        if BATCH_API == 'pbs':
864
865            domain        = fqdn_parts( socket.getfqdn() )[1]
866
867            downed_nodes  = list()
868            offline_nodes = list()
869       
870            l        = ['state']
871       
872            for name, node in self.pq.getnodes().items():
873
874                if ( node[ 'state' ].find( "down" ) != -1 ):
875
876                    downed_nodes.append( name )
877
878                if ( node[ 'state' ].find( "offline" ) != -1 ):
879
880                    offline_nodes.append( name )
881
882            downnodeslist    = do_nodelist( downed_nodes )
883            offlinenodeslist = do_nodelist( offline_nodes )
884
885            down_str    = 'nodes=%s domain=%s reported=%s' %( string.join( downnodeslist, ';' ), domain, str( int( int( self.cur_time ) + int( self.timeoffset ) ) ) )
886            offl_str    = 'nodes=%s domain=%s reported=%s' %( string.join( offlinenodeslist, ';' ), domain, str( int( int( self.cur_time ) + int( self.timeoffset ) ) ) )
887            self.dp.multicastGmetric( 'zplugin_monarch_down'   , down_str )
888            self.dp.multicastGmetric( 'zplugin_monarch_offline', offl_str )
889
890        # Now let's spread the knowledge
891        #
892        for jobid, jobattrs in self.jobs.items():
893
894            # Make gmetric values for each job: respect max gmetric value length
895            #
896            gmetric_val        = self.compileGmetricVal( jobid, jobattrs )
897            metric_increment    = 0
898
899            # If we have more job info than max gmetric value length allows, split it up
900            # amongst multiple metrics
901            #
902            for val in gmetric_val:
903
904                metric_name = 'zplugin_monarch_job_%s_%s' %( str(metric_increment) , str( jobid ) )
905                self.dp.multicastGmetric( metric_name, val )
906
907                # Increase follow number if this jobinfo is split up amongst more than 1 gmetric
908                #
909                metric_increment    = metric_increment + 1
910
911    def compileGmetricVal( self, jobid, jobattrs ):
912
913        """Create a val string for gmetric of jobinfo"""
914
915        gval_lists    = [ ]
916        val_list    = { }
917
918        for val_name, val_value in jobattrs.items():
919
920            # These are our own metric names, i.e.: status, start_timestamp, etc
921            #
922            val_list_names_len    = len( string.join( val_list.keys() ) ) + len(val_list.keys())
923
924            # These are their corresponding values
925            #
926            val_list_vals_len    = len( string.join( val_list.values() ) ) + len(val_list.values())
927
928            if val_name == 'nodes' and jobattrs['status'] == 'R':
929
930                node_str = None
931
932                for node in val_value:
933
934                    if node_str:
935
936                        node_str = node_str + ';' + node
937                    else:
938                        node_str = node
939
940                    # Make sure if we add this new info, that the total metric's value length does not exceed METRIC_MAX_VAL_LEN
941                    #
942                    if (val_list_names_len + len(val_name) ) + (val_list_vals_len + len(node_str) ) > METRIC_MAX_VAL_LEN:
943
944                        # It's too big, we need to make a new gmetric for the additional info
945                        #
946                        val_list[ val_name ]    = node_str
947
948                        gval_lists.append( val_list )
949
950                        val_list        = { }
951                        node_str        = None
952
953                val_list[ val_name ]    = node_str
954
955                gval_lists.append( val_list )
956
957                val_list        = { }
958
959            elif val_value != '':
960
961                # Make sure if we add this new info, that the total metric's value length does not exceed METRIC_MAX_VAL_LEN
962                #
963                if (val_list_names_len + len(val_name) ) + (val_list_vals_len + len(str(val_value)) ) > METRIC_MAX_VAL_LEN:
964
965                    # It's too big, we need to make a new gmetric for the additional info
966                    #
967                    gval_lists.append( val_list )
968
969                    val_list        = { }
970
971                val_list[ val_name ]    = val_value
972
973        if len( val_list ) > 0:
974
975            gval_lists.append( val_list )
976
977        str_list    = [ ]
978
979        # Now append the value names and values together, i.e.: stop_timestamp=value, etc
980        #
981        for val_list in gval_lists:
982
983            my_val_str    = None
984
985            for val_name, val_value in val_list.items():
986
987                if type(val_value) == list:
988
989                    val_value    = val_value.join( ',' )
990
991                if my_val_str:
992
993                    try:
994                        # fixme: It's getting
995                        # ('nodes', None) items
996                        my_val_str = my_val_str + ' ' + val_name + '=' + val_value
997                    except:
998                        pass
999
1000                else:
1001                    my_val_str = val_name + '=' + val_value
1002
1003            str_list.append( my_val_str )
1004
1005        return str_list
1006
1007    def daemon( self ):
1008
1009        """Run as daemon forever"""
1010
1011        # Fork the first child
1012        #
1013        pid = os.fork()
1014        if pid > 0:
1015            sys.exit(0)  # end parent
1016
1017        # creates a session and sets the process group ID
1018        #
1019        os.setsid()
1020
1021        # Fork the second child
1022        #
1023        pid = os.fork()
1024        if pid > 0:
1025            sys.exit(0)  # end parent
1026
1027        write_pidfile()
1028
1029        # Go to the root directory and set the umask
1030        #
1031        os.chdir('/')
1032        os.umask(0)
1033
1034        sys.stdin.close()
1035        sys.stdout.close()
1036        sys.stderr.close()
1037
1038        os.open('/dev/null', os.O_RDWR)
1039        os.dup2(0, 1)
1040        os.dup2(0, 2)
1041
1042        self.run()
1043
1044    def run( self ):
1045
1046        """Main thread"""
1047
1048        while ( 1 ):
1049       
1050            self.getJobData()
1051            self.submitJobData()
1052            time.sleep( BATCH_POLL_INTERVAL )   
1053
1054# SGE code by Dave Love <fx@gnu.org>.  Tested with SGE 6.0u8 and 6.0u11.  May
1055# work with SGE 6.1 (else should be easily fixable), but definitely doesn't
1056# with 6.2.  See also the fixmes.
1057
1058class NoJobs (Exception):
1059    """Exception raised by empty job list in qstat output."""
1060    pass
1061
1062class SgeQstatXMLParser(xml.sax.handler.ContentHandler):
1063    """SAX handler for XML output from Sun Grid Engine's `qstat'."""
1064
1065    def __init__(self):
1066        self.value = ""
1067        self.joblist = []
1068        self.job = {}
1069        self.queue = ""
1070        self.in_joblist = False
1071        self.lrequest = False
1072        self.eltq = deque()
1073        xml.sax.handler.ContentHandler.__init__(self)
1074
1075    # The structure of the output is as follows (for SGE 6.0).  It's
1076    # similar for 6.1, but radically different for 6.2, and is
1077    # undocumented generally.  Unfortunately it's voluminous, and probably
1078    # doesn't scale to large clusters/queues.
1079
1080    # <detailed_job_info  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
1081    #   <djob_info>
1082    #     <qmaster_response>  <!-- job -->
1083    #       ...
1084    #       <JB_ja_template> 
1085    #     <ulong_sublist>
1086    #     ...         <!-- start_time, state ... -->
1087    #     </ulong_sublist>
1088    #       </JB_ja_template> 
1089    #       <JB_ja_tasks>
1090    #     <ulong_sublist>
1091    #       ...       <!-- task info
1092    #     </ulong_sublist>
1093    #     ...
1094    #       </JB_ja_tasks>
1095    #       ...
1096    #     </qmaster_response>
1097    #   </djob_info>
1098    #   <messages>
1099    #   ...
1100
1101    # NB.  We might treat each task as a separate job, like
1102    # straight qstat output, but the web interface expects jobs to
1103    # be identified by integers, not, say, <job number>.<task>.
1104
1105    # So, I lied.  If the job list is empty, we get invalid XML
1106    # like this, which we need to defend against:
1107
1108    # <unknown_jobs  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
1109    #   <>
1110    #     <ST_name>*</ST_name>
1111    #   </>
1112    # </unknown_jobs>
1113
1114    def startElement(self, name, attrs):
1115        self.value = ""
1116        if name == "djob_info":    # job list
1117            self.in_joblist = True
1118        # The job container is "qmaster_response" in SGE 6.0
1119        # and 6.1, but "element" in 6.2.  This is only the very
1120        # start of what's necessary for 6.2, though (sigh).
1121        elif (name == "qmaster_response" or name == "element") \
1122                and self.eltq[-1] == "djob_info": # job
1123            self.job = {"job_state": "U", "slots": 0,
1124                    "nodes": [], "queued_timestamp": "",
1125                    "queued_timestamp": "", "queue": "",
1126                    "ppn": "0", "RN_max": 0,
1127                    # fixme in endElement
1128                    "requested_memory": 0, "requested_time": 0
1129                    }
1130            self.joblist.append(self.job)
1131        elif name == "qstat_l_requests": # resource request
1132            self.lrequest = True
1133        elif name == "unknown_jobs":
1134            raise NoJobs
1135        self.eltq.append (name)
1136
1137    def characters(self, ch):
1138        self.value += ch
1139
1140    def endElement(self, name): 
1141        """Snarf job elements contents into job dictionary.
1142           Translate keys if appropriate."""
1143
1144        name_trans = {
1145          "JB_job_number": "number",
1146          "JB_job_name": "name", "JB_owner": "owner",
1147          "queue_name": "queue", "JAT_start_time": "start_timestamp",
1148          "JB_submission_time": "queued_timestamp"
1149          }
1150        value = self.value
1151        self.eltq.pop ()
1152
1153        if name == "djob_info":
1154            self.in_joblist = False
1155            self.job = {}
1156        elif name == "JAT_master_queue":
1157            self.job["queue"] = value.split("@")[0]
1158        elif name == "JG_qhostname":
1159            if not (value in self.job["nodes"]):
1160                self.job["nodes"].append(value)
1161        elif name == "JG_slots": # slots in use
1162            self.job["slots"] += int(value)
1163        elif name == "RN_max": # requested slots (tasks or parallel)
1164            self.job["RN_max"] = max (self.job["RN_max"],
1165                          int(value))
1166        elif name == "JAT_state": # job state (bitwise or)
1167            value = int (value)
1168            # Status values from sge_jobL.h
1169            #define JIDLE           0x00000000
1170            #define JHELD           0x00000010
1171            #define JMIGRATING          0x00000020
1172            #define JQUEUED         0x00000040
1173            #define JRUNNING        0x00000080
1174            #define JSUSPENDED          0x00000100
1175            #define JTRANSFERING        0x00000200
1176            #define JDELETED        0x00000400
1177            #define JWAITING        0x00000800
1178            #define JEXITING        0x00001000
1179            #define JWRITTEN        0x00002000
1180            #define JSUSPENDED_ON_THRESHOLD 0x00010000
1181            #define JFINISHED           0x00010000
1182            if value & 0x80:
1183                self.job["status"] = "R"
1184            elif value & 0x40:
1185                self.job["status"] = "Q"
1186            else:
1187                self.job["status"] = "O" # `other'
1188        elif name == "CE_name" and self.lrequest and self.value in \
1189                ("h_cpu", "s_cpu", "cpu", "h_core", "s_core"):
1190            # We're in a container for an interesting resource
1191            # request; record which type.
1192            self.lrequest = self.value
1193        elif name == "CE_doubleval" and self.lrequest:
1194            # if we're in a container for an interesting
1195            # resource request, use the maxmimum of the hard
1196            # and soft requests to record the requested CPU
1197            # or core.  Fixme:  I'm not sure if this logic is
1198            # right.
1199            if self.lrequest in ("h_core", "s_core"):
1200                self.job["requested_memory"] = \
1201                    max (float (value),
1202                     self.job["requested_memory"])
1203            # Fixme:  Check what cpu means, c.f [hs]_cpu.
1204            elif self.lrequest in ("h_cpu", "s_cpu", "cpu"):
1205                self.job["requested_time"] = \
1206                    max (float (value),
1207                     self.job["requested_time"])
1208        elif name == "qstat_l_requests":
1209            self.lrequest = False
1210        elif self.job and self.in_joblist:
1211            if name in name_trans:
1212                name = name_trans[name]
1213                self.job[name] = value
1214
1215# Abstracted from PBS original.
1216# Fixme:  Is it worth (or appropriate for PBS) sorting the result?
1217#
1218def do_nodelist( nodes ):
1219
1220    """Translate node list as appropriate."""
1221
1222    nodeslist        = [ ]
1223    my_domain        = fqdn_parts( socket.getfqdn() )[1]
1224
1225    for node in nodes:
1226
1227        host        = node.split( '/' )[0] # not relevant for SGE
1228        h, host_domain    = fqdn_parts(host)
1229
1230        if host_domain == my_domain:
1231
1232            host    = h
1233
1234        if nodeslist.count( host ) == 0:
1235
1236            for translate_pattern in BATCH_HOST_TRANSLATE:
1237
1238                if translate_pattern.find( '/' ) != -1:
1239
1240                    translate_orig    = \
1241                        translate_pattern.split( '/' )[1]
1242                    translate_new    = \
1243                        translate_pattern.split( '/' )[2]
1244                    host = re.sub( translate_orig,
1245                               translate_new, host )
1246            if not host in nodeslist:
1247                nodeslist.append( host )
1248    return nodeslist
1249
1250class SgeDataGatherer(DataGatherer):
1251
1252    jobs = {}
1253
1254    def __init__( self ):
1255        self.jobs = {}
1256        self.timeoffset = 0
1257        self.dp = DataProcessor()
1258
1259    def getJobData( self ):
1260        """Gather all data on current jobs in SGE"""
1261
1262        import popen2
1263
1264        self.cur_time = 0
1265        queues = ""
1266        if QUEUE:    # only for specific queues
1267            # Fixme:  assumes queue names don't contain single
1268            # quote or comma.  Don't know what the SGE rules are.
1269            queues = " -q '" + string.join (QUEUE, ",") + "'"
1270        # Note the comment in SgeQstatXMLParser about scaling with
1271        # this method of getting data.  I haven't found better one.
1272        # Output with args `-xml -ext -f -r' is easier to parse
1273        # in some ways, harder in others, but it doesn't provide
1274        # the submission time (at least SGE 6.0).  The pipeline
1275        # into sed corrects bogus XML observed with a configuration
1276        # of SGE 6.0u8, which otherwise causes the parsing to hang.
1277        piping = popen2.Popen3("qstat -u '*' -j '*' -xml | \
1278sed -e 's/reported usage>/reported_usage>/g' -e 's;<\/*JATASK:.*>;;'" \
1279                           + queues, True)
1280        qstatparser = SgeQstatXMLParser()
1281        parse_err = 0
1282        try:
1283            xml.sax.parse(piping.fromchild, qstatparser)
1284        except NoJobs:
1285            pass
1286        except:
1287            parse_err = 1
1288        if piping.wait():
1289            debug_msg(10, "qstat error, skipping until next polling interval: " + piping.childerr.readline())
1290            return None
1291        elif parse_err:
1292            debug_msg(10, "Bad XML output from qstat"())
1293            exit (1)
1294        for f in piping.fromchild, piping.tochild, piping.childerr:
1295            f.close()
1296        self.cur_time = time.time()
1297        jobs_processed = []
1298        for job in qstatparser.joblist:
1299            job_id = job["number"]
1300            if job["status"] in [ 'Q', 'R' ]:
1301                jobs_processed.append(job_id)
1302            if job["status"] == "R":
1303                job["nodes"] = do_nodelist (job["nodes"])
1304                # Fixme: why is job["nodes"] sometimes null?
1305                try:
1306                    # Fixme: Is this sensible?  The
1307                    # PBS-type PPN isn't something you use
1308                    # with SGE.
1309                    job["ppn"] = float(job["slots"]) / len(job["nodes"])
1310                except:
1311                    job["ppn"] = 0
1312                if DETECT_TIME_DIFFS:
1313                    # If a job start is later than our
1314                    # current date, that must mean
1315                    # the SGE server's time is later
1316                    # than our local time.
1317                    start_timestamp = int (job["start_timestamp"])
1318                    if start_timestamp > int(self.cur_time) + int(self.timeoffset):
1319
1320                        self.timeoffset    = start_timestamp - int(self.cur_time)
1321            else:
1322                # fixme: Note sure what this should be:
1323                job["ppn"] = job["RN_max"]
1324                job["nodes"] = "1"
1325
1326            myAttrs = {}
1327            for attr in ["name", "queue", "owner",
1328                     "requested_time", "status",
1329                     "requested_memory", "ppn",
1330                     "start_timestamp", "queued_timestamp"]:
1331                myAttrs[attr] = str(job[attr])
1332            myAttrs["nodes"] = job["nodes"]
1333            myAttrs["reported"] = str(int(self.cur_time) + int(self.timeoffset))
1334            myAttrs["domain"] = fqdn_parts(socket.getfqdn())[1]
1335            myAttrs["poll_interval"] = str(BATCH_POLL_INTERVAL)
1336
1337            if self.jobDataChanged(self.jobs, job_id, myAttrs) and myAttrs["status"] in ["R", "Q"]:
1338                self.jobs[job_id] = myAttrs
1339        for id, attrs in self.jobs.items():
1340            if id not in jobs_processed:
1341                del self.jobs[id]
1342
1343# LSF code by Mahmoud Hanafi <hanafim@users.sourceforge.nt>
1344# Requres LSFObject http://sourceforge.net/projects/lsfobject
1345#
1346class LsfDataGatherer(DataGatherer):
1347
1348    """This is the DataGatherer for LSf"""
1349
1350    global lsfObject
1351
1352    def __init__( self ):
1353
1354        self.jobs = { }
1355        self.timeoffset = 0
1356        self.dp = DataProcessor()
1357        self.initLsfQuery()
1358
1359    def _countDuplicatesInList( self, dupedList ):
1360
1361        countDupes    = { }
1362
1363        for item in dupedList:
1364
1365            if not countDupes.has_key( item ):
1366
1367                countDupes[ item ]    = 1
1368            else:
1369                countDupes[ item ]    = countDupes[ item ] + 1
1370
1371        dupeCountList    = [ ]
1372
1373        for item, count in countDupes.items():
1374
1375            dupeCountList.append( ( item, count ) )
1376
1377        return dupeCountList
1378#
1379#lst = ['I1','I2','I1','I3','I4','I4','I7','I7','I7','I7','I7']
1380#print _countDuplicatesInList(lst)
1381#[('I1', 2), ('I3', 1), ('I2', 1), ('I4', 2), ('I7', 5)]
1382########################
1383
1384    def initLsfQuery( self ):
1385        self.pq = None
1386        self.pq = lsfObject.jobInfoEntObject()
1387
1388    def getJobData( self, known_jobs="" ):
1389        """Gather all data on current jobs in LSF"""
1390        if len( known_jobs ) > 0:
1391            jobs = known_jobs
1392        else:
1393            jobs = { }
1394        joblist = {}
1395        joblist = self.pq.getJobInfo()
1396        nodelist = ''
1397
1398        self.cur_time = time.time()
1399
1400        jobs_processed = [ ]
1401
1402        for name, attrs in joblist.items():
1403            job_id = str(name)
1404            jobs_processed.append( job_id )
1405            name = self.getAttr( attrs, 'jobName' )
1406            queue = self.getAttr( self.getAttr( attrs, 'submit') , 'queue' )
1407            owner = self.getAttr( attrs, 'user' )
1408
1409### THIS IS THE rLimit List index values
1410#define LSF_RLIMIT_CPU      0        /* cpu time in milliseconds */
1411#define LSF_RLIMIT_FSIZE    1        /* maximum file size */
1412#define LSF_RLIMIT_DATA     2        /* data size */
1413#define LSF_RLIMIT_STACK    3        /* stack size */
1414#define LSF_RLIMIT_CORE     4        /* core file size */
1415#define LSF_RLIMIT_RSS      5        /* resident set size */
1416#define LSF_RLIMIT_NOFILE   6        /* open files */
1417#define LSF_RLIMIT_OPEN_MAX 7        /* (from HP-UX) */
1418#define LSF_RLIMIT_VMEM     8        /* maximum swap mem */
1419#define LSF_RLIMIT_SWAP     8
1420#define LSF_RLIMIT_RUN      9        /* max wall-clock time limit */
1421#define LSF_RLIMIT_PROCESS  10       /* process number limit */
1422#define LSF_RLIMIT_THREAD   11       /* thread number limit (introduced in LSF6.0) */
1423#define LSF_RLIM_NLIMITS    12       /* number of resource limits */
1424
1425            requested_time = self.getAttr( self.getAttr( attrs, 'submit') , 'rLimits' )[9]
1426            if requested_time == -1: 
1427                requested_time = ""
1428            requested_memory = self.getAttr( self.getAttr( attrs, 'submit') , 'rLimits' )[8]
1429            if requested_memory == -1: 
1430                requested_memory = ""
1431# This tries to get proc per node. We don't support this right now
1432            ppn = 0 #self.getAttr( self.getAttr( attrs, 'SubmitList') , 'numProessors' )
1433            requested_cpus = self.getAttr( self.getAttr( attrs, 'submit') , 'numProcessors' )
1434            if requested_cpus == None or requested_cpus == "":
1435                requested_cpus = 1
1436
1437            if QUEUE:
1438                for q in QUEUE:
1439                    if q == queue:
1440                        display_queue = 1
1441                        break
1442                    else:
1443                        display_queue = 0
1444                        continue
1445            if display_queue == 0:
1446                continue
1447
1448            runState = self.getAttr( attrs, 'status' )
1449            if runState == 4:
1450                status = 'R'
1451            else:
1452                status = 'Q'
1453            queued_timestamp = self.getAttr( attrs, 'submitTime' )
1454
1455            if status == 'R':
1456                start_timestamp = self.getAttr( attrs, 'startTime' )
1457                nodesCpu =  dict(self._countDuplicatesInList(self.getAttr( attrs, 'exHosts' )))
1458                nodelist = nodesCpu.keys()
1459
1460                if DETECT_TIME_DIFFS:
1461
1462                    # If a job start if later than our current date,
1463                    # that must mean the Torque server's time is later
1464                    # than our local time.
1465
1466                    if int(start_timestamp) > int( int(self.cur_time) + int(self.timeoffset) ):
1467
1468                        self.timeoffset = int( int(start_timestamp) - int(self.cur_time) )
1469
1470            elif status == 'Q':
1471                start_timestamp = ''
1472                count_mynodes = 0
1473                numeric_node = 1
1474                nodelist = ''
1475
1476            myAttrs = { }
1477            if name == "":
1478                myAttrs['name'] = "none"
1479            else:
1480                myAttrs['name'] = name
1481
1482            myAttrs[ 'owner' ]        = owner
1483            myAttrs[ 'requested_time' ]    = str(requested_time)
1484            myAttrs[ 'requested_memory' ]    = str(requested_memory)
1485            myAttrs[ 'requested_cpus' ]    = str(requested_cpus)
1486            myAttrs[ 'ppn' ]        = str( ppn )
1487            myAttrs[ 'status' ]        = status
1488            myAttrs[ 'start_timestamp' ]    = str(start_timestamp)
1489            myAttrs[ 'queue' ]        = str(queue)
1490            myAttrs[ 'queued_timestamp' ]    = str(queued_timestamp)
1491            myAttrs[ 'reported' ]        = str( int( int( self.cur_time ) + int( self.timeoffset ) ) )
1492            myAttrs[ 'nodes' ]        = do_nodelist( nodelist )
1493            myAttrs[ 'domain' ]        = fqdn_parts( socket.getfqdn() )[1]
1494            myAttrs[ 'poll_interval' ]    = str(BATCH_POLL_INTERVAL)
1495
1496            if self.jobDataChanged( jobs, job_id, myAttrs ) and myAttrs['status'] in [ 'R', 'Q' ]:
1497                jobs[ job_id ] = myAttrs
1498
1499                debug_msg( 10, printTime() + ' job %s state changed' %(job_id) )
1500
1501        for id, attrs in jobs.items():
1502            if id not in jobs_processed:
1503                # This one isn't there anymore
1504                #
1505                del jobs[ id ]
1506        self.jobs=jobs
1507
1508
1509class PbsDataGatherer( DataGatherer ):
1510
1511    """This is the DataGatherer for PBS and Torque"""
1512
1513    global PBSQuery, PBSError
1514
1515    def __init__( self ):
1516
1517        """Setup appropriate variables"""
1518
1519        self.jobs    = { }
1520        self.timeoffset    = 0
1521        self.dp        = DataProcessor()
1522
1523        self.initPbsQuery()
1524
1525    def initPbsQuery( self ):
1526
1527        self.pq        = None
1528
1529        if( BATCH_SERVER ):
1530
1531            self.pq        = PBSQuery( BATCH_SERVER )
1532        else:
1533            self.pq        = PBSQuery()
1534
1535        try:
1536            self.pq.old_data_structure()
1537
1538        except AttributeError:
1539
1540            # pbs_query is older
1541            #
1542            pass
1543
1544    def getJobData( self ):
1545
1546        """Gather all data on current jobs in Torque"""
1547
1548        joblist        = {}
1549        self.cur_time    = 0
1550
1551        try:
1552            joblist        = self.pq.getjobs()
1553            self.cur_time    = time.time()
1554
1555        except PBSError, detail:
1556
1557            debug_msg( 10, "Caught PBS unavailable, skipping until next polling interval: " + str( detail ) )
1558            return None
1559
1560        jobs_processed    = [ ]
1561
1562        for name, attrs in joblist.items():
1563            display_queue        = 1
1564            job_id            = name.split( '.' )[0]
1565
1566            name            = self.getAttr( attrs, 'Job_Name' )
1567            queue            = self.getAttr( attrs, 'queue' )
1568
1569            if QUEUE:
1570                for q in QUEUE:
1571                    if q == queue:
1572                        display_queue = 1
1573                        break
1574                    else:
1575                        display_queue = 0
1576                        continue
1577            if display_queue == 0:
1578                continue
1579
1580
1581            owner            = self.getAttr( attrs, 'Job_Owner' ).split( '@' )[0]
1582            requested_time        = self.getAttr( attrs, 'Resource_List.walltime' )
1583            requested_memory    = self.getAttr( attrs, 'Resource_List.mem' )
1584
1585            mynoderequest        = self.getAttr( attrs, 'Resource_List.nodes' )
1586
1587            ppn            = ''
1588
1589            if mynoderequest.find( ':' ) != -1 and mynoderequest.find( 'ppn' ) != -1:
1590
1591                mynoderequest_fields    = mynoderequest.split( ':' )
1592
1593                for mynoderequest_field in mynoderequest_fields:
1594
1595                    if mynoderequest_field.find( 'ppn' ) != -1:
1596
1597                        ppn    = mynoderequest_field.split( 'ppn=' )[1]
1598
1599            status            = self.getAttr( attrs, 'job_state' )
1600
1601            if status in [ 'Q', 'R' ]:
1602
1603                jobs_processed.append( job_id )
1604
1605            queued_timestamp    = self.getAttr( attrs, 'ctime' )
1606
1607            if status == 'R':
1608
1609                start_timestamp        = self.getAttr( attrs, 'mtime' )
1610                nodes            = self.getAttr( attrs, 'exec_host' ).split( '+' )
1611
1612                nodeslist        = do_nodelist( nodes )
1613
1614                if DETECT_TIME_DIFFS:
1615
1616                    # If a job start if later than our current date,
1617                    # that must mean the Torque server's time is later
1618                    # than our local time.
1619               
1620                    if int( start_timestamp ) > int( int( self.cur_time ) + int( self.timeoffset ) ):
1621
1622                        self.timeoffset    = int( int(start_timestamp) - int(self.cur_time) )
1623
1624            elif status == 'Q':
1625
1626                # 'mynodequest' can be a string in the following syntax according to the
1627                # Torque Administator's manual:
1628                #
1629                # {<node_count> | <hostname>}[:ppn=<ppn>][:<property>[:<property>]...][+ ...]
1630                # {<node_count> | <hostname>}[:ppn=<ppn>][:<property>[:<property>]...][+ ...]
1631                # etc
1632                #
1633
1634                #
1635                # For now we only count the amount of nodes request and ignore properties
1636                #
1637
1638                start_timestamp        = ''
1639                count_mynodes        = 0
1640
1641                for node in mynoderequest.split( '+' ):
1642
1643                    # Just grab the {node_count|hostname} part and ignore properties
1644                    #
1645                    nodepart    = node.split( ':' )[0]
1646
1647                    # Let's assume a node_count value
1648                    #
1649                    numeric_node    = 1
1650
1651                    # Chop the value up into characters
1652                    #
1653                    for letter in nodepart:
1654
1655                        # If this char is not a digit (0-9), this must be a hostname
1656                        #
1657                        if letter not in string.digits:
1658
1659                            numeric_node    = 0
1660
1661                    # If this is a hostname, just count this as one (1) node
1662                    #
1663                    if not numeric_node:
1664
1665                        count_mynodes    = count_mynodes + 1
1666                    else:
1667
1668                        # If this a number, it must be the node_count
1669                        # and increase our count with it's value
1670                        #
1671                        try:
1672                            count_mynodes    = count_mynodes + int( nodepart )
1673
1674                        except ValueError, detail:
1675
1676                            # When we arrive here I must be bugged or very confused
1677                            # THIS SHOULD NOT HAPPEN!
1678                            #
1679                            debug_msg( 10, str( detail ) )
1680                            debug_msg( 10, "Encountered weird node in Resources_List?!" )
1681                            debug_msg( 10, 'nodepart = ' + str( nodepart ) )
1682                            debug_msg( 10, 'job = ' + str( name ) )
1683                            debug_msg( 10, 'attrs = ' + str( attrs ) )
1684                       
1685                nodeslist    = str( count_mynodes )
1686            else:
1687                start_timestamp    = ''
1688                nodeslist    = ''
1689
1690            myAttrs                = { }
1691
1692            myAttrs[ 'name' ]        = str( name )
1693            myAttrs[ 'queue' ]        = str( queue )
1694            myAttrs[ 'owner' ]        = str( owner )
1695            myAttrs[ 'requested_time' ]    = str( requested_time )
1696            myAttrs[ 'requested_memory' ]    = str( requested_memory )
1697            myAttrs[ 'ppn' ]        = str( ppn )
1698            myAttrs[ 'status' ]        = str( status )
1699            myAttrs[ 'start_timestamp' ]    = str( start_timestamp )
1700            myAttrs[ 'queued_timestamp' ]    = str( queued_timestamp )
1701            myAttrs[ 'reported' ]        = str( int( int( self.cur_time ) + int( self.timeoffset ) ) )
1702            myAttrs[ 'nodes' ]        = nodeslist
1703            myAttrs[ 'domain' ]        = fqdn_parts( socket.getfqdn() )[1]
1704            myAttrs[ 'poll_interval' ]    = str( BATCH_POLL_INTERVAL )
1705
1706            if self.jobDataChanged( self.jobs, job_id, myAttrs ) and myAttrs['status'] in [ 'R', 'Q' ]:
1707
1708                self.jobs[ job_id ]    = myAttrs
1709
1710        for id, attrs in self.jobs.items():
1711
1712            if id not in jobs_processed:
1713
1714                # This one isn't there anymore; toedeledoki!
1715                #
1716                del self.jobs[ id ]
1717
1718GMETRIC_DEFAULT_TYPE    = 'string'
1719GMETRIC_DEFAULT_HOST    = '127.0.0.1'
1720GMETRIC_DEFAULT_PORT    = '8649'
1721GMETRIC_DEFAULT_UNITS   = ''
1722
1723class Gmetric:
1724
1725    global GMETRIC_DEFAULT_HOST, GMETRIC_DEFAULT_PORT
1726
1727    slope           = { 'zero' : 0, 'positive' : 1, 'negative' : 2, 'both' : 3, 'unspecified' : 4 }
1728    type            = ( '', 'string', 'uint16', 'int16', 'uint32', 'int32', 'float', 'double', 'timestamp' )
1729    protocol        = ( 'udp', 'multicast' )
1730
1731    def __init__( self, host=GMETRIC_DEFAULT_HOST, port=GMETRIC_DEFAULT_PORT ):
1732               
1733        global GMETRIC_DEFAULT_TYPE
1734
1735        self.prot       = self.checkHostProtocol( host )
1736        self.data_msg   = xdrlib.Packer()
1737        self.meta_msg   = xdrlib.Packer()
1738        self.socket     = socket.socket( socket.AF_INET, socket.SOCK_DGRAM )
1739
1740        if self.prot not in self.protocol:
1741
1742            raise ValueError( "Protocol must be one of: " + str( self.protocol ) )
1743
1744        if self.prot == 'multicast':
1745
1746            # Set multicast options
1747            #
1748            self.socket.setsockopt( socket.IPPROTO_IP, socket.IP_MULTICAST_TTL, 20 )
1749
1750        self.hostport   = ( host, int( port ) )
1751        self.slopestr   = 'both'
1752        self.tmax       = 60
1753
1754    def checkHostProtocol( self, ip ):
1755
1756        """Detect if a ip adress is a multicast address"""
1757
1758        MULTICAST_ADDRESS_MIN   = ( "224", "0", "0", "0" )
1759        MULTICAST_ADDRESS_MAX   = ( "239", "255", "255", "255" )
1760
1761        ip_fields               = ip.split( '.' )
1762
1763        if ip_fields >= MULTICAST_ADDRESS_MIN and ip_fields <= MULTICAST_ADDRESS_MAX:
1764
1765            return 'multicast'
1766        else:
1767            return 'udp'
1768
1769    def send( self, name, value, dmax, typestr = '', units = '' ):
1770
1771        if len( units ) == 0:
1772            units       = GMETRIC_DEFAULT_UNITS
1773
1774        if len( typestr ) == 0:
1775            typestr     = GMETRIC_DEFAULT_TYPE
1776
1777        (meta_msg, data_msg) = self.makexdr( name, value, typestr, units, self.slopestr, self.tmax, dmax )
1778
1779        meta_rt = self.socket.sendto( meta_msg, self.hostport )
1780        data_rt = self.socket.sendto( data_msg, self.hostport )
1781
1782        return ( meta_rt, data_rt )
1783
1784    def makexdr( self, name, value, typestr, unitstr, slopestr, tmax, dmax, group=None, spoof=None ):
1785
1786        hostname = "unset"
1787
1788        if slopestr not in self.slope:
1789
1790            raise ValueError( "Slope must be one of: " + str( self.slope.keys() ) )
1791
1792        if typestr not in self.type:
1793
1794            raise ValueError( "Type must be one of: " + str( self.type ) )
1795
1796        if len( name ) == 0:
1797
1798            raise ValueError( "Name must be non-empty" )
1799
1800        self.meta_msg.reset()
1801        self.meta_msg.pack_int( 128 )
1802
1803        if not spoof:
1804            self.meta_msg.pack_string( hostname )
1805        else:
1806            self.meta_msg.pack_string( spoof )
1807
1808        self.meta_msg.pack_string( name )
1809
1810        if not spoof:
1811            self.meta_msg.pack_int( 0 )
1812        else:
1813            self.meta_msg.pack_int( 1 )
1814           
1815        self.meta_msg.pack_string( typestr )
1816        self.meta_msg.pack_string( name )
1817        self.meta_msg.pack_string( unitstr )
1818        self.meta_msg.pack_int( self.slope[ slopestr ] )
1819        self.meta_msg.pack_uint( int( tmax ) )
1820        self.meta_msg.pack_uint( int( dmax ) )
1821
1822        if not group:
1823            self.meta_msg.pack_int( 0 )
1824        else:
1825            self.meta_msg.pack_int( 1 )
1826            self.meta_msg.pack_string( "GROUP" )
1827            self.meta_msg.pack_string( group )
1828
1829        self.data_msg.reset()
1830        self.data_msg.pack_int( 128+5 )
1831
1832        if not spoof:
1833            self.data_msg.pack_string( hostname )
1834        else:
1835            self.data_msg.pack_string( spoof )
1836
1837        self.data_msg.pack_string( name )
1838
1839        if not spoof:
1840            self.data_msg.pack_int( 0 )
1841        else:
1842            self.data_msg.pack_int( 1 )
1843
1844        self.data_msg.pack_string( "%s" )
1845        self.data_msg.pack_string( str( value ) )
1846
1847        return ( self.meta_msg.get_buffer(), self.data_msg.get_buffer() )
1848
1849def printTime( ):
1850
1851    """Print current time/date in human readable format for log/debug"""
1852
1853    return time.strftime("%a, %d %b %Y %H:%M:%S")
1854
1855def debug_msg( level, msg ):
1856
1857    """Print msg if at or above current debug level"""
1858
1859    global DAEMONIZE, DEBUG_LEVEL, SYSLOG_LEVEL
1860
1861    if (not DAEMONIZE and DEBUG_LEVEL >= level):
1862        sys.stderr.write( msg + '\n' )
1863
1864    if (DAEMONIZE and USE_SYSLOG and SYSLOG_LEVEL >= level):
1865        syslog.syslog( msg )
1866
1867def write_pidfile():
1868
1869    # Write pidfile if PIDFILE is set
1870    #
1871    if PIDFILE:
1872
1873        pid    = os.getpid()
1874
1875        pidfile    = open( PIDFILE, 'w' )
1876
1877        pidfile.write( str( pid ) )
1878        pidfile.close()
1879
1880def main():
1881
1882    """Application start"""
1883
1884    global PBSQuery, PBSError, lsfObject
1885    global SYSLOG_FACILITY, USE_SYSLOG, BATCH_API, DAEMONIZE
1886
1887    if not processArgs( sys.argv[1:] ):
1888
1889        sys.exit( 1 )
1890
1891    # Load appropriate DataGatherer depending on which BATCH_API is set
1892    # and any required modules for the Gatherer
1893    #
1894    if BATCH_API == 'pbs':
1895
1896        try:
1897            from PBSQuery import PBSQuery, PBSError
1898
1899        except ImportError:
1900
1901            debug_msg( 0, "FATAL ERROR: BATCH_API set to 'pbs' but python module 'pbs_python' is not installed" )
1902            sys.exit( 1 )
1903
1904        gather = PbsDataGatherer()
1905
1906    elif BATCH_API == 'sge':
1907
1908        # Tested with SGE 6.0u11.
1909        #
1910        gather = SgeDataGatherer()
1911
1912    elif BATCH_API == 'lsf':
1913
1914        try:
1915            from lsfObject import lsfObject
1916        except:
1917            debug_msg(0, "fatal error: BATCH_API set to 'lsf' but python module is not found or installed")
1918            sys.exit( 1)
1919
1920        gather = LsfDataGatherer()
1921
1922    else:
1923        debug_msg( 0, "FATAL ERROR: unknown BATCH_API '" + BATCH_API + "' is not supported" )
1924
1925        sys.exit( 1 )
1926
1927    if( DAEMONIZE and USE_SYSLOG ):
1928
1929        syslog.openlog( 'jobmond', syslog.LOG_NOWAIT, SYSLOG_FACILITY )
1930
1931    if DAEMONIZE:
1932
1933        gather.daemon()
1934    else:
1935        gather.run()
1936
1937# wh00t? someone started me! :)
1938#
1939if __name__ == '__main__':
1940    main()
Note: See TracBrowser for help on using the repository browser.