探针配置

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

注意：在使用时需要为该配置文件设置环境变量TINGYUN_CONFIG_FILE，探针方能启动。配置文件 tingyun.ini中除了 license key之外均有默认值，为了正常使用探针，license key必须填写，更多配置请参考下述说明。

配置项列表

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

配置项详解

基调听云采用标准的ini文件配置，标题书写格式为： [secionName] optionName。

[tingyun] license_key

功能：账户认证标识，必填项，使用探针前请务必填写该项。

默认值：无

说明：如缺少该配置项、或者配置项错误，探针能正常启动， log输出会提示 license无效，将不会采集并上报数据。

[tingyun] enabled

功能：客户端开启、禁用探针开关。

默认值：True，可选值 True, False,以及 on, off，不区分大小写。

说明：如缺少该配置项、或者配置项错误，探针将使用值 True，开启探针功能。

[tingyun] app_name

功能：监控的应用名字

默认值：Python App

说明：如缺少该配置项、空值、错误值等，将使用值 Python App作为应用的名字上报数据。

​ 探针支持多应用关连，该值可以设置为英文分号分割的多个应用名称。

[tingyun] collector_addresses

功能：设置与collector通信地址

默认值：空

说明：如缺少该配置项、或者配置项错误，探针将无法初始化

[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自动合并，仅当配置[自动事务命名]{.underline}关闭，该选项开启时url自动合并才生效，其命名规则如下：

• uri中除字符'/'外，出现的连续数字的将会被字符'*'替换。

• uri中字符'/'中间部分的值为数字的将会被字符'*'替换。

[tingyun] verify_certification

功能：是否验证探针服务器网站证书。

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

说明：

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

[tingyun] instance_name

功能：实例名称。必填项，使用探针前请务必填写该项。

默认值：无，该参数代表实例名称。

说明：在配置时，此项用于固定实例名称。若缺少该配置，探针将无法正常启动。

[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已英文半角逗号分隔，其支持的包名称如表 4-1-24所示，使用示例：

[tingyun:exclude]
plugins=mysql,memcahced

[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

环境变量

TINGYUN_CONFIG_FILE

该环境变量用于指向探针的配置文件，当用命令行启动探针时，探针会自动在操作系统环境变量中寻找该变量，读取配置文件，该变量区分大小写。

如果应用的启动方式通过 shell来控制，可将其植入到 shell中。