mcpField
P
platform-tracing-configure

platform-tracing-configure

github.com/forcedotcomCloud & DevOps1.1k5.2k installsUpdated 1d ago
Repository

About platform-tracing-configure

A skill for generating Salesforce EventSettings metadata that turns TraceSpanEvent publishing on or off. It is for configuring platform tracing and limits changes to the single `enablePlatformTracing` field.

Key features

  1. 01Set platform tracing state
  2. 02Generate Event.settings-meta.xml
  3. 03Limit changes to one metadata field
  4. 04Check permission and API prerequisites

Use cases

  1. 01Enable TraceSpanEvent publishing
  2. 02Disable TraceSpanEvent publishing

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/forcedotcom/sf-skills --skill platform-tracing-configure

After installing, type/platform-tracing-configurein Claude Code to confirm it loaded.

Bundled filesassets/EventSettings-template.xml

Details

From the project README

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+.

  2. Read the template — load assets/EventSettings-template.xml.

  3. Generate the settings file — replace {ENABLED} with true or false based on the user's desired state.

  4. 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

Comments

Markdown supported