探针配置

本小节主要讨论探针的本地配置，在安装包中提供了一份默认的配置文件tingyun.ini（或者通过命令generate-config 生成）, 该配置为标准python ini文件配置，详情参考python文件格式

1、常见配置，以及相关说明

注意：在使用时需要为该配置文件设置环境变量（TING_YUN_CONFIG_FILE），探针方能启动。 配置文件tingyun.ini中除了license key之外均有默认值，为了正常使用探针，license key是必填项，常见的配置项如下表， 更多配置请参考后续说明

注：本地配置的修改需重启方能生效！

2、配置详解

• [tingyun] license_key

功能：账户认证标识，必填项，使用探针前请务必填写该项。
默认值： 无
说明：如缺少该配置项、或者配置项错误，探针能正常启动，log输出会提示license无效，将不会采集并上报数据

• [tingyun] enabled

功能：客户端开启、禁用探针开关。
默认值：True，可选值True, False, 以及 on, off，不区分大小写。
说明：如缺少该配置项、或者配置项错误，探针将使用值True，开启探针功能。

• [tingyun] app_name

功能： 监控的应用名字
默认值：Python App
说明： 如缺少该配置项、空值、错误值等，将使用值Python App作为应用的名字上报数据。
探针支持多应用关连，该值可以设置为英文分号分割的多个应用名称。

• [tingyun] log_file

功能： 指定探针log写入的文件名以及路径，推荐使用绝对路径。
默认值：/tmp/tingyun-agent.log，支持自定义系统文件路径、stdout、stderr
说明：若缺少该配置、空值、错误值等，探针可正常启动，log将会输出到stderr。若指定了stdout、或者stderr，将会定向到系统标准输出。

敬告：由于python的log分割机制有缺陷，探针将会向一份日志文件中输出日志，请做好日志处理。请确保您应用进程的用户对该目录和log文件有写入权限，否则将会输出到stderr

• [tingyun] log_level

功能：指定探针log的日志级别
默认值：INFO，可选值NOTSET, DEBUG，INFO, WARNING，WARN, FATAL ,ERROR，CRITICAL (不区分大小写)。
说明：若缺少该配置，或错误配置将默认使用INFO级别。

• [tingyun] ssl

功能： 指定使用http或https传输协议
默认值：True，可选值True, False, 以及 on, off，不区分大小写。
说明： 若缺少该配置、配置错误等，将使用值True，使用https协议传输数据。

• [tingyun] audit_mode

功能：是否将提交上报的数据会输出到log中以备审计，False关闭审计，反之开启。（该log以INFO级别输出）
默认值：False，可选值True, False, 以及 on, off，不区分大小写。
说明：若缺少该配置、配置错误等，将使用值False，关闭审计模式。该部分log将以“Agent capture”开头， info级别输出

• [tingyun] auto_action_naming

功能： 设置是否开启自动事务命名，如开启自动命名，uri名字将会做为action的名字。
默认值： True，可选值True, False, 以及 on, off，不区分大小写。
说明：若缺少该配置、配置错误等，将使用值True，开启自动命名

• [tingyun] action_tracer.log_sql

功能：事务跟踪时SQL语句的记录只写到本地日志文件中，不提交到数据采集服务上。（输出级别为INFO级别log）
默认值： False，可选值True, False, 以及 on, off，不区分大小写。
说明：若缺少该配置、配置错误等，将使用值False，该部分log将以“Log sql is opened”开头。

• [tingyun] urls_merge

功能：在关闭自动事务命名时，合并uri作为事务名称。
默认值： True，可选值True, False, 以及 on, off，不区分大小写。

说明：
该参数用于开启url自动合并，仅当配置自动事务命名关闭，该选项开启时url自动合并才生效，其命名规则如下：
•uri中除字符’/’外，出现的连续数字的将会被字符’*’替换。
•uri中字符’/’中间部分的值为数字的将会被字符’*’替换。

• [tingyun] verify_certification

功能：是否验证探针服务器网站证书。
默认值：True，当启用ssl加密传输数据时，不验证探针服务器的网站的证书信息。可选值True, False, 以及 on, off，不区分大小写。

说明：
如果python包certifi的版本大于2015.04.28时，该证书使用sha256加密认证网站证书信息，但由于探针服务器证书颁发机构的根证书使用的是sha1加密，所以使用该版本之后的版本将会导致认证服务器证书失败的，以至于上传探针监测的数据失败，所以暂时的解决方案是，关闭服务器证书的认证。

• [tingyun] tornado_wsgi_adapter_mode

功能：启用tornado wsgi应用模式
默认值：False， 支持false， true， on， off，不区分大小写。

说明：
	当使用第三方容器部署（如gevent，uwsgi）tornado应用（tornado wsgi应用）时，需要开启该选项，探针才能正常工作

• [tingyun:private] host

敬告：需要私有化探针时才需配置此选项，常规用户无需理会该选项！

功能：私有化时，用于配置内网的服务器重定向地址。
提示：如果配置文件没有section [tingyun:private]，请手动添加该section，然后再配置host等选项。

• [tingyun:private] port

敬告：需要私有化探针时才需配置此选项，常规用户无需理会该选项！

功能：私有化时，用于配置内网的服务器用于重定向地址开放的端口号

• [tingyun:exclude] plugins

功能：配置不需要监测的python包
默认值：''
说明：plugin以英文半角逗号分隔,使用示例:
[tingyun:exclude]
plugins=mysql,memcahced

支持以下安装的过滤：
mongodb, pymemcache, urllib2, pymysql, oracle, gevent, jinja2, httplib2, mysql, psycopg2cffi, pyodbc, thrift, mako,  postgresql, pika, urllib3,  psycopg2, redis, urllib,  oursql, bmemcached, requests, memcached, psycopg2ct

• [tingyun:proxy] proxy_host

功能：配置http/https代理服务器主机地址,用户探针链接外网上报性能数据。
默认值： 无
说明：该配置可与配置项proxy_port, proxy_user, proxy_pwd配合使用， 该选项支持格式：schme://user:password@host/path

• [tingyun:proxy] proxy_port

功能：配置代理服务器主机端口号
默认值：无

• [tingyun:proxy] proxy_user

功能：配置代理服务器用户名
默认值：无

• [tingyun:proxy] proxy_pwd

功能：配置代理服务器用户密码，该选项和proxy_user对应
默认值：无

• [tingyun:proxy] proxy_scheme

功能：配置代理服务器数据传输协议
默认值：http