帮助手册

PHP Agent 配置

PHP Agent 配置文件帮助您精细调整用于跟踪基于 Web 的事务的配置。

编辑配置设置

编辑 PHP agent 配置文件:

  1. 导航至 APM > APM Insight > 您的 PHP 应用。
  2. 点击应用/实例下拉菜单旁边的汉堡图标(汉堡图标),选择编辑选项。
  3. 进入配置文件 > APM Agent 配置文件。
  4. 点击下拉菜单选择所需的配置文件。
    Note

    您可以点击铅笔图标来更新配置。

  5. 选择相应的配置文件,然后点击保存。

配置文件 - 参数与默认值

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

基础配置文件

基础配置文件

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

True

混淆 SQL 参数
  • 启用此选项将对慢事务追踪中的所有 SQL 查询进行参数化处理(需同时将 sql.capture.enabled 和 transaction.trace.enabled 设置为 true)。
  • 禁用此选项将显示真实查询(含参数)。
  • 如果查询中包含信用卡号、密码等敏感参数,建议启用此选项。
True
事务追踪中 SQL 的堆栈跟踪阈值
  • 启用此选项后,当任何 SQL 查询的执行时间超过阈值时,将收集堆栈跟踪信息。
3(秒)
Agent 自动升级
  • 将此值设置为 true 时,agent 将自动升级到最新可用版本。
False 
显示实例端口号
  • 启用此选项后,将显示应用实例的端口号。
True
启用宕机告警
  • 当您的应用进入宕机状态时,将发送告警。
  • 仅支持非云监视器。
已禁用
抑制实例告警
  • 启用此选项将抑制所有实例的告警。 
  • 包括 SMS、语音、即时通讯(IM)、移动端和 Web 浏览器推送通知在内的所有告警方式都将被禁用。
False
规范化数据库操作名称
  •  启用此选项后,数据库操作名称中的字母数字值将被替换为问号(?)。
 已启用
日志级别
  •  您可以从下拉菜单中选择不同的日志消息级别。根据所选的日志级别,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
跳过事务
  • 提供可从跟踪中跳过的正则表达式模式或事务名称。多个条目请使用逗号分隔。
将相似事务分组
  • 提供可将事务归入同一事务名称的正则表达式模式。
按前缀将事务分组 
  • 提供需要归入同一前缀名称的前缀列表。
  • 语法:事务前缀 = 新前缀
  • 例如:nestle, snickers, orion = chocolate
    在上述示例中,nestle/quantity/order、snickers/quantity/order、orion/quantity/order 将被替换为 chocolate/quantity/order。

 

Web 事务配置

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(秒)
按事务捕获 CPU 时间?
  • 启用后,将为每个 HTTP 请求记录 CPU 时间。
True
按事务捕获内存分配?
  • 启用后,将捕获所有 Web 事务的内存分配情况。
2(秒)
捕获 HTTP 参数?
  • 启用此选项将捕获所有 GET 和 POST Web 请求的参数
  • 若要跳过捕获特定参数,请使用 webtransaction.trace.input.params.ignore 键
  • 可在追踪选项卡中选择所需事务来查看捕获的参数
False
需混淆的 HTTP 参数列表
  • 如需跳过捕获特定 Web 请求参数(如密码、PIN 或其他敏感值),请在此键中指定这些参数名称
  • 使用逗号(,)分隔多个条目。此键的值区分大小写
  • 如果未指定任何值,将记录所有请求参数
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
 捕获追踪记录?
  • 启用此选项后,agent 将为慢后台事务收集追踪记录(需同时将 bgtransaction.tracking.enabled 设置为 true)
True
事务追踪阈值
  • 当 bgtransaction.trace.enabled 设置为 true 时,响应时间超过指定阈值的后台事务追踪记录将被收集
5(秒)
当外部调用次数超过以下值时捕获追踪记录
  • 当后台事务中外部组件(如 MYSQL、MEMCACHED 等)的总调用次数等于或超过配置值时,将捕获追踪快照。
40(次)
按事务捕获 CPU 时间
  • 启用后,将为每个后台事务记录 CPU 时间。
False
按事务捕获内存分配
  • 启用此选项后,将捕获后台事务的内存分配情况。
False
采样因子
  • 后台事务的采样因子
  • 设置为 1 时,agent 跟踪每个事务;设置为 n 时,agent 跟踪同类事务中每 n 个中的 1 个
1(请求)

仅在 apminsight.conf 中可用的配置

Note

此项仅适用于 4.0 以下版本的 agent。

某些配置文件无法从客户端修改,只能在 apminsight.conf 文件中进行配置。

配置项 说明 默认值
application.name
  • 指定要在 Site24x7 中显示的应用名称。
  • 如果您的应用存在多个实例且希望将它们分组,请在所有已安装的 APM Insight Agent 配置文件中指定相同的应用名称。
    示例:myonlineshopping.com
PHP-Application
license.key *
  • 对应用户的 API 密钥
  • 登录后可在 APM Insight 首页获取。
  • 将密钥复制粘贴为此参数的值。
  • 此密钥为用户专属,请勿与他人共享。
 
agent.server.port *
  • 指定应用服务器的 HTTP 监听端口。
  • 当同一主机上运行多个应用服务器时,此项有助于区分各实例。

 
behind.proxy 
  • 指定安装了 Agent 的应用服务器是否位于代理网络之后。
  • 如果设置为 True,需提供代理凭据信息,以便 agent 将指标数据发送至 Site24x7。
  • 如果 behind.proxy 设置为 true,请为以下键指定对应的值:
False

* - 必填值。如果这些条目未提供或无效,Agent 将无法初始化/启动。但是,部署了 Agent 的应用服务器将正常启动。

本文档对您有帮助吗?

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


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


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

短链接已复制!