首页 帮助中心 听云Server 配置

配置

配置文件路径

  • Windows

在探针安装路径下"TingYun.ini"

安装路径通常在“C:\Program Files (x86)\Networkbench.COM\NetCore Profiler”下

  • Linux

在探针安装路径下"./lib/tingyun-dotnet/TingYun.ini"

root安装: 安装路径在"/usr/" 非root安装: 安装路径在用户自己指定的文件夹

配置排队时间

如果要配置排队时间,必须保证相关服务器的时钟同步。

  • 排队时间定义: 从负载均衡服务器转发开始到web应用服务器的请求开始被处理所消耗的时间。

  • 原理: 负载均衡设备或容器收到请求后,增加请求的http头: X-QUEUE-START,
    内容为收到请求的毫秒数,负载均衡将请求转发给WEB应用服务器。
    WEB应用服务器在处理请求时,获取当前时间的毫秒数,两个时间差值即为请求排队时间。

    例如,大量请求在web应用服务器队列内排队后请求才被处理时,排队时间会变长

配置方法:

Apache 配置
RequestHeader set X-QUEUE-START "%t"
Nginx 配置(1.2.6版本以上)
  • 使用 proxy_set_header
proxy_set_header X-QUEUE-START "s=$msec";
  • 或使用 fastcgi_param
fastcgi_param HTTP_X_QUEUE_START "s=$msec";
  • 或使用 Passenger
passenger_set_cgi_param HTTP_X_QUEUE_START "s=${msec}";
  • 或使用 uWSGI
uwsgi_param HTTP_X_QUEUE_START "s=${msec}";
HaProxy 配置
http-request set-header X-Queue-Start t=%Ts%ms
F5 配置
	when HTTP_REQUEST_SEND {
		set secs [clock seconds]
		set ms [clock clicks -milliseconds]
		set base [expr { $secs * 1000 }]
		set fract [expr { $ms - $base }]
		if { $fract >= 1000 } {
			set diff [expr { $fract / 1000 }]
			incr secs $diff
			incr fract [expr { -1000 * $diff }]
		}
		set micros [format "%d%03d000" $secs $fract]
		clientside {
			HTTP::header insert X-QUEUE-START "t=${micros}"
		}
	}

license管理

  • nbs.license 与您的听云账号关联,探针采集到的数据,会上传到该 license key绑定的账号下。

应用命名

默认情况下,在报表展示的应用名称为.net core 的项目名称

如果您想将应用命名为其他内容,请首先设置环境变量 TINGYUN_APP_NAME, 然后再启用探针

  • Windows下命名
set TINGYUN_APP_NAME=custom_name

call 安装路径\tingyun-enable.bat
  • Linux下命名
export TINGYUN_APP_NAME=custom_name

. 安装路径/bin/tingyun-enable

日志管理

Windows下日志文件路径在探针安装路径下log文件夹

安装路径通常在“C:\Program Files (x86)\Networkbench.COM\NetCore Profiler”下

Linux下日志文件路径依赖于安装权限。

root安装:安装路径在"/var/log/tingyun/"

非root安装:安装路径在用户自己指定的文件夹"/安装路径/log/"

  • 日志级别
	nbs.agent_log_level=INFO

取值: "OFF", "CRITICAL", "ERROR", "WARNING", "INFO", "VERBOSE", "DEBUG"
说明: 本选项是控制日志数据写入日志文件的级别。
"DEBUG"是最低级,允许所有日志信息写入日志文件。"OFF"是最高级,禁止所有日志信息写入日志文件。

  • 审计模式
nbs.audit_mode=false

取值: true / false
说明: 本选项设定是否在日志文件中写入所有向听云平台上传和下载的数据内容。

数据传输

  • 是否启用安全连接
nbs.ssl=true

取值: true / false
说明: 是否使用安全连接(https)发送数据。

  • 代理服务器地址
nbs.proxy_host=

说明: 代理服务器的地址。若选项不为空,则本选项值为代理服务器的IP地址。
如果nbs.ssl = true,使用https代理
如果nbs.ssl = false,使用http代理

  • 代理服务器端口
nbs.proxy_port=

说明: 本选项指定代理服务器的端口。

  • 代理服务器用户名
nbs.proxy_user=

说明: 若代理服务器需要用户名密码,本选项指定代理服务器的用户名。

  • 代理服务器密码
nbs.proxy_password=

说明: 若代理服务器需要用户名密码,本选项指定代理服务器的登陆密码。

异常中间件

  • 捕获应用中间件处理的异常
local.exception_middleware=

说明: 探针会抓取配置的中间件所处理的异常信息并上报到报表。如果有多个处理异常的中间件, 中间件名称以逗号分隔。

探针默认抓取.net core自带的异常中间件所捕获的异常。 - Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware - Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware

如果用户使用了自研的异常处理中间件, 不配置此项的话,探针捕获不到异常信息。

例如配置为

local.exception_middleware=Dwo.Kernel.ExceptionMiddleware

探针会抓取以下所处理的异常信息并上报到报表。

  • Dwo.Kernel.ExceptionMiddleware
  • Microsoft.AspNetCore.Diagnostics.ExceptionHandlerMiddleware
  • Microsoft.AspNetCore.Diagnostics.DeveloperExceptionPageMiddleware