欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Ganglia python扩展 - mod_python.c源码分析(2)

程序员文章站 2022-04-17 20:45:24
...
续上文
七.   metric_init初始化过程
在metric_init函数中每个metric至少定义以下项中的前八项:
d = {
'name': '<your_metric_name>',          // metric name,指标名称
'call_back': <metric_handler_function>,     // 回调函数
'time_max': int(<your_time_max>),      // 以秒为单位的收集时调用函数的最大时间间隔
'value_type': '<string | uint | float | double>',        // 输出值的类型
'units': '<your_units>',   // 输出值的单位
'slope': '<zero | positive | negative | both>',    // 这个值映射到为RRDTool定义的数据源类型
                                                                            // postive:生成的RRD文件是COUNTER类型的(计算变化的速率)
                                                                            // negative: (官方的也是如此)
                                                                            // both:是GAUGE类型(没有计算,仅仅以报告的值绘图)
                                                                            // zero:这个度量会被呈现在"Time and String Metrics" 或者 
                                                                            // "Constant Metrics",取决于度量的单位
'format': '<your_format>',            // 度量的格式字符串,必须符合value_type,否则你的度量就会未知
'description': '<your_description>',           // metric的描述信息
'groups':'<group1, group2, group3>',        // 度量的隶属分组,相同分组的度量在前台网页中会被关联在一起
'extra_data_key1':'extra_data_value1',
....
'extra_data_key[n]':'extra_data_value[n]',
}
groups和extra_data是可选的。
 
 
1.  获取gmond.conf中modules -> module -> name = python_module块配置,读取params
2.  判断params的路径是否F_OK和R_OK,失败则直接返回-1
3.  初始化线程,保存线程状态
4.  把params路径下所有文件都读出来,依次循环初始化每一个python文件,过程如下:
(1)把读出的文件名传入is_python_module函数中(只包含.py的文件,会跳过.pyc,.pyo等文件),返回python脚本的模块名(即不带后缀的文件名)
(2)调用find_module_config(modname)函数,查找上一步返回的modname的配置,如果返回的module_cfg(pymodule对象)为空则跳出本次循环,循环下一个模块
(3)调用PyImport_ImportModule(modename)导入指定模块(.py文件),并赋值给pmod指针,如果导入失败则打印相关日志并退出本次循环,循环下一个模块
(4)找到pmod中的metric_init函数,并检查metric_init函数是否可调用,失败则打印相关日志并退出本次循环,循环下一个模块
(5)调用build_params_dict构造param字典,并赋值给pparamdict
(6)用PyObject_CallFunction函数调用metric_init函数,入参是pparamdict,返回值类型是字典或者字典列表,并赋值给pobj指针
(7) 判断pobj,如果为空则打印相关错误信息并退出本次循环,循环下一个模块
(8)获取pobj列表大小,并依次循环
1)依次调用fill_metric_info、fill_gmi,解析每个metric的项,并获取每一项的值,如name(metric名称,也就是生成的RRD文件的名称,length(name + ".rrd") <= 255)、call_back(调用函数)、extra_data(额外参数)、groups等十项基本资料存入minfo(struct结构)结构变更中,再把minfo中的值复制到gmi(Ganglia_25metric结构)结构变量和mi(mapped_info_t结构)变量中。其中gmi压入全局变量metric_info数组中,mi压入全局变理metric_mapping_info数组中, 这2个全局变量在pyth_metric_handler函数中再次展开。

(9)循环结束关闭读params目录

5.  注册metric_cleanup函数
6.  把分析出来的结果保存到全局结构变量中
把metric_info-elts信息压入python_module.metrics_info全局结构变量中
 
 
gmi = apr_array_push(metric_info);
memset (gmi, 0, sizeof(*gmi));
mi = apr_array_push(metric_mapping_info);
memset (mi, 0, sizeof(*mi));
 
python_module.metrics_info = (Ganglia_25metric *)metric_info->elts;
7.  执行成功函数返回0
 

提醒:
该函数只会执行一次,并且是在gmond启动时。

 
 
八、pyth_metric_handler( int metric_index )的处理过程
1.  展开全局变量metrics_info->elts和全局变量metric_mapping_info->elts,并分别赋值给gmi和mi
2.  从mi[metric_index].pcb中取出call back函数,从gmi[metric_index].name中取出metric name
3.  调用PyObject_CallFunction函数,入参是取出的call back函数和metric name,返回值(采集到的数据)赋值给指针pobj
4.  如果pobj为空,则打印相关错误信息并返回val
5.  switch(gmi[metric_index].type),case到对应类型,取出pobj中参数的值,并用转换为对应的类型输出,赋值给val
6.  返回val
 

注意: 
val的类型就是metric_init  d中定义的type value类型。


 
九、metric中 value_type的取值范围
gmond/modules/python/README中给出了metric定义及value_type的取值范围:
d={
'name': '<your_metric_name>',
'call_back': <metric_handler_function>,
'time_max': int(<your_time_max>),
'value_type': '<string | uint | float | double>',
'units': '<your_units>',
'slope': '<zero | positive | negative | both>',
'format': '<your_format>',
'description': '<your_description>',
'groups':'group1,group2,...,group(N)'
}
 
十、metric_cleanup
metric_cleanup仅在gmond退出时执行一次。
该函数没有返回值。
 
 
十一、gmond配置python支持
gmond安装好以后默认是支持modpython模块的,gmond.conf最末一行的include指令:
include ("/etc/ganglia/conf.d/*.conf"), 
 
[root@test2 ganglia]# ls -l /etc/ganglia/conf.d/*.conf
-rw-r--r-- 1 root root 1800 7月  15 10:34 /etc/ganglia/conf.d/modgstatus.conf
-rw-r--r-- 1 root root  384 7月  15 10:34 /etc/ganglia/conf.d/modpython.conf
 
[root@test2 ganglia]# cat /etc/ganglia/conf.d/modpython.conf
/*
  params - path to the directory where mod_python
           should look for python metric modules

  the "pyconf" files in the include directory below
  will be scanned for configurations for those modules
*/
modules {
  module {
    name = "python_module"
    path = "modpython.so"
    params = "/usr/lib64/ganglia/python_modules"
  }
}

include ("/etc/ganglia/conf.d/*.pyconf")