Exception: RightAws::AwsError

Inherits:
RuntimeError
  • Object
show all
Defined in:
lib/awsbase/right_awsbase.rb

Overview

Exception class to signal any Amazon errors. All errors occuring during calls to Amazon’s web services raise this type of error. Attribute inherited by RuntimeError:

message    - the text of the error, generally as returned by AWS in its XML response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(errors = nil, http_code = nil, request_id = nil, request_data = nil) ⇒ AwsError

Returns a new instance of AwsError.



438
439
440
441
442
443
444
445
446
 
# File 'lib/awsbase/right_awsbase.rb', line 438

def initialize(errors=nil, http_code=nil, request_id=nil, request_data=nil)
    @errors      = errors
    @request_id  = request_id
    @http_code   = http_code
    @request_data = request_data
    msg = @errors.is_a?(Array) ? @errors.map{|code, msg| "#{code}: #{msg}"}.join("; ") : @errors.to_s
    msg += "\nREQUEST(#{@request_data})" unless @request_data.nil?
    super(msg)
end

Instance Attribute Details

#errors ⇒ Object (readonly)

either an array of errors where each item is itself an array of [code, message]), or an error string if the error was raised manually, as in AwsError.new('err_text')



427
428
429
 
# File 'lib/awsbase/right_awsbase.rb', line 427

def errors
  @errors
end

#http_code ⇒ Object (readonly)

Response HTTP error code



433
434
435
 
# File 'lib/awsbase/right_awsbase.rb', line 433

def http_code
  @http_code
end

#request_data ⇒ Object (readonly)

Raw request text data to AWS



436
437
438
 
# File 'lib/awsbase/right_awsbase.rb', line 436

def request_data
  @request_data
end

#request_id ⇒ Object (readonly)

Request id (if exists)



430
431
432
 
# File 'lib/awsbase/right_awsbase.rb', line 430

def request_id
  @request_id
end

Class Method Details

.on_aws_exception(aws, options = {:raise=>true, :log=>true}) ⇒ Object

Generic handler for AwsErrors. aws is the RightAws::S3, RightAws::EC2, or RightAws::SQS object that caused the exception (it must provide last_request and last_response). Supported boolean options are:

  • :log print a message into the log using aws.logger to access the Logger

  • :puts do a “puts” of the error

  • :raise re-raise the error after logging



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/awsbase/right_awsbase.rb', line 465

def self.on_aws_exception(aws, options={:raise=>true, :log=>true})
    # Only log & notify if not user error
    if !options[:raise] || system_error?($!)
        error_text = "#{$!.inspect}\n#{$@}.join('\n')}"
        puts error_text if options[:puts]
        # Log the error
        if options[:log]
            request  = aws.last_request  ? aws.last_request.path :  '-none-'
            response = aws.last_response ? "#{aws.last_response.code} -- #{aws.last_response.message} -- #{aws.last_response.body}" : '-none-'
            aws.logger.error error_text
            aws.logger.error "Request was:  #{request}"
            aws.logger.error "Response was: #{response}"
        end
    end
    raise if options[:raise]  # re-raise an exception
    return nil
end

.system_error?(e) ⇒ Boolean

True if e is an AWS system error, i.e. something that is for sure not the caller’s fault. Used to force logging.

Returns:

  • (Boolean) 


485
486
487
 
# File 'lib/awsbase/right_awsbase.rb', line 485

def self.system_error?(e)
    !e.is_a?(self) || e.message =~ /InternalError|InsufficientInstanceCapacity|Unavailable/
end

Instance Method Details

#include?(pattern) ⇒ Boolean

Does any of the error messages include the regexp pattern? Used to determine whether to retry request.

Returns:

  • (Boolean) 


450
451
452
453
454
455
456
457
 
# File 'lib/awsbase/right_awsbase.rb', line 450

def include?(pattern)
    if @errors.is_a?(Array)
        @errors.each{ |code, msg| return true if code =~ pattern }
    else
        return true if @errors_str =~ pattern
    end
    false
end