summaryrefslogtreecommitdiff
path: root/bin/swift-bench
blob: c1b899727a7c86ee8abb46574050a419ed7e1e92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
#!/usr/bin/env python
# Copyright (c) 2010-2012 OpenStack Foundation
#
# 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.

import logging
import os
import sys
import signal
import uuid
from optparse import OptionParser

from six.moves import range

from swiftbench.bench import (BenchController, DistributedBenchController,
                              create_containers, delete_containers)
from swiftbench.utils import readconf, config_true_value

# The defaults should be sufficient to run swift-bench on a SAIO
CONF_DEFAULTS = {
    'auth': os.environ.get('ST_AUTH', ''),
    'user': os.environ.get('ST_USER', ''),
    'key': os.environ.get('ST_KEY', ''),
    'auth_version': '1.0',
    'use_proxy': 'yes',
    'put_concurrency': '10',
    'get_concurrency': '10',
    'del_concurrency': '10',
    'concurrency': '',  # set all 3 in one shot
    'object_sources': '',  # set of file contents to read and use for PUTs
    'lower_object_size': '10',  # bounded random size used if these differ
    'upper_object_size': '10',
    'object_size': '1',  # only if not object_sources and lower == upper
    'num_objects': '1000',
    'num_gets': '10000',
    'delete': 'yes',
    'container_name': uuid.uuid4().hex,  # really "container name base"
    'num_containers': '20',
    'url': '',  # used when use_proxy = no or overrides auth X-Storage-Url
    'account': '',  # used when use_proxy = no
    'devices': 'sdb1',  # space-sep list
    'log_level': 'INFO',
    'timeout': '10',
    'delay': '0',
    'bench_clients': [],
}

SAIO_DEFAULTS = {
    'auth': 'http://localhost:8080/auth/v1.0',
    'user': 'test:tester',
    'key': 'testing',
}

if __name__ == '__main__':
    usage = "usage: %prog [OPTIONS] [CONF_FILE]"
    usage += """\n\nConf file with SAIO defaults:

    [bench]
    auth = http://localhost:8080/auth/v1.0
    user = test:tester
    key = testing
    concurrency = 10
    object_size = 1
    num_objects = 1000
    num_gets = 10000
    delete = yes
    auth_version = 1.0
    policy_name = gold
    """
    parser = OptionParser(usage=usage)
    parser.add_option('', '--saio', dest='saio', action='store_true',
                      default=False, help='Run benchmark with SAIO defaults')
    parser.add_option('-A', '--auth', dest='auth',
                      help='URL for obtaining an auth token')
    parser.add_option('-U', '--user', dest='user',
                      help='User name for obtaining an auth token')
    parser.add_option('-K', '--key', dest='key',
                      help='Key for obtaining an auth token')
    parser.add_option('-b', '--bench-clients', action='append',
                      metavar='<ip>:<port>',
                      help=('A string of the form "<ip>:<port>" which matches '
                            'the arguments supplied to a swift-bench-client '
                            'process.  This argument must be specified '
                            'once per swift-bench-client you want to '
                            'utilize.'))
    parser.add_option('-u', '--url', dest='url',
                      help='Storage URL')
    parser.add_option('-c', '--concurrency', dest='concurrency',
                      help=('Number of concurrent connections to use. For '
                            'finer-grained control, see --get-concurrency, '
                            '--put-concurrency, and --delete-concurrency.'))
    parser.add_option('--get-concurrency', dest='get_concurrency',
                      help='Number of concurrent GET requests')
    parser.add_option('--put-concurrency', dest='put_concurrency',
                      help='Number of concurrent PUT requests')
    parser.add_option('--delete-concurrency', dest='delete_concurrency',
                      help='Number of concurrent DELETE requests')
    parser.add_option('-s', '--object-size', dest='object_size',
                      help='Size of objects to PUT (in bytes)')
    parser.add_option('-l', '--lower-object-size', dest='lower_object_size',
                      help=('Lower size of objects (in bytes); '
                            '--object-size will be upper-object-size'))
    parser.add_option('-n', '--num-objects', dest='num_objects',
                      help='Number of objects to PUT')
    parser.add_option('-g', '--num-gets', dest='num_gets',
                      help='Number of GET operations to perform')
    parser.add_option('-C', '--num-containers', dest='num_containers',
                      help='Number of containers to distribute objects among')
    parser.add_option('-x', '--no-delete', dest='delete', action='store_false',
                      help='If set, will not delete the objects created')
    parser.add_option('-V', '--auth_version', dest='auth_version',
                      help='Authentication version')
    parser.add_option('-d', '--delay', dest='delay',
                      help='Delay before delete requests in seconds')
    parser.add_option('-P', '--policy-name', dest='policy_name',
                      help='Specify which policy to use when creating '
                           'containers')

    if len(sys.argv) == 1:
        parser.print_help()
        sys.exit(1)
    options, args = parser.parse_args()
    if options.saio:
        CONF_DEFAULTS.update(SAIO_DEFAULTS)
    if getattr(options, 'lower_object_size', None):
        if options.object_size <= options.lower_object_size:
            raise ValueError('--lower-object-size (%s) must be '
                             '< --object-size (%s)' %
                             (options.lower_object_size, options.object_size))
        CONF_DEFAULTS['upper_object_size'] = options.object_size
    if args:
        conf = args[0]
        if not os.path.exists(conf):
            sys.exit("No such conf file: %s" % conf)
        conf = readconf(conf, 'bench', log_name='swift-bench',
                        defaults=CONF_DEFAULTS)
        conf['bench_clients'] = []
    else:
        conf = CONF_DEFAULTS
    parser.set_defaults(**conf)
    options, _junk = parser.parse_args()

    if options.concurrency is not '':
        options.put_concurrency = options.concurrency
        options.get_concurrency = options.concurrency
        options.del_concurrency = options.concurrency
    options.containers = ['%s_%d' % (options.container_name, i)
                          for i in range(int(options.num_containers))]

    # Turn "yes"/"no"/etc. strings to booleans
    options.use_proxy = config_true_value(options.use_proxy)
    options.delete = config_true_value(options.delete)

    def sigterm(signum, frame):
        sys.exit('Termination signal received.')
    signal.signal(signal.SIGTERM, sigterm)

    logger = logging.getLogger('swift-bench')
    logger.propagate = False
    logger.setLevel({
        'debug': logging.DEBUG,
        'info': logging.INFO,
        'warning': logging.WARNING,
        'error': logging.ERROR,
        'critical': logging.CRITICAL}.get(
            options.log_level.lower(), logging.INFO))
    loghandler = logging.StreamHandler()
    logger.addHandler(loghandler)
    logformat = logging.Formatter(
        'swift-bench %(asctime)s %(levelname)s %(message)s')
    loghandler.setFormatter(logformat)

    if options.use_proxy:
        create_containers(logger, options)

    controller_class = DistributedBenchController if options.bench_clients \
        else BenchController
    controller = controller_class(logger, options)
    controller.run()

    if options.use_proxy and options.delete:
        delete_containers(logger, options)