PluginBench
Skill
Pass
Audit score 90

platform-tracing-configure

forcedotcom/sf-skills

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

What is platform-tracing-configure?

This skill generates Event.settings-meta.xml metadata to control whether TraceSpanEvent is published in Salesforce Event Monitoring. Use it when you need to enable or disable the Platform Tracing toggle in your org's Event Monitoring Settings.

  • Generate Event.settings-meta.xml with enablePlatformTracing field set to true or false
  • Control TraceSpanEvent publishing at the org level via metadata
  • Validate API version 68.0+ compatibility before deployment
  • Ensure only the enablePlatformTracing field is included to avoid overwriting other EventSettings

How to install platform-tracing-configure

npx skills add https://github.com/forcedotcom/sf-skills --skill platform-tracing-configure
Prerequisites
  • PlatformTracing org permission must be active (provisioned, not settable via metadata)
  • API version 68.0 or higher in sfdx-project.json sourceApiVersion
  • Existing Event Monitoring configuration in the org
Claude Code
Cursor
Windsurf
Cline

How to use platform-tracing-configure

  1. 1.Confirm whether you want to enable (true) or disable (false) Platform Tracing
  2. 2.Run the skill and provide your desired state if not already specified
  3. 3.Review the generated Event.settings-meta.xml file in settings/ directory
  4. 4.Verify the XML namespace is http://soap.sforce.com/2006/04/metadata
  5. 5.Deploy the metadata to your org using your standard deployment process

Use cases

Good for
  • Enable Platform Tracing to start publishing TraceSpanEvent for monitoring platform operations
  • Disable Platform Tracing to stop TraceSpanEvent publishing and reduce Event Monitoring overhead
  • Update existing Event Monitoring settings when migrating to API version 68.0 or higher
  • Configure tracing settings as part of Event Monitoring setup in a new org
Who it's for
  • Salesforce administrators managing Event Monitoring
  • Developers setting up platform tracing for performance monitoring
  • DevOps engineers configuring Event Monitoring in CI/CD pipelines
  • Architects designing Event Monitoring strategies

platform-tracing-configure FAQ

What is the difference between this skill and platform-tracing-agentforce-configure?

This skill configures Platform Tracing for general platform operations and TraceSpanEvent publishing in Event Monitoring. The platform-tracing-agentforce-configure skill is specifically for Agentforce agent tracing to Data Cloud.

Why doesn't my TraceSpanEvent start publishing after deployment?

The most likely cause is that your org lacks the PlatformTracing permission, which is provisioned by Salesforce and not settable via metadata. Contact your Salesforce account team to enable it.

Can I use this skill to configure other EventSettings fields?

No. This skill only manages the enablePlatformTracing field. Other EventSettings fields (enableDeleteMonitoringData, enableLoginForensics, etc.) are owned by other teams and should not be included in this metadata to avoid overwriting unrelated settings.

What API version do I need?

API version 68.0 or higher. The enablePlatformTracing field was introduced in Spring '25. Update your sfdx-project.json sourceApiVersion if you are on an older version.

What file does this skill generate?

It generates settings/Event.settings-meta.xml with the enablePlatformTracing field set to your desired state (true or false).

Full instructions (SKILL.md)

Source of truth, from forcedotcom/sf-skills.


name: platform-tracing-configure description: "Generate EventSettings metadata to enable or disable Platform Tracing (TraceSpanEvent publishing) in Event Monitoring. Use this skill for any EventSettings enablePlatformTracing metadata work. TRIGGER when: user mentions Platform Tracing, TraceSpanEvent, enable tracing in Event Monitoring Settings, event monitoring tracing toggle, enablePlatformTracing, .settings-meta.xml for Event settings tracing, turn on trace span events, or stop publishing trace spans. DO NOT TRIGGER when: user wants Agentforce agent tracing to Data Cloud (use platform-tracing-agentforce-configure), wants Event Log Files or ELF generation, wants Change Data Capture (use integration-eventing-cdc-configure), or wants ManagedEventSubscription (use integration-eventing-subscription-configure)." metadata: version: "1.0" domains: ["Platform"] minApiVersion: "68.0" relatedSkills: - "integration-eventing-cdc-configure" - "integration-eventing-subscription-configure" - "platform-tracing-agentforce-configure"

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