openstack oslo_config 和 oslo_log库

一、oslo.config库的作用和概念理解

openstack中的 oslo.config库用于解析命令行和配置文件中的配置选项，把配置项直接融入代码内。在本文的语境下，有这么几个概念：

配置文件：用来配置OpenStack各个服务的ini风格的配置文件，通常以.conf结尾；

配置项(options)：

　　　　配置文件或命令行中给出的配置信息的左值，如：enabled_apis = ec2, osapi_keystone,osapi_compute中的“enabled_apis”；

配置项的值：   

　　　　配置文件或命令行中给出的配置信息的右值，如：enabled_apis =ec2, osapi_keystone, osapi_compute中的“ec2,osapi_keystone, osapi_compute”；

配置组(option groups)：

　　　　一组配置项，在配置文件中通过[...]来表示，如my.conf文件中的[rabbit]字段表示接下来开始一个名为rabbit的配置组；  默认配置组和添加的配置组

配置项的模式(option schemas)：

　　　　在解析配置文件、获取配置项的值之前，其他模块声明自己需要的配置项。配置文件通常是针对一个完整的服务的，因此其他模块中可能用不到配置文件中的所有配置项，这样就必须告诉系统自己依赖于哪些配置项，这个过程就是设置配置项的模式。包括声明配置项在配置文件的名称、设置配置项的默认值（一旦配置文件中没有该配置项而其他模块又依赖于该配置项，就使用这里声明的默认值）等等；

引用(reference)：　　

　　　　其他模块解析配置文件，获取配置项的值后，就可以在下面的实现中使用这些具体的配置值了；

注册(register)：　

　　　　其他模块在引用配置项的值之前，必须注册自己将要引用的那些配置项的模式。也就是说，配置文件中的配置项其他模块不一定都为其声明模式，声明了模式的配置项也不一定为其进行注册，当然如果不注册，即使声明了模式，也无法引用。

 二、使用库实现文件解析的步骤

下面先给一个high-level的过程说明一下如何使用这个库，OpenStack中配置文件的解析主要有以下几个步骤：

step1. 正确配置服务的主配置文件（*.conf文件），本步骤在各个服务（如：keystone）中完成。

step2. 在要使用到配置信息的模块中声明将用到的那些配置项的模式，包括配置项的名称、数据类型、默认值和说明等；

step3. 创建一个对象，创建该对象的类充当配置管理器，这个对象作为容器以后将存储配置项的值。cfg.CONF 全局配置项管理类。

step4. 调用step3创建的对象中相应的注册方法（如：register_opt()），注册step2中声明的配置项模式。这个过程不会解析配置文件，只是为step3中创建的对象开辟相应的字段。

step5. 直接调用step3中创建的对象，传入配置文件路径等信息。此时将会解析配置文件，如果未指定配置文件则全部使用step2模式中的默认值。解析过程会提取step4中注册了的配置项的值，然后这些配置项就作为step3创建的对象的属性可以被直接引用。

三、程序实例

(1)、使用my.conf   配置文件，使用config.py模块使用配置文件信息。

配置文件信息：my.conf

# my.conf
 
[DEFAULT]  #默认组的配置项
#[DEFAULT]不可省略
enabled_apis = ec2, osapi_keystone, osapi_compute
bind_host = 196.168.73.110
bind_port = 8080
 
[rabbit] #自定义配置组  配置组中的配置项
host = 127.0.0.1
port = 8000
use_ssl=true
user_id = guest
password = guest

使用模块：config.py

# config.py

#cfg.CONF是oslo.config中定义的全局对象实例，  是一个配置项的管理类 
from oslo.config import cfg
# 声明配置项模式
# 单个配置项模式  配置项   配置项的值
enabled_apis_opt = cfg.ListOpt('enabled_apis',
           default=['ec2', 'osapi_compute'],
           help='List of APIs to enable by default.')
# 多个配置项组成一个模式
common_opts = [
        cfg.StrOpt('bind_host',
        default='0.0.0.0',
        help='IP address to listen on.'),
                
        cfg.IntOpt('bind_port',
        default=8080,
        help='Port number to listen on.')
    ]
# 自定义配置组
rabbit_group = cfg.OptGroup(
    name='rabbit',
    title='RabbitMQ options'
)
# 配置组中的模式，通常以配置组的名称为前缀（非必须）  单个配置项模式
rabbit_ssl_opt = cfg.BoolOpt('use_ssl',
          default=False,
          help='use ssl for connection')
# 配置组中的多配置项模式
rabbit_Opts = [
    cfg.StrOpt('host',
         default='localhost',
         help='IP/hostname to listen on.'),
    cfg.IntOpt('port',
         default=8000,
         help='Port number to listen on.')
]
 
# 创建对象CONF，用来充当容器，管理配置项的类实例
CONF = cfg.CONF
# 注册单个配置项模式
CONF.register_opt(enabled_apis_opt)
 
# 注册含有多个配置项的模式
CONF.register_opts(common_opts)
 
# 配置组必须在其配置项被注册前  注册！   注册自定义配置组
CONF.register_group(rabbit_group)
 
# 注册配置组中含有多个配置项的模式，必须指明配置组
CONF.register_opts(rabbit_Opts, rabbit_group)
 
# 注册配置组中的单配置项模式，指明配置组
CONF.register_opt(rabbit_ssl_opt, rabbit_group)
 
# 接下来打印使用配置项的值
if __name__ =="__main__":
    # 调用容器对象，传入要解析的文件（可以多个）
　　CONF(default_config_files=['my.conf'])
     
    for i in CONF.enabled_apis:
        print "DEFAULT.enabled_apis: " + i
     
    print "DEFAULT.bind_host: " + CONF.bind_host
    print "DEFAULT.bind_port: " + str(CONF.bind_port)
    print "rabbit.use_ssl: "+ str(CONF.rabbit.use_ssl)
    print "rabbit.host: " + CONF.rabbit.host
    print "rabbit.port: " + str(CONF.rabbit.port)

可以发现，执行config.py时，成功读取了配置项的值，如果没有指定要解析的配置文件，所以使用的都是设置模式时指定的默认值。

OpenStack的oslo.config项目提供了一种开放的配置项解析工具，可以在其上实现自己需要的命令行和配置文件解析工具，也可以直接应用到自己的项目中。

原文地址：http://www.cnblogs.com/Security-Darren/p/3854797.html

(2)、

命令行参数的解析

config.py:

from config import cfg

opts = [
    cfg.StrOpt('bind_host', default='0.0.0.0'),
]
cli_opts = [
    cfg.IntOpt('bind_port', default=9292), #命令
]

CONF = cfg.CONF
CONF.register_opts(opts)
CONF.register_cli_opts(cli_opts)

print CONF.bind_host # 注册就直接使用   没有加载配置文件
print CONF.bind_port

CONF(args=sys.argv[1:]) # 解析命令行参数 配置文件
print CONF.bind_host
print CONF.bind_port

my.conf:

[DEFAULT]
bind_host = 192.168.0.1
bind_port = 55553

前面先注册options，然后直接使用，后面再解析命令行参数和配置文件，然后再使用配置选项，从运行的结果来看，文件中的配置值重载了注册时的默认值，命

令行中指定的值重载了配置文件中写入的值。

python config.py --config-file ./oslo.conf --bind_port = 9090

(3)、

app.conf:

[DEFAULT]  
username=app  
  
[rabbit]  
host = 192.168.1.7  
port = 5672  

myconfig.py:

import sys  
from oslo_config import cfg  
  
#默认组的配置项  
service_opts = [  
    cfg.StrOpt('username',  
               default='default',  
               help='user name'),  
    cfg.StrOpt('password',  
               help='password')  
]  
  
#自定义配置组  
rabbit_group = cfg.OptGroup(  
    name='rabbit',   
    title='RabbitMQ options'  
)  
  
# 配置组中的多配置项模式   
rabbit_Opts = [  
    cfg.StrOpt('host',  
               default='localhost',  
               help='IP/hostname to listen on.'),  
    cfg.IntOpt('port',  
               default=5672,  
               help='Port number to listen on.')  
]  
  
  
CONF = cfg.CONF  
#注册默认组的配置项  
CONF.register_opts(service_opts)  
#配置组必须在其组件被注册前注册！  
CONF.register_group(rabbit_group)  
#注册配置组中含有多个配置项的模式，必须指明配置组  
CONF.register_opts(rabbit_Opts, rabbit_group)  
  
  
#设置默认的日志文件名  加载配置文件 
CONF(sys.argv[1:], default_config_files=['app.conf'])  
  
#使用配置项  
print ("username=%s  rabbitmq.host=%s " % (CONF.username, CONF.rabbit.host))

from oslo_config import cfg  
from oslo_log import log as logging  
  
LOG = logging.getLogger(__name__)  
CONF = cfg.CONF  
DOMAIN = "demo"  
  
logging.register_options(CONF)  
logging.setup(CONF, DOMAIN)  
  
# Oslo Logging uses INFO as default  
LOG.info("Oslo Logging")  
LOG.warning("Oslo Logging")  
LOG.error("Oslo Logging")

总结：

(1)、定义和注册配置选项。

cfg.CONF是全局对象实例，用来管理配置项。    默认组配置项 自定义组配置项。  注册默认组的配置项   

将配置选项注册为命令行选项。 cfg.CONF.register_cli_opts(CLI_OPTIONS,group='service_credentials') 注册命令行配置项的时候需要指明组

(2)、实用配置文件和命令行选项置顶配置选项

CONF(sys.argv[1:]) 或者CONF(default_config_files=['app.conf']) 初始化之后才能正常解析文件和命令行选项。  ‘--config-file’或者‘--config-dir’来指定配置文件名。 用命令行指定配置选项值时，如果是定义在某个选项组中的选项，命令行选项中需要包括该组名作为前缀： --service_credentials-os-tenant-id 123456

(3)、使用其他模块中已经注册过得配置选项