Golang应用自定义配置

前提条件

已为应用安装探针，具体操作，请参见应用监控接入概述。

功能入口

1. 登录ARMS控制台，在左侧导航栏选择应用监控 > 应用列表。

2. 在应用列表页面顶部选择目标地域，然后单击目标应用名称。

   说明

   语言列的图标含义如下：

   ：接入应用监控的Java应用。

   ：接入应用监控的Golang应用。

   ：接入应用监控的Python应用。

   -：接入可观测链路 OpenTelemetry 版的应用。

3. 在上方导航栏选择应用配置 > 自定义配置。

4. 设置自定义配置参数，设置完成后，单击保存。

采样设置

在采样设置区域，可以为调用链设置采样策略。Golang应用目前仅支持通过固定采样率采样，同时支持按接口名、接口前缀、接口后缀配置全采样。

采样率百分比默认为10，调大采样率会消耗额外的系统资源，建议保持默认值。全采样接口名仅支持1.5.2及以上版本探针。设置完成后，单击保存或保存并批量复制到其它应用。

探针开关设置

在探针开关设置区域，可以控制应用监控的启停并调整各插件开关。

打开暂停应用监控后计费也将同步暂停。插件开关区域包含 dubbo-plugin、mysql-plugin、redis-plugin、grpc-plugin、kafka-client-plugin 等多个插件，其中 hertz-plugin、opentelemetry-plugin、opentracing-plugin 动态修改后需重启才生效。修改后单击保存，或通过批量复制到其他应用将配置同步至其他应用。

Runtime开关设置

在Runtime开关设置区域，可以打开或关闭Runtime监控功能。更多信息，请参见Runtime监控。

设置完成后，单击保存，或单击保存并批量复制到其它应用将配置同步到其他应用。

应用日志关联配置

在应用日志关联配置区域，可以设置应用关联的日志源信息，将SpanId、TraceId打印到对应的日志中。更多信息，请参见Golang应用业务日志关联调用链TraceId。

开启自动关联业务日志与TraceId开关后，在日志服务绑定区域选择区域、Project名称、关联类型（日志库（Logstore）或数据集（StoreView））、Logstore名称及关联索引，完成后单击保存。如需将配置同步至其他应用，可单击批量复制到其他应用。

URL收敛设置

在URL收敛设置区域，可以打开或关闭收敛功能的开关，并设置收敛阈值、收敛规则。URL收敛是指将具有相似性的一系列URL作为一个单独的个体展示，例如将前半部分都为/service/demo/的一系列URL集中展示。收敛阈值是指要进行URL收敛的最低数量条件，例如当阈值为100时，则符合规则正则表达式的URL数量达到100才会对它们进行收敛。更多信息，请参见ARMS收敛机制说明。

收敛规则为正则表达式格式，示例：/service/(.*?)/demo，多个规则之间以英文逗号分隔。设置完成后，单击保存或保存并批量复制到其它应用。

持续剖析设置

在持续剖析设置区域，可以打开或关闭总开关、CPU热点、内存热点和代码热点功能。更多信息，请参见Golang应用持续剖析。

此外还支持配置协程热点（需要1.6.0及以上版本）、阻塞分析和互斥锁分析（需要1.6.1及以上版本）功能的开关。设置完成后单击保存，也可单击批量复制到其他应用将配置同步。

接口调用配置

在接口调用配置区域，可以设置慢调用阈值、HTTP状态码白名单、无效接口调用过滤等。

此外还可配置开启打印http请求body和开启打印http请求header开关（需1.5.0及以上版本）、http body长度（默认1024，需1.4.0及以上版本）、HTTP返回结果中包含TraceId开关（在response header中以eagleeye-traceid体现）、开启打印http返回body和开启打印http返回header开关（需1.5.1及以上版本）、http返回body的长度（默认1024），以及http请求header key写入span和http返回header key写入span文本域。

• 慢调用阈值：默认为500，当接口响应时间大于该阈值的时候，该接口会被标记为慢调用。

• HTTP状态码白名单：

  默认情况下，HTTP 状态码大于 400 会被归类为错误调用。如果您不希望某类状态码被归类为错误，可以设置白名单来忽略这类错误。

  仅对应用监控当前支持的 HTTP 框架产生影响。

  影响数据：HTTP 服务端/客户端的错误数指标（arms_http_requests_error_count、arms_http_client_requests_error_count、arms_app_requests_error_count）、Span 状态。

  影响功能：应用概览、提供服务、依赖服务页签中的错误数，调用链分析页面的 Span 状态、错误数告警。

  内容格式：填写单一状态码，多个状态码用英文半角逗号（,）分隔，不支持模糊匹配。

  示例：403,502

  默认值：空

• 无效接口调用过滤：

  如果您不希望在提供服务页签看到这类调用，可以输入不需要查看调用情况的接口名，探针将不会上报相关接口产生的观测数据，从而将其从接口调用页面隐去。

  影响数据：接口对应的所有指标、Span 都会被忽略。

  影响功能：应用概览、提供服务、依赖服务页签对应接口的所有指标，调用链分析页面的 Span 数量、对应接口的调用量、错误数、慢调用告警。

  内容格式：使用字符串或 AntPath 表达式匹配无效接口全名，多个规则请使用英文半角逗号（,）分隔。（默认值的 AntPath 表达式写法是为了兼容存量数据，不建议删除，新增配置请拼接在原有规则之后）。

  示例：/api/test/*,/api/playground/create

  默认值：/**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg,/**/*.pdf,/**/*.xlsx,/**/*.txt,/**/*.docs,/**/*.gif,/**/*.csv

• 开启打印HTTP请求Body：开启后会在HTTP Client的Span中增加http.request.body字段表示请求的Body，默认打印的长度是1024。

• 开启打印HTTP请求Header：开启后会在HTTP Client的Span中增加http.request.header字段表示请求的Header。

• HTTP Body长度：HTTP请求Body的长度，默认打印的长度是1024。

• HTTP返回结果中包含TraceId：开启后会在返回的Header中添加TraceId，Key是Eagleeye-TraceId。

• 开启打印HTTP返回Body：开启后会在HTTP Server的Span中增加http.response.body字段表示返回的Body。

• 开启打印HTTP返回Header：开启后会在HTTP Server的Span中增加http.response.header字段表示返回的Header。

• HTTP返回Body的长度：HTTP返回Body的长度，默认打印的长度是1024。

• HTTP请求Header Key写入Span：填写Header中出现的Key，多个可以用英文半角逗号分隔，填写后会在HTTP Client的Span中增加http.request.header.key 字段。

• HTTP返回Header Key写入Span：填写Header中出现的Key，多个可以用英文半角逗号分隔，填写后会在HTTP Server的Span中增加http.response.header.key 字段。

异常高级过滤配置

• 采集插件异常：是否采集插件异常。

• 异常过滤白名单：如果不希望在异常分析页签看到这类异常，可以输入不需要统计为异常的异常名称，从而将其从异常分析页面隐去。

关闭采集插件异常开关可避免同一个异常被记录多次。异常过滤白名单中可输入多个英文逗号（,）分隔的异常名称，例如 *mysql.MySQLError；白名单命中的异常不影响 span 中记录该异常，该功能在 2.3.1 及以上版本可用。

数据库调用配置

在数据库调用配置区域，可以设置慢SQL阈值、采集SQL最大保留长度，并设置是否展示SQL中的变量绑定值以及常量值。

• 展示SQL中的变量绑定值：捕获PreparedStatement参数绑定的变量值，无需重启应用即可生效。

• 展示SQL中的常量值：仅对SQL截断，不做额外处理，无需重启应用即可生效。

慢SQL阈值默认为500 ms，超过该阈值的查询将被标记为慢SQL；采集SQL最大保留长度默认为1024，超出部分将被截断；展示SQL中的变量绑定值仅支持MySQL。设置完成后单击保存或保存并批量复制到其它应用。

调用链透传协议设置

在调用链透传协议设置区域，您可以根据自己的需求选择使用的Trace协议。默认使用W3C协议，可以选择Zipkin、Jaeger、EagleEye。

1.4.0及以上版本支持切换传播协议。传播模式支持优先和强制两种：优先模式先读取该协议Header，不存在则继续探测其他协议Header；强制模式若Header不存在则按该协议规范强制生成新的Trace上下文。

探针采集配置

在探针采集配置区域，可以设置探针每秒最大链路采集量和探针日志级别。

其中，探针每秒最大链路采集量默认为100；自定义指标采集需要探针2.0.0及以上版本；打开Span上报需要探针1.8.3及以上版本；Span上报名称需要探针1.7.0及以上版本，多个key之间用英文逗号分隔；默认指标采集过滤需要探针2.3.0及以上版本。

部分参数说明如下：

• 自定义指标采集控制Agent是否采集代码中通过OTel SDK定义的指标。

• 打开Span上报：默认打开，关闭后所有Span 不上报。

• Span上报名称：指定在关闭后需要上报的Span名称。

• 自定义指标采集配置：配置指标Scope名称，不配置默认采集所有自定义指标。

默认指标采集过滤：用于过滤指定类型的指标上报，当前支持下述几种类型，可以多选：

• custom_entry: 方法监控自定义指标。

• http: http服务端指标。

• http_client: http客户端指标。

• rpc: rpc调用服务端指标。

• rpc_client: rpc调用客户端指标。

• sql: 访问数据库服务相关指标。

• nosql: 访问nosql服务相关指标。

• cache: 访问缓存服务相关指标。

• producer: 发送消息相关指标。

• consumer: 消费消息相关指标。

• schedule: 调度服务相关指标。

高级设置

在高级设置区域，可以设置分位数统计、错慢采样、异常堆栈收集大长度等。

异常堆栈收集长度的默认值为4096。设置完成后，单击保存或保存并批量复制到其它应用。

将配置复制到其他应用

如果您需要为其他应用同步相同配置，可以将对应配置复制到其他应用上。

全局默认配置

您可以将当前配置保存为全局默认配置，在之后创建新应用时将会默认使用当前配置。

1. 在页面底部单击保存当前应用设置为全局默认配置。

2. 如果弹出当前设置未保存对话框，请单击确定保存本应用配置后，再单击保存当前应用设置为全局默认配置。

3. 在弹出的对话框中单击确认。