platform-tracing-configure
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChinesePlatform Tracing — Configure
平台追踪(Platform Tracing)——配置
Generate EventSettings metadata to enable or disable the Platform Tracing toggle, which controls whether TraceSpanEvent is published at a sample rate. This modifies a single field () within the existing EventSettings metadata type.
enablePlatformTracing生成EventSettings元数据以启用或禁用平台追踪开关,该开关控制是否以采样率发布TraceSpanEvent。此操作会修改现有EventSettings元数据类型中的单个字段()。
enablePlatformTracingScope
范围
- In scope: Generating with the
Event.settings-meta.xmlfield to enable or disable TraceSpanEvent publishing.enablePlatformTracing - Out of scope: Agentforce agent tracing to Data Cloud (use ). Other EventSettings fields (
platform-tracing-agentforce-configure,enableDeleteMonitoringData, etc.) owned by other teams. Event Log Files. Change Data Capture.enableLoginForensics
- 包含范围:生成带有字段的
enablePlatformTracing,以启用或禁用TraceSpanEvent发布。Event.settings-meta.xml - 排除范围:将Agentforce代理追踪配置到数据云(请使用技能)。其他由其他团队负责的EventSettings字段(如
platform-tracing-agentforce-configure、enableDeleteMonitoringData等)。事件日志文件。变更数据捕获。enableLoginForensics
Prerequisites
前提条件
Before generating, inform the user of these requirements:
- org permission must be active — this permission gates the feature. It is provisioned (not settable via metadata). Without it, the setting deploys but TraceSpanEvent is not published.
PlatformTracing - API version 68.0+ — on EventSettings was introduced in Spring '25. Orgs or tooling on older API versions will not recognize the field. Update
enablePlatformTracingsfdx-project.jsontosourceApiVersionor higher if on an older tooling version.68.0
If the user reports the setting isn't working after deploy, the most likely cause is a missing prerequisite above.
在生成元数据之前,请告知用户以下要求:
- 必须激活组织权限——此权限是该功能的准入条件。它是预配置的(无法通过元数据设置)。如果没有此权限,设置可以部署,但不会发布TraceSpanEvent。
PlatformTracing - API版本68.0及以上——EventSettings中的字段是在Spring '25版本中引入的。使用旧版API的组织或工具将无法识别该字段。如果工具版本较旧,请将
enablePlatformTracing中的sfdx-project.json更新为sourceApiVersion或更高版本。68.0
如果用户反馈部署后设置未生效,最可能的原因是缺少上述前提条件之一。
Clarifying Questions
澄清问题
Before generating, confirm with the user if not already clear:
- Enable or disable? (Which state do you want for Platform Tracing / TraceSpanEvent?)
No other clarification needed — this controls a single boolean field.
在生成之前,如果信息不明确,请与用户确认:
- 是启用还是禁用?(您希望平台追踪/TraceSpanEvent处于哪种状态?)
无需其他澄清——此操作仅控制一个布尔字段。
Required Inputs
必填输入
Gather or infer before proceeding:
- Desired state: (enable) or
true(disable)false
Defaults unless specified:
- If user says "enable" or "turn on": set to
true - If user says "disable" or "turn off": set to
false
If the user provides a clear request, generate immediately without unnecessary back-and-forth.
在继续之前,请收集或推断以下信息:
- 期望状态:(启用)或
true(禁用)false
默认规则(除非另有指定):
- 如果用户说“启用”或“开启”:设置为
true - 如果用户说“禁用”或“关闭”:设置为
false
如果用户提供了明确的请求,请立即生成,无需不必要的来回沟通。
Workflow
工作流程
-
Warn about prerequisites — inform the user that this feature requires theorg permission and API version 68.0+.
PlatformTracing -
Read the template — load.
assets/EventSettings-template.xml -
Generate the settings file — replacewith
{ENABLED}ortruebased on the user's desired state.false -
Place the file — output toin the project's source directory.
settings/Event.settings-meta.xml
-
提醒前提条件——告知用户此功能需要组织权限和API版本68.0及以上。
PlatformTracing -
读取模板——加载。
assets/EventSettings-template.xml -
生成设置文件——根据用户期望的状态,将替换为
{ENABLED}或true。false -
放置文件——将输出文件放在项目源目录的路径下。
settings/Event.settings-meta.xml
Rules / Constraints
规则/约束
| Constraint | Rationale |
|---|---|
Only include | Other fields in EventSettings are owned by other teams. Including them risks overwriting unrelated settings during deploy. |
XML namespace must be | Any other namespace causes deploy failure. |
File must be named | SFDX source format convention — the type name prefix for EventSettings is |
Requires | Without this permission, the setting deploys but has no effect on TraceSpanEvent publishing. |
| Requires API v68.0+ | Older orgs/tooling reject the field entirely. |
| 约束 | 理由 |
|---|---|
生成的元数据中仅包含 | EventSettings中的其他字段由其他团队负责。在部署时包含这些字段可能会覆盖无关设置。 |
XML命名空间必须为 | 使用任何其他命名空间都会导致部署失败。 |
文件必须命名为 | SFDX源格式约定——EventSettings的类型名称前缀为 |
需要 | 没有此权限,设置可以部署,但对TraceSpanEvent的发布没有影响。 |
| 需要API版本68.0及以上 | 旧版组织/工具会完全拒绝该字段。 |
Gotchas
常见问题
| Issue | Resolution |
|---|---|
| Deploy succeeds but TraceSpanEvent not published | Org lacks the |
| Tooling is on API version < 68.0. Update |
| User confuses this with Agentforce tracing | Clarify: this publishes TraceSpanEvent for platform operations. For Agentforce agent spans to Data Cloud, use the |
| User wants to configure all Event Monitoring settings | Only |
| 问题 | 解决方案 |
|---|---|
| 部署成功但未发布TraceSpanEvent | 组织缺少 |
组织/工具无法识别 | 工具使用的API版本低于68.0。请将 |
| 用户将此与Agentforce追踪混淆 | 澄清:此功能用于发布平台操作的TraceSpanEvent。若要将Agentforce代理跨度配置到数据云,请使用 |
| 用户希望配置所有事件监控设置 | 仅 |
Output Expectations
输出预期
Deliverables:
settings/Event.settings-meta.xml
Before delivering, verify:
- XML namespace is exactly
http://soap.sforce.com/2006/04/metadata - File is named
Event.settings-meta.xml - Only is present (no other EventSettings fields)
enablePlatformTracing - Project in
sourceApiVersionissfdx-project.jsonor higher68.0
交付物:
settings/Event.settings-meta.xml
交付前请验证:
- XML命名空间完全为
http://soap.sforce.com/2006/04/metadata - 文件命名为
Event.settings-meta.xml - 仅包含(无其他EventSettings字段)
enablePlatformTracing - 项目中的
sfdx-project.json为sourceApiVersion或更高版本68.0
Cross-Skill Integration
跨技能集成
| Need | Delegate to |
|---|---|
| Enable Agentforce agent tracing to Data Cloud | |
| Set up Change Data Capture | |
| Configure ManagedEventSubscription | |
| 需求 | 委托给 |
|---|---|
| 启用Agentforce代理追踪到数据云 | |
| 设置变更数据捕获 | |
| 配置ManagedEventSubscription | |
Reference File Index
参考文件索引
| File | When to read |
|---|---|
| Step 2 — template for generating the settings file |
| 文件 | 读取时机 |
|---|---|
| 步骤2——用于生成设置文件的模板 |