Class: Arachni::Plugins::AutoThrottle

Inherits:
Arachni::Plugin::Base show all
Defined in:
components/plugins/defaults/autothrottle.rb

Overview

Auto adjusts HTTP throughput for maximum network utilization.

Author:

Constant Summary collapse

THRESHOLD =

Will decrease concurrency if the average response time for each burst is above this threshold.

One second per response does not exactly say healthy server.

1
STEP_UP =

Easy on the throttle.

1
STEP_DOWN =

Hard on the breaks.

-2
MIN_CONCURRENCY =

Don't drop bellow this.

2

Constants included from Arachni

BANNER, Cookie, Form, Header, JSON, Link, LinkTemplate, NestedCookie, Severity, UIForm, UIInput, VERSION, WEBSITE, WIKI, XML

Instance Attribute Summary

Attributes inherited from Arachni::Plugin::Base

#framework, #options

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Arachni::Plugin::Base

#browser_cluster, #clean_up, distributable, distributable?, #framework_abort, #framework_pause, #framework_resume, gems, #http, #info, #initialize, is_distributable, merge, #register_results, #restore, #run, #session, #suspend, #wait_while_framework_running, #with_browser

Methods inherited from Component::Base

author, description, fullname, #shortname, shortname, shortname=, version

Methods included from Component::Output

#depersonalize_output, #depersonalize_output?, #intercept_print_message

Methods included from UI::Output

#caller_location, #debug?, #debug_level, #debug_level_1?, #debug_level_2?, #debug_level_3?, #debug_level_4?, #debug_off, #debug_on, #disable_only_positives, #error_buffer, #error_log_fd, #error_logfile, #has_error_log?, #included, #log_error, #mute, #muted?, #only_positives, #only_positives?, #print_bad, #print_debug, #print_debug_backtrace, #print_debug_exception, #print_debug_level_1, #print_debug_level_2, #print_debug_level_3, #print_debug_level_4, #print_error, #print_error_backtrace, #print_exception, #print_info, #print_line, #print_ok, #print_status, #print_verbose, #reroute_to_file, #reroute_to_file?, reset_output_options, #set_error_logfile, #unmute, #verbose?, #verbose_off, #verbose_on

Methods included from Component::Utilities

#read_file

Methods included from Utilities

#available_port, available_port_mutex, #bytes_to_kilobytes, #bytes_to_megabytes, #caller_name, #caller_path, #cookie_decode, #cookie_encode, #cookies_from_file, #cookies_from_parser, #cookies_from_response, #exception_jail, #exclude_path?, #follow_protocol?, #form_decode, #form_encode, #forms_from_parser, #forms_from_response, #full_and_absolute_url?, #generate_token, #get_path, #hms_to_seconds, #html_decode, #html_encode, #include_path?, #links_from_parser, #links_from_response, #normalize_url, #page_from_response, #page_from_url, #parse_set_cookie, #path_in_domain?, #path_too_deep?, #port_available?, #rand_port, #random_seed, #redundant_path?, #regexp_array_match, #remove_constants, #request_parse_body, #seconds_to_hms, #skip_page?, #skip_path?, #skip_resource?, #skip_response?, #to_absolute, #uri_decode, #uri_encode, #uri_parse, #uri_parse_query, #uri_parser, #uri_rewrite

Methods included from Arachni

URI, collect_young_objects, #get_long_win32_filename, jruby?, null_device, profile?, windows?

Constructor Details

This class inherits a constructor from Arachni::Plugin::Base

Class Method Details

.infoObject


69
70
71
72
73
74
75
76
77
78
79
80
# File 'components/plugins/defaults/autothrottle.rb', line 69

def self.info
    {
        name:        'AutoThrottle',
        description: %q{
Monitors HTTP response times and automatically throttles the request concurrency
in order to maintain stability and avoid from killing the server.
},
        author:      'Tasos "Zapotek" Laskos <[email protected]>',
        tags:        %w(meta http throttle),
        version:     '0.1.6'
    }
end

Instance Method Details

#prepareObject


31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'components/plugins/defaults/autothrottle.rb', line 31

def prepare
    http = framework.http

    # Run for each response as it arrives
    http.on_complete do
        # Adjust on a per-burst basis.
        next if http.burst_response_count == 0 ||
            http.burst_response_count % http.max_concurrency != 0

        response_time = http.burst_average_response_time

        if http.max_concurrency > MIN_CONCURRENCY &&
            response_time >= THRESHOLD

            # No-matter what, don't fall bellow the minimum concurrency.
            http.max_concurrency = [
                http.max_concurrency + STEP_DOWN,
                MIN_CONCURRENCY
            ].max

            print_info "Decreasing HTTP request concurrency to #{http.max_concurrency}."
            print_info "Average response time for this burst: #{response_time}"

        elsif http.max_concurrency < http.original_max_concurrency &&
            response_time < THRESHOLD

            # No-matter what, don't exceed the original maximum concurrency.
            http.max_concurrency = [
                http.max_concurrency + STEP_UP,
                http.original_max_concurrency
            ].min

            print_info "Increasing HTTP request concurrency to #{http.max_concurrency} (+#{STEP_UP})."
            print_info "Average response time for this burst: #{response_time}"
        end
    end
end