platform-tracing-configure について
Salesforce の EventSettings メタデータを生成し、TraceSpanEvent の公開を有効または無効にするスキルです。プラットフォームトレース向けで、変更対象は `enablePlatformTracing` フィールドに限られます。
主な機能
- 01プラットフォームトレース状態の設定
- 02Event.settings-meta.xml の生成
- 03単一メタデータフィールドへの限定
- 04権限と API 前提条件の確認
活用シーン
- 01TraceSpanEvent 公開の有効化
- 02TraceSpanEvent 公開の無効化
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ forcedotcom/ sf-skills --skill platform-tracing-configureインストール後、Claude Code で/platform-tracing-configureを入力して読み込まれたか確認します。
同梱ファイルassets/EventSettings-template.xml
詳細
プラットフォームトレーシング — 設定
EventSettings メタデータを生成して、TraceSpanEvent をサンプルレートで公開するかどうかを制御するプラットフォームトレーシングの切り替えを有効または無効にします。既存の EventSettings メタデータ型内の単一フィールド(enablePlatformTracing)を変更します。
対象範囲
- 対象範囲内:TraceSpanEvent の公開を有効または無効にする
enablePlatformTracingフィールドを含むEvent.settings-meta.xmlの生成。 - 対象範囲外:Agentforce エージェントの Data Cloud へのトレーシング(
platform-tracing-agentforce-configureを使用)。他のチームが所有するその他の EventSettings フィールド(enableDeleteMonitoringData、enableLoginForensicsなど)。イベントログファイル。変更データキャプチャ。
前提条件
生成する前に、次の要件をユーザーに伝えてください。
PlatformTracing組織権限が有効である必要があります。この権限によって機能が制御されます。この権限はプロビジョニングされるものであり、メタデータでは設定できません。この権限がない場合、設定はデプロイされますが、TraceSpanEvent は公開されません。- API バージョン 68.0 以降が必要です。EventSettings の
enablePlatformTracingは Spring '25 で導入されました。古い API バージョンを使用する組織やツールでは、このフィールドが認識されません。ツールのバージョンが古い場合は、sfdx-project.jsonのsourceApiVersionを68.0以上に更新してください。
デプロイ後に設定が機能しないとユーザーから報告された場合、上記の前提条件が不足していることが最も一般的な原因です。
確認事項
生成する前に、まだ明確になっていない場合はユーザーに確認してください。
- 有効化しますか、それとも無効化しますか?(プラットフォームトレーシング/TraceSpanEvent をどの状態にしますか?)
単一のブール値フィールドを制御するため、他に確認することはありません。
必要な入力
処理を進める前に、次の情報を収集するか推測してください。
- 希望する状態:
true(有効)またはfalse(無効)
指定がない場合のデフォルト:
- ユーザーが「有効にする」または「オンにする」と言った場合:
trueに設定 - ユーザーが「無効にする」または「オフにする」と言った場合:
falseに設定
ユーザーの依頼が明確であれば、不要なやり取りをせず、すぐに生成してください。
ワークフロー
-
前提条件を伝える — この機能には
PlatformTracing組織権限と API バージョン 68.0 以降が必要であることをユーザーに伝えます。 -
テンプレートを読み込む —
assets/EventSettings-template.xmlを読み込みます。 -
設定ファイルを生成する — ユーザーの希望する状態に基づいて、
{ENABLED}をtrueまたはfalseに置き換えます。 -
ファイルを配置する — プロジェクトのソースディレクトリに
settings/Event.settings-meta.xmlとして出力します。
ルール/制約
| 制約 | 理由 |
|---|---|
生成するメタデータには enablePlatformTracing のみを含める | EventSettings の他のフィールドは別のチームが所有しています。それらを含めると、デプロイ時に無関係な設定を上書きするおそれがあります。 |
XML 名前空間は http://soap.sforce.com/2006/04/metadata にする | 別の名前空間を使用すると、デプロイに失敗します。 |
ファイル名は Event.settings-meta.xml にする | SFDX ソース形式の規約では、EventSettings の型名の接頭辞は Event です。 |
PlatformTracing 組織権限が必要 | この権限がない場合、設定はデプロイされますが、TraceSpanEvent の公開には影響しません。 |
| API v68.0 以降が必要 | 古い組織やツールでは、このフィールド自体が拒否されます。 |
注意事項
| 問題 | 解決方法 |
|---|---|
| デプロイは成功するが、TraceSpanEvent が公開されない | 組織に PlatformTracing 権限がありません。この権限はプロビジョニングされるものであり、メタデータでは設定できません。 |
組織/ツールで enablePlatformTracing フィールドが認識されない | ツールの API バージョンが 68.0 未満です。sfdx-project.json の sourceApiVersion を 68.0 以上に更新してください。 |
| ユーザーがこれを Agentforce のトレーシングと混同している | これはプラットフォーム操作の TraceSpanEvent を公開する機能であることを説明してください。Agentforce エージェントのスパンを Data Cloud に送る場合は、platform-tracing-agentforce-configure スキルを使用してください。 |
| ユーザーがすべてのイベントモニタリング設定を構成したい | 対象範囲は enablePlatformTracing のみです。その他の EventSettings フィールドは別のチームが所有しており、このスキルでは管理しません。 |
出力要件
成果物:
settings/Event.settings-meta.xml
提出前に、以下を確認してください:
- XML 名前空間が正確に
http://soap.sforce.com/2006/04/metadataである - ファイル名が
Event.settings-meta.xmlである -
enablePlatformTracingのみが含まれており、他の EventSettings フィールドは含まれていない -
sfdx-project.jsonのプロジェクトのsourceApiVersionが68.0以上である
スキル間の連携
| 必要なこと | 委任先 |
|---|---|
| Agentforce エージェントのトレースを Data Cloud に有効化する | platform-tracing-agentforce-configure スキル |
| Change Data Capture を設定する | integration-eventing-cdc-configure スキル |
| ManagedEventSubscription を設定する | integration-eventing-subscription-configure スキル |
参照ファイル一覧
| ファイル | 読むタイミング |
|---|---|
assets/EventSettings-template.xml | ステップ 2 — 設定ファイルを生成するためのテンプレート |