New to Claude Skills? Learn how to install them →

forcedotcom on GitHub

Platform Tracing Configuration

OfficialFree

Easily manage Platform Tracing settings for Event Monitoring.

by forcedotcom808 stars on forcedotcom/sf-skills
3 views
Updated Aug 10, 2026
Get this skill

Free · Opens the source repo

What Platform Tracing Configuration does

Platform Tracing Configuration is a specialized skill designed for Salesforce developers and administrators who need to manage the EventSettings metadata related to Platform Tracing. This skill simplifies the process of enabling or disabling the TraceSpanEvent publishing feature, which is essential for monitoring platform operations. By generating the appropriate EventSettings metadata file, users can effectively control how trace spans are published within their Salesforce environment.

The skill focuses on a single field, enablePlatformTracing, allowing users to specify whether they want to enable or disable the tracing feature. This is particularly useful in environments where monitoring performance and operational metrics are critical. The generated Event.settings-meta.xml file is structured according to Salesforce's metadata requirements, ensuring compatibility and ease of deployment.

Before using this skill, it is important to ensure that the PlatformTracing org permission is active and that the API version is set to 68.0 or higher. This guarantees that the enablePlatformTracing field is recognized and functional. The skill also includes checks to prevent common pitfalls, such as deploying without the necessary permissions or using an outdated API version.

In summary, Platform Tracing Configuration is an essential tool for Salesforce professionals who need to manage tracing settings efficiently. It streamlines the process of modifying EventSettings metadata, ensuring that users can focus on monitoring and optimizing their Salesforce applications without unnecessary complexity.

When to use it

Use this skill when you need to enable or disable Platform Tracing for TraceSpanEvent publishing in Salesforce Event Monitoring.

When not to use it

This skill is not suitable for managing other EventSettings fields or for Agentforce tracing to Data Cloud.

What you can build with it

Enabling Platform Tracing

A developer needs to enable Platform Tracing to monitor application performance and uses this skill to generate the necessary metadata.

Disabling TraceSpanEvent Publishing

An administrator decides to disable TraceSpanEvent publishing for a specific environment and utilizes the skill to update the EventSettings.

Updating API Version for Compatibility

A user realizes their tooling is on an older API version and uses the skill to ensure the EventSettings are compatible with the latest features.

How to install Platform Tracing Configuration

View source

1. Install with the skills CLI

npx skills add forcedotcom/sf-skills/platform-tracing-configure --agent claude-code

2. Or install it manually

Download the skill folder and drop it into ~/.claude/skills/ for all projects, or .claude/skills/ to scope it to one repo. Restart Claude Code so it picks up the new skill.

Anthropic's agentic coding CLI, and the reference implementation of Agent Skills. Drop a skill folder into ~/.claude/skills and Claude Code loads it automatically whenever a task matches the skill's description. Claude Code docs

Inside SKILL.md

Written by forcedotcom

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

Frequently asked questions about Platform Tracing Configuration

Similar skills