############################################################################## # Copyright (c) 2015 EMC and others. # # All rights reserved. This program and the accompanying materials # are made available under the terms of the Apache License, Version 2.0 # which accompanies this distribution, and is available at # http://www.apache.org/licenses/LICENSE-2.0 ############################################################################## import json import logging.config import os import sys from flask import abort, Flask, request, jsonify from flask_cors import CORS from flask_restful import Resource, Api, fields from flask_restful_swagger import swagger from storperf.storperf_master import StorPerfMaster class ReverseProxied(object): '''Wrap the application in this middleware and configure the front-end server to add these headers, to let you quietly bind this to a URL other than / and to an HTTP scheme that is different than what is used locally. In nginx: location /storperf/ { proxy_pass http://localhost:8085/; proxy_set_header Host $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Scheme $scheme; proxy_set_header X-Script-Name /storperf; } :param app: the WSGI application ''' def __init__(self, app): self.app = app def __call__(self, environ, start_response): script_name = environ.get('HTTP_X_SCRIPT_NAME', '') if script_name: environ['SCRIPT_NAME'] = script_name path_info = environ['PATH_INFO'] if path_info.startswith(script_name): environ['PATH_INFO'] = path_info[len(script_name):] scheme = environ.get('HTTP_X_SCHEME', '') if scheme: environ['wsgi.url_scheme'] = scheme return self.app(environ, start_response) app = Flask(__name__, static_url_path="") CORS(app) api = swagger.docs(Api(app), apiVersion='1.0') app.wsgi_app = ReverseProxied(app.wsgi_app) storperf = StorPerfMaster() class Logs(Resource): def __init__(self): self.logger = logging.getLogger(__name__) @swagger.operation( notes="Fetch logs", parameters=[ { "name": "lines", "description": "The number of lines to fetch", "required": "False", "type": "string", "allowedMultiple": "False", "paramType": "query" } ] ) def get(self): lines = request.args.get('lines') if lines: try: lines = int(lines) except Exception: pass else: lines = 35 return jsonify({'logs': storperf.get_logs(lines)}) @swagger.model class ConfigurationRequestModel: resource_fields = { 'agent_count': fields.Integer, 'agent_flavor': fields.String, 'agent_image': fields.String, 'public_network': fields.String, 'volume_size': fields.Integer, 'availability_zone': fields.String, 'username': fields.String, 'password': fields.String } @swagger.model class ConfigurationResponseModel: resource_fields = { 'agent_count': fields.Integer, 'agent_flavor': fields.String, 'agent_image': fields.String, 'public_network': fields.String, 'stack_created': fields.Boolean, 'stack_id': fields.String, 'volume_size': fields.Integer, 'availability_zone': fields.String } class Configure(Resource): """Configuration API""" def __init__(self): self.logger = logging.getLogger(__name__) @swagger.operation( notes='Fetch the current agent configuration', type=ConfigurationResponseModel.__name__ ) def get(self): return jsonify({'agent_count': storperf.agent_count, 'agent_flavor': storperf.agent_flavor, 'agent_image': storperf.agent_image, 'public_network': storperf.public_network, 'volume_size': storperf.volume_size, 'stack_created': storperf.is_stack_created, 'availability_zone': storperf.availability_zone, 'stack_id': storperf.stack_id}) @swagger.operation( notes='''Set the current agent configuration and create a stack in the controller. Returns once the stack create is completed.''', parameters=[ { "name": "configuration", "description": '''Configuration to be set. All parameters are optional, and will retain their previous value if not specified. Volume size is in GB. ''', "required": True, "type": "ConfigurationRequestModel", "paramType": "body" } ], type=ConfigurationResponseModel.__name__ ) def post(self): if not request.json: abort(400, "ERROR: No data specified") try: if ('agent_count' in request.json): storperf.agent_count = request.json['agent_count'] if ('agent_flavor' in request.json): storperf.agent_flavor = request.json['agent_flavor'] if ('agent_image' in request.json): storperf.agent_image = request.json['agent_image'] if ('public_network' in request.json): storperf.public_network = request.json['public_network'] if ('volume_size' in request.json): storperf.volume_size = request.json['volume_size'] if ('availability_zone' in request.json): storperf.availability_zone = request.json['availability_zone'] if ('username' in request.json): storperf.username = request.json['username'] if ('password' in request.json): storperf.password = request.json['password'] storperf.create_stack() if storperf.stack_id is None: abort(400, storperf.status_reason) return jsonify({'agent_count': storperf.agent_count, 'agent_flavor': storperf.agent_flavor, 'agent_image': storperf.agent_image, 'availability_zone': storperf.availability_zone, 'public_network': storperf.public_network, 'volume_size': storperf.volume_size, 'stack_id': storperf.stack_id}) except Exception as e: self.logger.exception(e) abort(400, str(e)) @swagger.operation( notes='Deletes the agent configuration and the stack' ) def delete(self): try: return jsonify({'stack_id': storperf.delete_stack()}) except Exception as e: self.logger.exception(e) abort(400, str(e)) @swagger.model class WorkloadModel: resource_fields = { 'target': fields.String, 'deadline': fields.Integer, "steady_state_samples": fields.Integer, 'workload': fields.String, 'queue_depths': fields.String, 'block_sizes': fields.String } @swagger.model class WorkloadResponseModel: resource_fields = { 'job_id': fields.String } class Job(Resource): """Job API""" def __init__(self): self.logger = logging.getLogger(__name__) @swagger.operation( notes='Fetch the metrics of the specified workload', parameters=[ { "name": "id", "description": "The UUID of the workload in the format " "NNNNNNNN-NNNN-NNNN-NNNN-NNNNNNNNNNNN", "required": False, "type": "string", "allowMultiple": False, "paramType": "query" }, { "name": "type", "description": "The type of metrics to report. May be " "metrics (default), metadata, or status", "required": False, "type": "string", "allowMultiple": False, "paramType": "query" } ], responseMessages=[ { "code": 200, "message": "Workload ID found, response in JSON format" }, { "code": 404, "message": "Workload ID not found" } ] ) def get(self): workload_id = request.args.get('id') if workload_id: metrics_type = "metrics" if request.args.get('type'): metrics_type = request.args.get('type') if metrics_type == "metrics": return jsonify(storperf.fetch_results(workload_id)) if metrics_type == "metadata": return jsonify(storperf.fetch_metadata(workload_id)) if metrics_type == "status": return jsonify(storperf.fetch_job_status(workload_id)) else: metrics_type = None if request.args.get('type'): metrics_type = request.args.get('type') if metrics_type == "status": return jsonify(storperf.fetch_job_status(workload_id)) else: return jsonify(storperf.fetch_all_jobs(metrics_type)) @swagger.operation( parameters=[ { "name": "body", "description": """Start execution of a workload with the following parameters: "target": The target device to profile", "deadline": if specified, the maximum duration in minutes for any single test iteration. "workload":if specified, the workload to run. Defaults to all. """, "required": True, "type": "WorkloadModel", "paramType": "body" } ], type=WorkloadResponseModel.__name__, responseMessages=[ { "code": 200, "message": "Job submitted" }, { "code": 400, "message": "Missing configuration data" } ] ) def post(self): if not request.json: abort(400, "ERROR: Missing configuration data") self.logger.info(request.json) try: if ('target' in request.json): storperf.filename = request.json['target'] if ('deadline' in request.json): storperf.deadline = request.json['deadline'] if ('steady_state_samples' in request.json): storperf.steady_state_samples = request.json[ 'steady_state_samples'] if ('queue_depths' in request.json): storperf.queue_depths = request.json['queue_depths'] if ('block_sizes' in request.json): storperf.block_sizes = request.json['block_sizes'] if ('workload' in request.json): storperf.workloads = request.json['workload'] else: storperf.workloads = None if ('metadata' in request.json): metadata = request.json['metadata'] else: metadata = {} job_id = storperf.execute_workloads(metadata) return jsonify({'job_id': job_id}) except Exception as e: self.logger.exception(e) abort(400, str(e)) @swagger.operation( notes='Cancels the currently running workload', responseMessages=[ { "code": 200, "message": "Wordload ID found, response in JSON format" }, ] ) def delete(self): self.logger.info("Threads: %s" % sys._current_frames()) print sys._current_frames() try: return jsonify({'Slaves': storperf.terminate_workloads()}) except Exception as e: abort(400, str(e)) @swagger.model class QuotaModel: resource_fields = { 'quota': fields.Integer } class Quota(Resource): """Quota API""" @swagger.operation( notes='''Fetch the current Cinder volume quota. This value limits the number of volumes that can be created, and by extension, defines the maximum number of agents that can be created for any given test scenario''', type=QuotaModel.__name__ ) def get(self): quota = storperf.volume_quota return jsonify({'quota': quota}) def setup_logging(default_path='logging.json', default_level=logging.INFO, env_key='LOG_CFG'): """Setup logging configuration """ path = default_path value = os.getenv(env_key, None) if value: path = value if os.path.exists(path): with open(path, 'rt') as f: config = json.load(f) logging.config.dictConfig(config) else: logging.basicConfig(level=default_level) socketHandler = logging.handlers.DatagramHandler( 'localhost', logging.handlers.DEFAULT_UDP_LOGGING_PORT) rootLogger = logging.getLogger('') rootLogger.addHandler(socketHandler) api.add_resource(Configure, "/api/v1.0/configurations") api.add_resource(Quota, "/api/v1.0/quotas") api.add_resource(Job, "/api/v1.0/jobs") api.add_resource(Logs, "/api/v1.0/logs") if __name__ == "__main__": setup_logging() logging.getLogger("storperf").setLevel(logging.DEBUG) app.run(host='0.0.0.0', debug=True, threaded=True)