给OpenStack扩展自定义功能

博客分类：
• OpenStack

openstacknovapython

得益于OpenStack的良好架构，对OpenStack进行扩展非常方便，每个模块都留出了各种接口和扩展点，能够让用户扩展自定义功能。下面以操作记录为例子，介绍一下如何扩展nova-api组件。

需求：
用户的一些重要操作必须记录下来，方便进行事后查询，比如instance的创建、销毁，比如公网IP的申请、分配等等。

实现：
因为所有的这些操作都是通过调用nova-api进行，我们要对nova-api进行扩展，记录相关的请求。nova-api是基于Python Paste来构建的，只需要在配置文件里面进行修改(nova-api-paste.ini)，在pipeline上添加一个名为audit的filter：

Text代码  

1. [pipeline:openstackapi11]  
2. pipeline = faultwrap authtoken keystonecontext ratelimit audit extensions osapiapp11  
3.   
4. [filter:audit]  
5. paste.filter_factory = nova.api.openstack.audit:AuditMiddleware.factory  

然后我们写一个Middleware:

Python代码  

1. import time  
2.   
3. from nova import log as logging  
4. from nova import wsgi as base_wsgi  
5. from nova.api.openstack import wsgi  
6.   
7.   
8. LOG = logging.getLogger('nova.api.audit')  
9.   
10. class AuditMiddleware(base_wsgi.Middleware):  
11.     """store POST/PUT/DELETE api request for audit."""  
12.     def __init__(self, application, audit_methods='POST,PUT,DELETE'):  
13.         base_wsgi.Middleware.__init__(self, application)  
14.         self._audit_methods = audit_methods.split(",")  
15.   
16.     def process_request(self, req):  
17.         self._need_audit = req.method in self._audit_methods  
18.         if self._need_audit:  
19.             self._request = req  
20.             self._requested_at = time.time()  
21.   
22.     def process_response(self, response):  
23.         if self._need_audit and response.status_int >= 200 and response.status_int < 300:  
24.             self._store_log(response)  
25.         return response  
26.   
27.     def _store_log(self, response):  
28.         req = self._request  
29.         LOG.info("tenant: %s, user: %s, %s: %s, at: %s",  
30.             req.headers.get('X-Tenant', 'admin'),  
31.             req.headers.get('X-User', 'admin'),  
32.             req.method,  
33.             req.path_info,  
34.             self._requested_at)  

重启一下nova-api进程，然后在dashboard上做一些操作，我们就能在日志文件里面看到如下的信息：

Text代码  

1. tenant: 1, user: admin, POST: /1/os-security-group-rules, at: 1326352441.16  
2. tenant: 1, user: admin, DELETE: /1/servers/32, at: 1326353021.58  

这里默认记录所有的非GET请求，如果不想将PUT请求记录（PUT对应更新），在配置文件里面更改一下：

Text代码  

1. [filter:audit]  
2. audit_methods=POST,DELETE  

更进一步，可以将_store_log改造一下，将数据保存到数据库，我们可以在配置文件里面添加数据库的连接信息等，然后利用API Extension来写一个扩展API，提供查询租户audit log的api功能。