mcpField
P
platform-tracing-configure

platform-tracing-configure

github.com/forcedotcomクラウド・DevOps1.1k5.2k 回インストール1 日前に更新
リポジトリ

platform-tracing-configure について

Salesforce の EventSettings メタデータを生成し、TraceSpanEvent の公開を有効または無効にするスキルです。プラットフォームトレース向けで、変更対象は `enablePlatformTracing` フィールドに限られます。

主な機能

  1. 01プラットフォームトレース状態の設定
  2. 02Event.settings-meta.xml の生成
  3. 03単一メタデータフィールドへの限定
  4. 04権限と API 前提条件の確認

活用シーン

  1. 01TraceSpanEvent 公開の有効化
  2. 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 など)。イベントログファイル。変更データキャプチャ。

前提条件

生成する前に、次の要件をユーザーに伝えてください。

  1. PlatformTracing 組織権限が有効である必要があります。この権限によって機能が制御されます。この権限はプロビジョニングされるものであり、メタデータでは設定できません。この権限がない場合、設定はデプロイされますが、TraceSpanEvent は公開されません。
  2. API バージョン 68.0 以降が必要です。EventSettings の enablePlatformTracing は Spring '25 で導入されました。古い API バージョンを使用する組織やツールでは、このフィールドが認識されません。ツールのバージョンが古い場合は、sfdx-project.json の sourceApiVersion を 68.0 以上に更新してください。

デプロイ後に設定が機能しないとユーザーから報告された場合、上記の前提条件が不足していることが最も一般的な原因です。


確認事項

生成する前に、まだ明確になっていない場合はユーザーに確認してください。

  • 有効化しますか、それとも無効化しますか?(プラットフォームトレーシング/TraceSpanEvent をどの状態にしますか?)

単一のブール値フィールドを制御するため、他に確認することはありません。


必要な入力

処理を進める前に、次の情報を収集するか推測してください。

  • 希望する状態:true(有効)または false(無効)

指定がない場合のデフォルト:

  • ユーザーが「有効にする」または「オンにする」と言った場合:true に設定
  • ユーザーが「無効にする」または「オフにする」と言った場合:false に設定

ユーザーの依頼が明確であれば、不要なやり取りをせず、すぐに生成してください。


ワークフロー

  1. 前提条件を伝える — この機能には PlatformTracing 組織権限と API バージョン 68.0 以降が必要であることをユーザーに伝えます。

  2. テンプレートを読み込む — assets/EventSettings-template.xml を読み込みます。

  3. 設定ファイルを生成する — ユーザーの希望する状態に基づいて、{ENABLED} を true または false に置き換えます。

  4. ファイルを配置する — プロジェクトのソースディレクトリに 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 — 設定ファイルを生成するためのテンプレート

コメント