AnalysisStats.pm 12.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

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

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

48

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


54
55
56
57
58
59
    ## 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;
}

60

61
62
63
64
65
66
=head1 AUTOLOADED

    analysis_id / analysis

=cut

67

68
69
70
71
72
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'};
73
74
}

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

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


88
## counters of jobs in different states:
89

90

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

97
sub semaphored_job_count {
98
    my $self = shift;
99
100
101
102
103
104
105
106
    $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'};
107
108
}

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

115
sub failed_job_count {
116
    my $self = shift;
117
118
119
120
121
122
123
124
125
    $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'};
126
127
}

128
sub num_required_workers {      # NB: the meaning of this field is, again, "how many extra workers we need to add"
129
130
131
132
133
134
135
136
137
    my $self = shift;
    $self->{'_num_required_workers'} = shift if(@_);
    return $self->{'_num_required_workers'};
}


## dynamic hive_capacity mode attributes:


138
sub behaviour {
139
140
141
    my $self = shift;
    $self->{'_behaviour'} = shift if(@_);
    return $self->{'_behaviour'};
142
143
144
}

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

sub output_capacity {
151
152
153
    my $self = shift;
    $self->{'_output_capacity'} = shift if(@_);
    return $self->{'_output_capacity'};
154
155
}

156

157
## dynamic hive_capacity mode counters:
158

159
160

sub avg_msec_per_job {
161
    my $self = shift;
162
163
164
    $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'};
165
166
}

167
sub avg_input_msec_per_job {
168
    my $self = shift;
169
170
171
    $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'};
172
173
}

174
sub avg_run_msec_per_job {
175
    my $self = shift;
176
177
178
    $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'};
179
180
}

181
sub avg_output_msec_per_job {
182
    my $self = shift;
183
184
185
    $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'};
186
187
}

188

189
## other storable attributes:
190

191
sub when_updated {                   # this method is called by the initial store() [at which point it returns undef]
192
    my $self = shift;
193
194
    $self->{'_when_updated'} = shift if(@_);
    return $self->{'_when_updated'};
195
}
196

197
sub seconds_since_when_updated {     # this method is mostly used to convert between server time and local time
198
    my( $self, $value ) = @_;
199
200
    $self->{'_when_updated'} = time() - $value if(defined($value));
    return defined($self->{'_when_updated'}) ? time() - $self->{'_when_updated'} : undef;
201
202
}

203
204
205
206
sub sync_lock {
    my $self = shift;
    $self->{'_sync_lock'} = shift if(@_);
    return $self->{'_sync_lock'};
207
208
}

209
210
211
212
213
214
215
216

# non-storable attributes and other helper-methods:


sub refresh {
    my $self = shift;

    return $self->adaptor && $self->adaptor->refresh($self);
217
218
}

219
220
sub update {
    my $self = shift;
221
222
223
224

    if($self->adaptor) {
        $self->adaptor->update($self);
    }
225
226
}

227

228
sub get_or_estimate_batch_size {
229
230
    my $self = shift;

231
232
233
234
235
236
237
238
239
240
241
242
243
    if( (my $batch_size = $self->batch_size())>0 ) {        # set to positive or not set (and auto-initialized within $self->batch_size)

        return $batch_size;
                                                        # otherwise it is a request for dynamic estimation:
    } elsif( my $avg_msec_per_job = $self->avg_msec_per_job() ) {           # further estimations from collected stats

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

        return POSIX::ceil( $self->min_batch_time() / $avg_msec_per_job );

    } else {        # first estimation when no stats are available (take -$batch_size as first guess, if not zero)
        return -$batch_size || 1;
    }
244
}
245

246

247
sub inprogress_job_count {      # includes CLAIMED
248
249
250
251
252
253
254
    my $self = shift;
    return    $self->total_job_count
            - $self->semaphored_job_count
            - $self->ready_job_count
            - $self->done_job_count
            - $self->failed_job_count;
}
255

256

257
258
259
sub job_count_breakout {
    my $self = shift;

260
261
262
    my @count_list = ();
    my %count_hash = ();
    my $total_job_count = $self->total_job_count();
263
    foreach my $count_method (qw(semaphored_job_count ready_job_count inprogress_job_count done_job_count failed_job_count)) {
264
265
        if( my $count = $count_hash{$count_method} = $self->$count_method() ) {
            push @count_list, $count.substr($count_method,0,1);
266
267
        }
    }
268
269
    my $breakout_label = join('+', @count_list);
    $breakout_label .= '='.$total_job_count if(scalar(@count_list)!=1); # only provide a total if multiple or no categories available
270

271
    return ($breakout_label, $total_job_count, \%count_hash);
272
273
274
}


275
276
sub toString {
    my $self = shift @_;
277
    my $max_logic_name_length = shift || 40;
278

279
280
    my ($breakout_label, $total_job_count, $count_hash) = $self->job_count_breakout;
    my $analysis                                        = $self->analysis;
281

282
    my $output .= sprintf("%-${max_logic_name_length}s(%2d) %11s, jobs( %24s ), ave_msec:%d, workers(Running:%d, Reqired:%d) ",
283
        $analysis->logic_name,
284
        $self->analysis_id // 0,
285

286
        $self->status,
287

288
        $breakout_label,
289

290
        $self->avg_msec_per_job,
291
292
293

        $self->num_running_workers,
        $self->num_required_workers,
294
    );
295
296
    $output .=  '  h.cap:'    .( $self->hive_capacity // '-' )
               .'  a.cap:'    .( $analysis->analysis_capacity // '-')
297
               ."  (sync'd "  .($self->seconds_since_when_updated // 0)." sec ago)";
298
299

    return $output;
300
301
}

302
303
304
305

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

308
    my $all_conditions_satisfied = 1;
309

Leo Gordon's avatar
Leo Gordon committed
310
    if(scalar @$ctrl_rules) {    # there are blocking ctrl_rules to check
311
312
313
314
315

        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
316
317
318
319
            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
320
            my $condition_tjc       = $condition_stats    && $condition_stats->total_job_count;
321

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

325
326
            unless( $this_condition_satisfied ) {
                $all_conditions_satisfied = 0;
327
328
329
            }
        }

330
        if($all_conditions_satisfied) {
331
            if($self->status eq 'BLOCKED') {    # unblock, since all conditions are met
332
                $self->status('LOADING');       # anything that is not 'BLOCKED' will do, it will be redefined in the following subroutine
333
334
            }
        } else {    # (re)block
335
            $self->status('BLOCKED');
336
337
        }
    }
Leo Gordon's avatar
Leo Gordon committed
338

339
    return $all_conditions_satisfied;
340
341
342
}


343
344
345
346
sub determine_status {
    my $self = shift;

    if($self->status ne 'BLOCKED') {
347
        if( !$self->total_job_count ) {
348

349
            $self->status('EMPTY');
350

351
        } elsif( $self->total_job_count == $self->done_job_count + $self->failed_job_count ) {   # all jobs of the analysis have been finished
352
            my $analysis = $self->analysis;
353
            my $absolute_tolerance = $analysis->failed_job_tolerance * $self->total_job_count / 100.0;
354
355
            if ($self->failed_job_count > $absolute_tolerance) {
                $self->status('FAILED');
356
357
358
359
                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";
360
361
362
            } else {
                $self->status('DONE');
            }
363
364
365
366
367
        } 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
368
369
370

            $self->status('ALL_CLAIMED');

371
        } elsif( $self->inprogress_job_count ) {
372
373
374
375
376
377
378

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


379
380
381
382
383
384
385
386
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 );
387
        $self->done_job_count(       ( $job_counts->{'DONE'} // 0 ) + ($job_counts->{'PASSED_ON'} // 0 ) ); # done here or potentially done elsewhere
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
        $self->total_job_count(      sum( values %$job_counts ) || 0 );
    }

        # compute the number of total required workers for this analysis (taking into account the jobs that are already running)
    my $analysis              = $self->analysis();
    my $scheduling_allowed    =  ( !defined( $self->hive_capacity ) or $self->hive_capacity )
                              && ( !defined( $analysis->analysis_capacity  ) or $analysis->analysis_capacity  );
    my $required_workers    = $scheduling_allowed
                            && POSIX::ceil( $self->ready_job_count() / $self->get_or_estimate_batch_size() );
    $self->num_required_workers( $required_workers );

    $self->check_blocking_control_rules();

    $self->determine_status();
}


405
1;