帮助手册

APM Insight 配置

您可以通过修改 APM agent 配置文件来精细调整应用程序监控。APM agent 配置文件允许您为 Web 事务和后台事务的关键参数设置阈值。

注意

APM agent 配置文件的更改应用于应用程序级别,而非实例级别。如果您的应用程序有多个实例,配置文件的更改将应用于整个应用程序,并反映在所有相应实例中。

添加 APM agent 配置文件

要创建 APM agent 配置文件:

  1. 登录您的 Site24x7 账户。
  2. 导航至管理 > 配置文件 > APM Agent 配置 > 添加 APM Agent 配置文件
  3. 输入配置文件名称并选择 Agent 类型
  4. 配置其他参数。
  5. 点击保存
注意
  • 通常,默认配置文件(含默认参数值)将分配给您的应用程序。对默认配置文件所做的任何更改将自动反映到所有适用的 agent 上。
  • 具有自定义角色的用户可使用查看我的资源选项筛选并查看其创建的资源。
  • 您还可以克隆具有自定义参数值的配置文件,并将其应用于相应的应用程序。

编辑 APM agent 配置文件

  1. 导航至 APM > APM Insight > 您的应用程序。
  2. 点击应用程序/实例下拉菜单旁的汉堡图标(汉堡图标),然后选择编辑选项。
  3. 转至配置文件 > APM Agent 配置文件
  4. 点击下拉菜单选择所需的配置文件。
    注意
    您可以点击铅笔图标更新配置。
  5. 选择相应的配置文件,然后点击保存

配置文件 - 参数与默认值

APM agent 配置文件分为三个部分:基础配置文件、Web 事务配置和后台事务配置。每个配置文件的参数说明如下。

基础配置文件

日志级别

  • APM Insight agent 记录信息所使用的日志级别。
  • 支持的级别为 SEVERE、WARNING、INFO 和 FINE。

信息(日志级别)

配置项 描述 默认值
捕获数据库 SQL 查询
  • 启用此选项将监听所有已执行的 SQL 查询。
  • 如果禁用此选项,将不会收集任何数据库指标。

True

混淆 SQL 参数
  • 启用此选项将对慢事务追踪中的所有 SQL 查询进行参数化处理。(需将 sql.capture.enabled 设置为 true 且 transaction.trace.enabled 设置为 true)
  • 禁用此选项将显示实际查询(含参数)。
  • 如果存在使用信用卡号、密码等机密参数执行的查询,建议启用此选项。
True
事务追踪中 SQL 的堆栈跟踪阈值
  • 启用此选项后,每当 SQL 查询执行时间超过此阈值,将收集相应的堆栈跟踪信息。
3(秒)
Agent 自动升级
  • 将此值设置为 true 时,agent 将自动升级至最新可用版本。
False 
在总响应时间中包含异步时间
  • 启用此选项将把异步(非阻塞)调用的响应时间纳入事务总响应时间中。 
True
显示实例端口号
  • 启用此选项后,将显示应用程序实例的端口号。
True
启用宕机告警
  • 每当应用程序进入宕机状态时,将发送告警。
  • 仅支持非云监视器。
已禁用
抑制实例告警
  • 启用此选项将抑制所有实例的告警。 
  • 所有告警方式(包括短信、语音、即时通讯、移动端和 Web 浏览器推送通知)将被禁用。
False
规范化 DB 操作名称
  •  启用此选项后,DB 操作名称中的字母数字值将被替换为问号(?)。
 已启用
日志级别
  •  您可以从下拉菜单中选择不同的日志消息级别。根据所选日志级别,打印在 agent 日志(用户机器上)中的日志消息将有所不同。
Java- INFO
.NET, Node.js- CRITICAL
PHP- WARNING 
要跳过追踪的 URL 扩展名列表
  • 追踪时将跳过指定 URL 模式的 Web 事务
  • 使用逗号(,)分隔多个条目
    示例:transaction.skip.listening=*.jpeg,将跳过以 .jpeg 结尾的事务监听
*.css, *.js, *.gif, *.jpg, *.jpeg, *.bmp, *.png, *.ico
要从追踪中忽略的异常列表
  • 输入不需要追踪的异常列表。
跳过事务
  • 提供可以从追踪中跳过的正则表达式模式或事务名称,多个条目以逗号分隔。
在事务名称中排除分组
  • 提供不应在事务名称中分组的字母数字关键字列表。

    例如,如果配置了 v1、v2、index1、index2,则事务 api/v2/web3/index2.html 和 api/v1/web3/index1.html 将被混淆为 api/v2/*/index2.html 和 api/v1/*/index1.html。

将相似事务分组
  • 提供可以归组为单一事务名称的事务正则表达式模式。
按前缀对事务分组 
  • 提供需要归组为单一前缀名称的前缀列表。
  • 语法:事务前缀 = 新前缀
  • 例如,nestle, snickers, orion = chocolate
    在以上示例中,nestle/quantity/order、snickers/quantity/order、orion/quantity/order 将被替换为 chocolate/quantity/order。
自动删除未使用的云实例(超过)
  • 如果自动扩展环境中的云实例连续五分钟处于非活动状态,将被自动暂停。
  • 此设置确定暂停的实例在被自动删除之前可以保持非活动状态的时长。
  • 您可以根据保留需求将此值配置为 1 至 15 天。
7 天

 Web 事务配置

配置项 描述 默认值
Apdex 阈值
  • 应用性能指数(简称 Apdex)是衡量应用性能的指标,取值范围为 0 到 1。
  • 有关 Apdex 的详细信息,请访问 www.apdex.org
  • 如果任何事务响应时间低于 apdex.threshold 值,该事务标记为"满意"。
  • 如果任何事务响应时间超过 apdex.threshold 的四倍,该事务标记为"沮丧"。
  • 如果恰好等于 apdex.threshold 或介于满意和沮丧阈值之间,则标记为"容忍"。
0.5(秒)
采样因子
  • 采样因子用于追踪采样事务。
  • 设置为 5 时,APMInsight 每 5 个同类请求中只追踪 1 个
 1(请求)
启用事务追踪
  • 启用此选项将为慢事务构建追踪。
  • 您可以通过选择"追踪"选项卡,在 Site24x7 APM Insight 版本页面查看收集的追踪。
True
事务追踪阈值
  • 在 transaction.trace.enabled 设置为 true 的前提下,响应时间超过指定阈值的事务追踪将被收集。
  • 追踪可用于分析和排查事务问题。
2(秒)
外部调用次数超过时捕获追踪
  • 对于总外部组件(如 MYSQL、MEMCACHED 等)调用次数等于或超过配置数量的 HTTP 请求,将进行追踪快照。
30(次)
捕获每个事务的 CPU 时间?
  • 启用后,将记录每个 HTTP 请求的 CPU 时间。
True
捕获每个事务的内存分配?
  • 启用后,将捕获所有 Web 事务的内存分配。
2(秒)
捕获 HTTP 参数?
  • 启用此选项将捕获所有 GET 和 POST Web 请求的参数
  • 若要跳过捕获特定参数,请使用 webtransaction.trace.input.params.ignore 键
  • 可通过在"追踪"选项卡中选择相应事务来查看已捕获的参数
False
要忽略的 HTTP 参数列表
  • 若要跳过捕获密码、PIN 或任何机密值等特定 Web 请求参数,请为此键指定这些参数名称
  • 使用逗号(,)分隔多个条目,此键的值区分大小写
  • 如果未指定值,将记录所有请求参数
password, authKey
捕获 HTTP 标头?
  •  启用此选项将捕获追踪的 HTTP 标头(可在 追踪详情选项卡中查看)。
False
要忽略的 HTTP 标头列表
  • 若要跳过捕获特定 HTTP 标头,请在此处列出。
  • 使用逗号(,)分隔多个条目。
  • 如果未指定值,将捕获所有 HTTP 标头。
 

Java- Accept, Cookie, Cache-Control, Connection, Host, Accept-Encoding, X-Site24x7-Id, X-SITE24X7-RUM-APPKEY, X-SITE24X7-RUM-TRACEID, Site24x7SyntheticKey

.NET, PHP, Node.js, Python- X-Site24x7-Id, X-SITE24X7-RUM-APPKEY, X-SITE24X7-RUM-TRACEID, Site24x7SyntheticKey

要从追踪中忽略的 HTTP 错误代码列表
  • 这是不会被追踪的 HTTP 错误代码列表,如 400、401 和 500。
捕获 HTTP 字节数
  • 启用此选项后,将捕获网络请求的传入和传出字节数。
True

 

后台事务配置

配置项 描述 默认值
追踪后台事务?
  • 启用此选项后,APM Insight agent 将开始追踪后台事务
  • 除 HTTP 以外的所有事务均被视为后台事务
True
 捕获追踪?
  • 在 bgtransaction.tracking.enabled 设置为 true 的前提下,启用此选项后 agent 将收集慢后台事务的追踪
True
事务追踪阈值
  • 在 bgtransaction.trace.enabled 设置为 true 的前提下,将收集响应时间超过指定阈值的后台事务追踪
5(秒)
外部调用次数超过时捕获追踪
  • 对于总外部组件(如 MYSQL、MEMCACHED 等)调用次数等于或超过配置数量的后台事务,将进行追踪快照。
40(次)
捕获每个事务的 CPU 时间
  • 启用后,将记录每个后台事务的 CPU 时间。
False
捕获每个事务的内存分配
  • 启用此选项后,将捕获后台事务的内存分配。
False
采样因子
  • 后台事务的采样因子
  • 值为 1 时,agent 追踪每个事务;值为 n 时,agent 每 n 个同类事务追踪 1 个
1(请求)

仅在 apminsight.conf 中可用的配置

某些配置文件无法从客户端修改,这些设置可以在 apminsight.conf 文件中进行配置。

配置项 描述 默认值
application.name
  • 指定要在 Site24x7 中显示的应用程序名称。
  • 如果您的应用程序有多个实例并希望将它们分组,请在所有已安装的 APM Insight Agent 配置文件中指定相同的应用程序名称。
    示例:myonlineshopping.com
 My Application
license.key*
  • 对应用户的 API 密钥。
  • 登录后可在 APM Insight 主页找到此密钥。
  • 复制并粘贴该密钥作为此参数的值。
  • 此密钥为用户专属,请勿与他人共享。
 
behind.proxy
  • 指定安装了 Agent 的应用程序服务器是否在代理网络之后。
  • 如果设置为 True,则需要提供代理凭据信息,以便将指标数据从 agent 发送至 Site24x7。
  • 如果 behind.proxy 设置为 true,请为以下键指定值:
    • proxy.server.host:代理服务器的主机名
    • proxy.server.port:代理服务器的端口
    • proxy.auth.username:代理服务器的用户名
    • proxy.auth.password:代理服务器的密码
FALSE
agent.server.port*
  • 指定您的应用程序在服务器上运行的端口号。
  • 每个端口号被视为单独的实例,并将归组在相同的应用程序名称下。
80

* - 必填项。如果这些条目中有任何一个未提供或无效,Agent 将无法初始化/启动。但部署了 Agent 的应用程序服务器将正常启动。

本文档对您有帮助吗?

您愿意帮助我们改进文档吗?请告诉我们哪些方面可以做得更好。


很抱歉本文档未能让您满意。我们希望了解可以从哪些方面改进您的体验。


感谢您抽出时间分享反馈。我们将利用您的反馈来改进在线帮助资源。

短链接已复制!