AnalysisStats.pm 14.6 KB
Newer Older
1
2
3
=pod 

=head1 NAME
4

5
    Bio::EnsEMBL::Hive::AnalysisStats
6
7
8

=head1 DESCRIPTION

9
10
11
12
    An object that maintains counters for jobs in different states. This data is used by the Scheduler.

=head1 LICENSE

13
    Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
14
15
16
17
18
19
20
21
22
23

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

         http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License
    is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and limitations under the License.

24
=head1 CONTACT
25

26
    Please subscribe to the Hive mailing list:  http://listserver.ebi.ac.uk/mailman/listinfo/ehive-users  to discuss Hive-related questions or to be notified of our updates
27
28

=head1 APPENDIX
29

30
31
    The rest of the documentation details each of the object methods.
    Internal methods are usually preceded with a _
32

33
34
=cut

35

36
37
38
package Bio::EnsEMBL::Hive::AnalysisStats;

use strict;
39
use warnings;
40
41
use List::Util 'sum';
use POSIX;
42
use Term::ANSIColor;
43

44
use Bio::EnsEMBL::Hive::Utils ('throw');
45
use Bio::EnsEMBL::Hive::Analysis;
46

47
use base ( 'Bio::EnsEMBL::Hive::Cacheable', 'Bio::EnsEMBL::Hive::Storable' );
48

49

50
51
52
53
54
sub unikey {    # override the default from Cacheable parent
    return [ 'analysis' ];
}


55
56
57
58
59
60
    ## Minimum amount of time in msec that a worker should run before reporting
    ## back to the hive. This is used when setting the batch_size automatically.
sub min_batch_time {
    return 2*60*1000;
}

61

62
63
64
65
66
67
=head1 AUTOLOADED

    analysis_id / analysis

=cut

68

69
70
71
72
73
sub batch_size {
    my $self = shift;
    $self->{'_batch_size'} = shift if(@_);
    $self->{'_batch_size'} = 1 unless(defined($self->{'_batch_size'})); # only initialize when undefined, so if defined as 0 will stay 0
    return $self->{'_batch_size'};
74
75
}

76
77
78
79
sub hive_capacity {
    my $self = shift;
    $self->{'_hive_capacity'} = shift if(@_);
    return $self->{'_hive_capacity'};
80
81
}

82
sub status {
83
    my $self = shift;
84
85
86
    $self->{'_status'} = shift if(@_);
    return $self->{'_status'};
}
87
88


89
## counters of jobs in different states:
90

91

92
sub total_job_count {
93
    my $self = shift;
94
95
    $self->{'_total_job_count'} = shift if(@_);
    return $self->{'_total_job_count'};
96
97
}

98
sub semaphored_job_count {
99
    my $self = shift;
100
101
102
103
104
105
106
107
    $self->{'_semaphored_job_count'} = shift if(@_);
    return $self->{'_semaphored_job_count'};
}

sub ready_job_count {
    my $self = shift;
    $self->{'_ready_job_count'} = shift if(@_);
    return $self->{'_ready_job_count'};
108
109
}

110
sub done_job_count {
111
    my $self = shift;
112
113
    $self->{'_done_job_count'} = shift if(@_);
    return $self->{'_done_job_count'};
114
115
}

116
sub failed_job_count {
117
    my $self = shift;
118
119
120
121
122
123
124
125
126
    $self->{'_failed_job_count'} = shift if(@_);
    $self->{'_failed_job_count'} = 0 unless(defined($self->{'_failed_job_count'}));
    return $self->{'_failed_job_count'};
}

sub num_running_workers {
    my $self = shift;
    $self->{'_num_running_workers'} = shift if(@_);
    return $self->{'_num_running_workers'};
127
128
}

129
130
131
132

## dynamic hive_capacity mode attributes:


133
sub behaviour {
134
135
136
    my $self = shift;
    $self->{'_behaviour'} = shift if(@_);
    return $self->{'_behaviour'};
137
138
139
}

sub input_capacity {
140
141
142
    my $self = shift;
    $self->{'_input_capacity'} = shift if(@_);
    return $self->{'_input_capacity'};
143
144
145
}

sub output_capacity {
146
147
148
    my $self = shift;
    $self->{'_output_capacity'} = shift if(@_);
    return $self->{'_output_capacity'};
149
150
}

151

152
## dynamic hive_capacity mode counters:
153

154
155

sub avg_msec_per_job {
156
    my $self = shift;
157
158
159
    $self->{'_avg_msec_per_job'} = shift if(@_);
    $self->{'_avg_msec_per_job'}=0 unless($self->{'_avg_msec_per_job'});
    return $self->{'_avg_msec_per_job'};
160
161
}

162
sub avg_input_msec_per_job {
163
    my $self = shift;
164
165
166
    $self->{'_avg_input_msec_per_job'} = shift if(@_);
    $self->{'_avg_input_msec_per_job'}=0 unless($self->{'_avg_input_msec_per_job'});
    return $self->{'_avg_input_msec_per_job'};
167
168
}

169
sub avg_run_msec_per_job {
170
    my $self = shift;
171
172
173
    $self->{'_avg_run_msec_per_job'} = shift if(@_);
    $self->{'_avg_run_msec_per_job'}=0 unless($self->{'_avg_run_msec_per_job'});
    return $self->{'_avg_run_msec_per_job'};
174
175
}

176
sub avg_output_msec_per_job {
177
    my $self = shift;
178
179
180
    $self->{'_avg_output_msec_per_job'} = shift if(@_);
    $self->{'_avg_output_msec_per_job'}=0 unless($self->{'_avg_output_msec_per_job'});
    return $self->{'_avg_output_msec_per_job'};
181
182
}

183

184
## other storable attributes:
185

186
sub when_updated {                   # this method is called by the initial store() [at which point it returns undef]
187
    my $self = shift;
188
189
    $self->{'_when_updated'} = shift if(@_);
    return $self->{'_when_updated'};
190
}
191

192
sub seconds_since_when_updated {     # this method is mostly used to convert between server time and local time
193
    my( $self, $value ) = @_;
194
195
    $self->{'_when_updated'} = time() - $value if(defined($value));
    return defined($self->{'_when_updated'}) ? time() - $self->{'_when_updated'} : undef;
196
197
}

198
199
200
201
sub sync_lock {
    my $self = shift;
    $self->{'_sync_lock'} = shift if(@_);
    return $self->{'_sync_lock'};
202
203
}

204
205
206
207
208
209
210
211

# non-storable attributes and other helper-methods:


sub refresh {
    my $self = shift;

    return $self->adaptor && $self->adaptor->refresh($self);
212
213
}

214
215
sub update {
    my $self = shift;
216
217
218
219

    if($self->adaptor) {
        $self->adaptor->update($self);
    }
220
221
}

222

223
sub get_or_estimate_batch_size {
224
225
    my $self = shift;

226
227
228
    my $batch_size = $self->batch_size;

    if( $batch_size > 0 ) {        # set to positive or not set (and auto-initialized within $self->batch_size)
229
230

                                                        # otherwise it is a request for dynamic estimation:
231
    } elsif( my $avg_msec_per_job = $self->avg_msec_per_job ) {           # further estimations from collected stats
232
233
234

        $avg_msec_per_job = 100 if($avg_msec_per_job<100);

235
        $batch_size = POSIX::ceil( $self->min_batch_time / $avg_msec_per_job );
236
237

    } else {        # first estimation when no stats are available (take -$batch_size as first guess, if not zero)
238
239
240
241
242
243
244
245
246
247
248
        $batch_size = -$batch_size || 1;
    }

        # TailTrimming correction:
    if( my $num_running_workers = $self->num_running_workers ) {
        my $tt_batch_size = POSIX::floor( $self->ready_job_count / $num_running_workers );
        if( (0 < $tt_batch_size) && ($tt_batch_size < $batch_size) ) {
            $batch_size = $tt_batch_size;
        } elsif(!$tt_batch_size) {
            $batch_size = POSIX::ceil( $self->ready_job_count / $num_running_workers ); # essentially, 0 or 1
        }
249
    }
250
251

    return $batch_size;
252
}
253

254

255
256
257
sub estimate_num_required_workers {
    my $self = shift;

258
259
    # return POSIX::ceil( $self->ready_job_count / $self->get_or_estimate_batch_size ); # no TailTrimming
    return $self->ready_job_count;  # TailTrimming
260
261
262
}


263
sub inprogress_job_count {      # includes CLAIMED
264
265
266
267
268
269
270
    my $self = shift;
    return    $self->total_job_count
            - $self->semaphored_job_count
            - $self->ready_job_count
            - $self->done_job_count
            - $self->failed_job_count;
}
271

272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
my %meta_status_2_color = (
    'DONE'      => 'bright_cyan',
    'RUNNING'   => 'bright_yellow',
    'READY'     => 'bright_green',
    'BLOCKED'   => 'black on_white',
    'EMPTY'     => 'clear',
    'FAILED'    => 'red',
);

my %analysis_status_2_meta_status = (
    'LOADING'       => 'READY',
    'SYNCHING'      => 'READY',
    'ALL_CLAIMED'   => 'BLOCKED',
    'WORKING'       => 'RUNNING',
);

my %count_method_2_meta_status = (
    'semaphored_job_count'  => 'BLOCKED',
    'ready_job_count'       => 'READY',
    'inprogress_job_count'  => 'RUNNING',
    'done_job_count'        => 'DONE',
    'failed_job_count'      => 'FAILED',
);

sub _text_with_status_color {
    my $field_size = shift;
    my $color_enabled = shift;

    my $padding = ($field_size and length($_[0]) < $field_size) ? ' ' x ($field_size - length($_[0])) : '';
    return $padding . ($color_enabled ? color($meta_status_2_color{$_[1]}).$_[0].color('reset') : $_[0]);
}

304

305
306
sub job_count_breakout {
    my $self = shift;
307
308
    my $field_size = shift;
    my $color_enabled = shift;
309

310
    my $this_length = 0;
311
312
313
    my @count_list = ();
    my %count_hash = ();
    my $total_job_count = $self->total_job_count();
314
    foreach my $count_method (qw(semaphored_job_count ready_job_count inprogress_job_count done_job_count failed_job_count)) {
315
        if( my $count = $count_hash{$count_method} = $self->$count_method() ) {
316
317
            $this_length += length("$count") + 1;
            push @count_list, _text_with_status_color(undef, $color_enabled, $count, $count_method_2_meta_status{$count_method}).substr($count_method,0,1);
318
319
        }
    }
320
    my $breakout_label = join('+', @count_list);
321
    $this_length += scalar(@count_list)-1 if @count_list;
322
    $breakout_label .= '='.$total_job_count if(scalar(@count_list)!=1); # only provide a total if multiple or no categories available
323
324
325
    $this_length += 1+length("$total_job_count") if(scalar(@count_list)!=1);

    $breakout_label = ' ' x ($field_size - $this_length) . $breakout_label if $field_size and $this_length<$field_size;
326

327
    return ($breakout_label, $total_job_count, \%count_hash);
328
329
}

330
331
332
333
334
335
336
337
338
339
340
341
342
343
sub friendly_avg_job_runtime {
    my $self = shift;

    my $avg = $self->avg_msec_per_job;
    my @units = ([24*3600*1000, 'day'], [3600*1000, 'hr'], [60*1000, 'min'], [1000, 'sec']);

    while (my $unit_description = shift @units) {
        my $x = $avg / $unit_description->[0];
        if ($x >= 1.) {
            return ($x, $unit_description->[1]);
        }
    }
    return ($avg, 'ms');
}
344

345
346
sub toString {
    my $self = shift @_;
347
    my $max_logic_name_length = shift || 40;
348

349
350
    my $can_do_colour                                   = (-t STDOUT ? 1 : 0);
    my ($breakout_label, $total_job_count, $count_hash) = $self->job_count_breakout(24, $can_do_colour);
351
    my $analysis                                        = $self->analysis;
352
    my ($avg_runtime, $avg_runtime_unit)                = $self->friendly_avg_job_runtime;
353

354
    my $output .= sprintf("%-${max_logic_name_length}s(%3d) %s, jobs( %s ), avg:%5.1f %-3s, workers(Running:%d, Est.Required:%d) ",
355
        $analysis->logic_name,
356
        $self->analysis_id // 0,
357

358
        _text_with_status_color(11, $can_do_colour, $self->status, $analysis_status_2_meta_status{$self->status} || $self->status),
359

360
        $breakout_label,
361

362
        $avg_runtime, $avg_runtime_unit,
363
364

        $self->num_running_workers,
365
        $self->estimate_num_required_workers,
366
    );
367
368
    $output .=  '  h.cap:'    .( $self->hive_capacity // '-' )
               .'  a.cap:'    .( $analysis->analysis_capacity // '-')
369
               ."  (sync'd "  .($self->seconds_since_when_updated // 0)." sec ago)";
370
371

    return $output;
372
373
}

374
375
376
377

sub check_blocking_control_rules {
    my $self = shift;
  
378
    my $ctrl_rules = $self->analysis->control_rules_collection();
379

380
    my $all_conditions_satisfied = 1;
381

Leo Gordon's avatar
Leo Gordon committed
382
    if(scalar @$ctrl_rules) {    # there are blocking ctrl_rules to check
383
384
385
386
387

        foreach my $ctrl_rule (@$ctrl_rules) {
                #use this method because the condition_analysis objects can be
                #network distributed to a different database so use it's adaptor to get
                #the AnalysisStats object
388
389
390
391
            my $condition_analysis  = $ctrl_rule->condition_analysis;
            my $condition_stats     = $condition_analysis && $condition_analysis->stats;
            my $condition_status    = $condition_stats    && $condition_stats->status;
            my $condition_cbe       = $condition_analysis && $condition_analysis->can_be_empty;
Leo Gordon's avatar
Leo Gordon committed
392
            my $condition_tjc       = $condition_stats    && $condition_stats->total_job_count;
393

394
            my $this_condition_satisfied = ($condition_status eq 'DONE')
395
                        || ($condition_cbe && !$condition_tjc);             # probably safer than saying ($condition_status eq 'EMPTY') because of the sync order
Leo Gordon's avatar
Leo Gordon committed
396

397
398
            unless( $this_condition_satisfied ) {
                $all_conditions_satisfied = 0;
399
400
401
            }
        }

402
        if($all_conditions_satisfied) {
403
            if($self->status eq 'BLOCKED') {    # unblock, since all conditions are met
404
                $self->status('LOADING');       # anything that is not 'BLOCKED' will do, it will be redefined in the following subroutine
405
406
            }
        } else {    # (re)block
407
            $self->status('BLOCKED');
408
409
        }
    }
Leo Gordon's avatar
Leo Gordon committed
410

411
    return $all_conditions_satisfied;
412
413
414
}


415
416
417
418
sub determine_status {
    my $self = shift;

    if($self->status ne 'BLOCKED') {
419
        if( !$self->total_job_count ) {
420

421
            $self->status('EMPTY');
422

423
        } elsif( $self->total_job_count == $self->done_job_count + $self->failed_job_count ) {   # all jobs of the analysis have been finished
424
            my $analysis = $self->analysis;
425
            my $absolute_tolerance = $analysis->failed_job_tolerance * $self->total_job_count / 100.0;
426
427
            if ($self->failed_job_count > $absolute_tolerance) {
                $self->status('FAILED');
428
429
430
431
                warn       "\n##################################################\n";
                warn sprintf("##   ERROR: %-35s ##\n", $analysis->logic_name." failed!");
                warn sprintf("##     %d jobs failed (tolerance: %d (%3d%%)) ##\n", $self->failed_job_count, $absolute_tolerance, $analysis->failed_job_tolerance);
                warn         "##################################################\n\n";
432
433
434
            } else {
                $self->status('DONE');
            }
435
436
437
438
439
        } elsif( $self->ready_job_count && !$self->inprogress_job_count ) { # there are claimable jobs, but nothing actually running

            $self->status('READY');

        } elsif( !$self->ready_job_count ) {                                # there are no claimable jobs, possibly because some are semaphored
440
441
442

            $self->status('ALL_CLAIMED');

443
        } elsif( $self->inprogress_job_count ) {
444
445
446
447
448
449
450

            $self->status('WORKING');
        }
    }
}


451
452
453
454
455
456
457
458
sub recalculate_from_job_counts {
    my ($self, $job_counts) = @_;

        # only update job_counts if given the hash:
    if($job_counts) {
        $self->semaphored_job_count( $job_counts->{'SEMAPHORED'} || 0 );
        $self->ready_job_count(      $job_counts->{'READY'} || 0 );
        $self->failed_job_count(     $job_counts->{'FAILED'} || 0 );
459
        $self->done_job_count(       ( $job_counts->{'DONE'} // 0 ) + ($job_counts->{'PASSED_ON'} // 0 ) ); # done here or potentially done elsewhere
460
461
462
463
464
465
466
467
468
        $self->total_job_count(      sum( values %$job_counts ) || 0 );
    }

    $self->check_blocking_control_rules();

    $self->determine_status();
}


469
1;