forcedotcom/sf-skills

platform-tracing-configure

Generate EventSettings metadata to enable or disable Platform Tracing (TraceSpanEvent publishing) in Event Monitoring.

查看源码

使用方法

  1. 复制安装命令,在自己的智能体环境安装前先检查源码包。
  2. 从原始文档核对所需工具、凭据和支持的宿主。
  3. 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/forcedotcom/sf-skills --skill platform-tracing-configure

开始前需了解

  • 安装不包含模型订阅、API 额度或访问文件的权限。
  • 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
仓库原始内容

按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。

Platform Tracing — Configure

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 (enablePlatformTracing) within the existing EventSettings metadata type.

Scope

  • In scope: Generating Event.settings-meta.xml with the enablePlatformTracing field to enable or disable TraceSpanEvent publishing.
  • Out of scope: Agentforce agent tracing to Data Cloud (use platform-tracing-agentforce-configure). Other EventSettings fields (enableDeleteMonitoringData, enableLoginForensics, etc.) owned by other teams. Event Log Files. Change Data Capture.

Prerequisites

Before generating, inform the user of these requirements:

  1. `PlatformTracing` 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.
  2. API version 68.0+ — enablePlatformTracing on EventSettings was introduced in Spring '25. Orgs or tooling on older API versions will not recognize the field. Update sfdx-project.json sourceApiVersion to 68.0 or higher if on an older tooling version.

If the user reports the setting isn't working after deploy, the most likely cause is a missing prerequisite above.


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.


Required Inputs

Gather or infer before proceeding:

  • Desired state: true (enable) or false (disable)

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.


Workflow

  1. Warn about prerequisites — inform the user that this feature requires the PlatformTracing org permission and API version 68.0+.
  1. Read the template — load assets/EventSettings-template.xml.
  1. Generate the settings file — replace {ENABLED} with true or false based on the user's desired state.
  1. Place the file — output to settings/Event.settings-meta.xml in the project's source directory.

Rules / Constraints

ConstraintRationale
Only include enablePlatformTracing in generated metadataOther fields in EventSettings are owned by other teams. Including them risks overwriting unrelated settings during deploy.
XML namespace must be http://soap.sforce.com/2006/04/metadataAny other namespace causes deploy failure.
File must be named Event.settings-meta.xmlSFDX source format convention — the type name prefix for EventSettings is Event.
Requires PlatformTracing org permissionWithout this permission, the setting deploys but has no effect on TraceSpanEvent publishing.
Requires API v68.0+Older orgs/tooling reject the field entirely.

Gotchas

IssueResolution
Deploy succeeds but TraceSpanEvent not publishedOrg lacks the PlatformTracing permission. This is provisioned, not settable via metadata.
enablePlatformTracing field not recognized by org/toolingTooling is on API version < 68.0. Update sfdx-project.json sourceApiVersion to 68.0 or higher.
User confuses this with Agentforce tracingClarify: this publishes TraceSpanEvent for platform operations. For Agentforce agent spans to Data Cloud, use the platform-tracing-agentforce-configure skill.
User wants to configure all Event Monitoring settingsOnly enablePlatformTracing is in scope. Other EventSettings fields are owned by other teams and not managed by this skill.

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 enablePlatformTracing is present (no other EventSettings fields)
  • [ ] Project sourceApiVersion in sfdx-project.json is 68.0 or higher

Cross-Skill Integration

NeedDelegate to
Enable Agentforce agent tracing to Data Cloudplatform-tracing-agentforce-configure skill
Set up Change Data Captureintegration-eventing-cdc-configure skill
Configure ManagedEventSubscriptionintegration-eventing-subscription-configure skill

Reference File Index

FileWhen to read
assets/EventSettings-template.xmlStep 2 — template for generating the settings file

按任务相关推荐

来自同一仓库

更多 Skills

全部 Skills
forcedotcom
社区

design-systems-slds-apply

Apply SLDS-compliant UI using the correct blueprints, styling hooks, utility classes, and icons. Use when building any UI that needs SLDS, choosing between Lightning Base Components and SLDS Blueprints, applying styling hooks for theming, using utility classes for layout and spacing, or selecting icons. Triggers include \"build a modal\", \"create a form\", \"data table\", \"SLDS styling\", \"style with hooks\", \"add an icon\".

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日
forcedotcom
社区

dx-code-analyzer-run

Run Salesforce Code Analyzer to scan code for security, performance, best practice, and code style violations. Supports all engines (PMD, ESLint, CPD, RetireJS, Flow, SFGE, ApexGuru), targets (files, folders, git diff), categories, and severities. Also handles post-scan exploration: filtering results by engine/severity/category/file, and explaining what rules mean. TRIGGER when: user says 'scan my code', 'check security issues', 'run PMD/ESLint', 'find duplicates', 'analyze Flows', 'check vulner

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日
forcedotcom
社区

experience-lwc-accessibility-jest-run

Use ALWAYS when running Sa11y accessibility Jest tests for an LWC — locally before pushing, producing the command(s), running one file vs a suite, selecting tests by naming convention, saving Sa11y-rendered HTML, or reproducing a Sa11y/A11yBug failure. Covers core (Bazel; bazel test // : ) and standalone npx jest (.accessibility.test.js, @sa11y/jest). REQUIRED for a run-plan.md, a failing a11y test's exit code, or SA11Y/A11yBug/core-Bazel test paths. DO NOT TRIGGER for functional Jest tests, a11

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日
forcedotcom
社区

experience-lwc-generate

Lightning Web Components with PICKLES methodology and 165-point scoring. Use this skill when the user creates or edits LWC components, builds wire service patterns, or writes Jest tests for LWC. TRIGGER when: user creates/edits LWC components, touches lwc//.js, .html, .css, .js-meta.xml files, or asks about wire service, SLDS, or Jest LWC tests. DO NOT TRIGGER when: Apex classes (use platform-apex-generate), Aura components, or Visualforce.

1小时安装量
1
GitHub Stars
1172
最近更新
11月13日