APM Java Agentのトレースおよびスパン属性

トレース・エクスプローラのトレース(ルート・スパン)およびスパン属性は、スパンにタグ付けすることによって定義されます。これにより、アプリケーションの様々な層の効果的なモニタリングが可能になります。

属性は、スパンにアタッチされたキーと値のペアで、スパン内で実行される操作に関する追加情報とコンテキストを提供します。トレースには、トレースのみの属性とルート・スパンのすべてのスパン属性があります。

トレース・エクスプローラでは、属性を使用してトレースとスパンを問合せおよびフィルタできます。属性には、トレース・エクスプローラの「属性」パネルで使用可能なディメンション(文字列属性)とメトリック(数値属性)の2つのタイプがあります。

この項では、APM Javaエージェントに適用可能な即時利用可能な属性の完全なリストを示します。次の表には次のものが含まれます。

  • 名前: 属性の名前。
  • 説明: 属性の簡潔な説明。
  • トレース/スパン: 属性の可用性。属性は、トレース、スパンまたはその両方に使用できます。
  • タイプ: 属性のタイプ: ディメンションまたはメトリック。
名前 説明 トレース/スパン タイプ
ApmVersion Application Performance Monitoringエージェントのバージョン。 トレースおよびスパン属性 ディメンション
Appserver アプリケーション・サーバーが検出されているかどうかを示すフラグ。アプリケーション・サーバー・タイプがjava-jmxまたはjava-no-jmxの場合、このディメンションはfalseに設定されます。 トレースおよびスパン属性 ディメンション
AppserverDisplayPort アプリケーション・サーバーのポート番号。デフォルトは、最も低いHTTPSポート(使用可能な場合)または最も低いHTTPポートです。 トレースおよびスパン属性 ディメンション
AppserverId アプリケーション・サーバーでリソースが時間とともに変更されたかを示す、重要なアプリケーション・サーバー・リソースのハッシュ。 トレースおよびスパン属性 ディメンション
AppserverName アプリケーション・サーバーの名前。 トレースおよびスパン属性 ディメンション
AppserverPorts アプリケーション・サーバーのポート番号。通常、Oracle WebLogic Serverのポート番号は1つのみで、Apache Tomcatサーバーのポート番号は複数あります。複数のポート番号がある場合、値はカンマで区切られます。 トレースおよびスパン属性 ディメンション
AppserverType アプリケーション・サーバーのタイプ。例: WeblogicまたはTomcat トレースおよびスパン属性 ディメンション
AppserverVersion アプリケーション・サーバー・ソフトウェアのバージョン。 トレースおよびスパン属性 ディメンション
ClassMethod スパン監視が発生したクラス名およびメソッド名。 トレースおよびスパン属性 ディメンション
ClientIp

HTTPを介してサーブレットを起動したクライアントのIP。

デフォルトでは、エージェントはX-FORWARDED-FORリクエスト・ヘッダーでこの情報をチェックします。

使用できない場合は、ServletRequest.getRemoteAddrメソッドを呼び出します。

デフォルトの動作は、APM Java AgentのProbeConfig.acmlファイルを使用して更新できます。(capture_client_ipおよびclient_ip_headerパラメータを参照してください。)

この情報は、GeoMapに使用されます。取得されるクライアントIPに応じて、ジオIPマッピングを構成すると、より正確な結果を得ることができます。

トレースおよびスパン属性 ディメンション
Component JDBC、SERVLET、BROWSERなどの値を使用して、https://opentracing.io/specification/conventions/標準からスパンを生成したコンポーネント。 トレースおよびスパン属性 ディメンション
ContextRoot 監視対象のWebアプリケーションのコンテキスト・ルート。 トレースおよびスパン属性 ディメンション
DbConnUrl データベースへの接続に使用されるJDBC接続URL。 トレースおよびスパン属性 ディメンション
DbOracleConnectionId OracleデータベースへのJDBC接続ごとにOracle JDBCドライバによって生成される一意のNet Oracle接続ID。この属性は、Oracle JDBCクライアント21以降でサポートされています。 トレースおよびスパン属性 ディメンション
DbErrorSqlState エラー・シナリオでSQLException.getSQLStateによって返されるSQLStateコード。 トレースおよびスパン属性 ディメンション
DbErrorVendorCode SQLExceptionインスタンスがスローされる原因となったエラーを識別する番号。 トレースおよびスパン属性 メトリック
DbOracleSessionId 実行された文のOracleセッションID。 トレースおよびスパン属性 ディメンション
DbOracleSqlId 実行されたSQL文から計算されたOracle SQL ID。 トレースおよびスパン属性 ディメンション
DbOracleSqlId1 バッチ文の実行では、最初に実行されたSQL文から計算されたOracle SQL ID。 トレースおよびスパン属性 ディメンション
DbOracleSqlId2 バッチ文の実行では、2番目の実行済SQL文から計算されたOracle SQL ID。 トレースおよびスパン属性 ディメンション
DbStatement JDBC文によって実行される正規化されたSQLテキスト。 トレースおよびスパン属性 ディメンション
DbStatement1 バッチ文の実行では、最初に実行されたJDBC文の正規化されたSQLテキスト。 トレースおよびスパン属性 ディメンション
DbStatement2 バッチ文の実行では、2番目の実行済JDBC文の正規化されたSQLテキスト。 トレースおよびスパン属性 ディメンション
DbStatementAdditionalFetchCount 最初の文の実行時に返されなかった追加の結果セット行をフェッチするための、データベースへのラウンドトリップ数。 トレースおよびスパン属性 メトリック
DbStatementAdditionalFetchTime 最初の文の実行時に返されなかった追加の結果セット行のフェッチに費やされた時間(ミリ秒)。 トレースおよびスパン属性 メトリック
DbStatementExecTime 最初の文の実行に費やされ、初期行が返される時間(ミリ秒)。 トレースおよびスパン属性 メトリック
DbType データベースのタイプ。現在サポートされているのは'sql'タイプのデータベースのみです。 トレースおよびスパン属性 ディメンション
DbUser 基礎となるJDBC接続ユーザー。 トレースおよびスパン属性 ディメンション
DeploymentInfo 監視対象のWebアプリケーションに関するデプロイメント情報。これは、デプロイメント・タイプが使用可能かどうかに応じて、次の2つの形式で表示できます。

<Deployment Name>; <Deployment File Name>

<Deployment Name>; <Deployment File Name>; <Deployment Type>

トレースおよびスパン属性 ディメンション
DisplayName アプリケーション・サーバーの表示名。 トレースおよびスパン属性 ディメンション
ECID Oracle実行コンテキストID。 スパン属性 ディメンション
Error エラーの場合に、スパンをブール値trueで「失敗」としてマークするスパン・プロパティ。これは、スパンで表される操作が失敗したとみなされたことを示します。デフォルトのブール値はfalseです(エラーなし)。 トレースおよびスパン属性 ディメンション
ErrorObject 判読可能なエラーの説明。 トレースおよびスパン属性 ディメンション
GenAIChatHistory 生成AIモデルとの以前のインタラクションからの会話履歴またはコンテキスト スパン属性 ディメンション
GenAICompartmentId GenAIリクエストが処理されるコンパートメントの一意の識別子。 スパン属性 ディメンション
GenAIEmbeddingsPerSentence 1文当たりに生成されるベクトル埋込みのサイズ。使用するモデルに固有 スパン属性 ディメンション
GenAIEmbedResponseId 埋込みレスポンスの一意の識別子 スパン属性 ディメンション
GenAIEmbedSentenceCount 埋込み生成のために処理された文の数 スパン属性 ディメンション
GenAIEmbedTruncate モデル制限を超える入力を切り捨てる戦略(NONE、STARTなど) スパン属性 ディメンション
GenAIFinishReason モデルがレスポンスの生成を停止した理由(最大トークン制限、停止順序など) スパン属性 ディメンション
GenAIFrequencyPenalty 単語の発生頻度に応じて、単語の繰り返しをペナルティします。 スパン属性 ディメンション
GenAIInputSentences 埋込みのために送信された実際の文またはテキスト・チャンク スパン属性 ディメンション
GenAIIsEcho プロンプトを応答にエコーして戻すかどうかを示すブール・フラグ スパン属性 ディメンション
GenAIMaxTokens モデルがレスポンスで生成できるトークンの最大数 スパン属性 ディメンション
GenAIModelName リクエストに使用される生成AIモデルの名前(例: cohere.command) スパン属性 ディメンション
GenAIModelVersion 使用されている生成AIモデルの特定のバージョン スパン属性 ディメンション
GenAINumGenerations 同じプロンプトに対して生成された代替レスポンスの数 スパン属性 ディメンション
GenAIOpcRequestId リクエストをトレースするための一意のID スパン属性 ディメンション
GenAIPresencePenalty 最初の出現後に単語をペナルティします。出現頻度は考慮しません スパン属性 ディメンション
GenAIPrompt システム命令、プリアンブル、ユーザー入力、ドキュメント、ツール情報などを含む、モデルに送信される最終フォーマットのプロンプト スパン属性 ディメンション
GenAIPromptLength プロンプト全体の合計文字数 スパン属性 ディメンション
GenAIQuery 生成AIモデルに送信されたユーザーの入力問合せ スパン属性 ディメンション
GenAIQueryLength ユーザーの入力問合せの文字数 スパン属性 ディメンション
GenAIResponse 生成AIモデルによって生成された完全なレスポンス スパン属性 ディメンション
GenAIResponseLength 生成AIモデルのレスポンスの文字数 スパン属性 ディメンション
GenAIResponseTimeCreated 生成AIレスポンスが生成されたタイムスタンプ スパン属性 ディメンション
GenAISearchQueriesOnly trueの場合、完全回答ではなく、関連する検索問合せのみを返します スパン属性 ディメンション
GenAISeed 再現可能な生成結果に使用されるランダム・シード値 スパン属性 ディメンション
GenAIStatusCode 生成AIエンドポイントから返されたHTTPステータス・コード スパン属性 ディメンション
GenAIStopSequences テキストの生成を停止するモデルをトリガーする、ユーザー指定のカスタム順序のリスト スパン属性 ディメンション
GenAITemperature レスポンスに選択した単語のランダム性を制御します。低温はより確定的です スパン属性 ディメンション
GenAITopK モデルのトークンの選択を、予測される確率に基づいて、最も可能性の高い上位Kのトークンに制限します スパン属性 ディメンション
GenAITopP モデルは、累積確率が上位pしきい値に加算される可能性が最も高い候補のセットから次のトークンを選択します スパン属性 ディメンション
GenAITotalInputLength 埋込み生成用に組み合せたすべての入力文またはテキスト・チャンクの合計文字数 スパン属性 ディメンション
GenAIUserPreamble メイン問合せの前に提供されるカスタム指示またはコンテキスト スパン属性 ディメンション
HostAddress ホスト名から解決されたIPv4アドレス。 トレースおよびスパン属性 ディメンション
Hostname ホストの名前。 トレースおよびスパン属性 ディメンション
HostnameCanonical ホストの正規名(FQDN)。 トレースおよびスパン属性 ディメンション
HostNames ホストのネットワーク・インタフェースのホスト名のリスト。 トレースおよびスパン属性 ディメンション
HttpClientType 監視対象のHTTPクライアントのタイプ(Apache HttpClient、HttpURLConnectionなど)。 トレースおよびスパン属性 ディメンション
HttpMethod リクエストで使用されるHTTPメソッド(GETPOSTDELETEなど)。 トレースおよびスパン属性 ディメンション
HttpRequestContentSize リクエスト・ヘッダーの一部としてContent-Lengthが設定された場合のリクエストのコンテンツの長さ。 トレースおよびスパン属性 ディメンション
HttpResponseContentSize レスポンス・ヘッダーの一部としてContent-Lengthが設定された場合のレスポンスのコンテンツの長さ。 トレースおよびスパン属性 ディメンション
HttpStatusCode レスポンスのHTTPステータス・コード(200404500など)。 トレースおよびスパン属性 ディメンション
HttpStatusDetails HTTPレスポンス・ステータス・コードの説明。 トレースおよびスパン属性 ディメンション
HttpUrl スパンに関連するHTTP URL。 トレースおよびスパン属性 ディメンション
HttpUrlFragment スパンに関連するHTTP URLフラグメント。 トレースおよびスパン属性 ディメンション
HttpUrlHost スパンに関連するHTTP URLホスト名。 トレースおよびスパン属性 ディメンション
HttpUrlPath スパンに関連するHTTP URLパス。 トレースおよびスパン属性 ディメンション
HttpUrlQuery スパンに関連するHTTP URL問合せ。 トレースおよびスパン属性 ディメンション
Kind オープン・トレース定義(https://opentracing.io/specification/conventions/) span.kind0に関連するフィールド。ブラウザ・エージェントはCLIENTやINTERNALなどの値をレポートでき、Javaエージェントおよびその他のトレーサはサーブレット用のSERVERやHttpClientおよびJDBC用のCLIENTなどの値をレポートできます。 トレースおよびスパン属性 ディメンション
NonSampledCount 同じ操作名を持つ以前の非サンプリング・ルート・スパン数。 トレースおよびスパン属性 メトリック
OciAvailabilityDomain コンピュート・インスタンスが実行されているOracle Cloud Infrastructure可用性ドメイン。 トレースおよびスパン属性 ディメンション
OciCompartmentId コンピュート・インスタンスが存在するコンパートメントのOCID。 トレースおよびスパン属性 ディメンション
NonSampledCount 同じ操作名を持つ以前の非サンプリング・ルート・スパン数。 トレースおよびスパン属性 メトリック
OciAvailabilityDomain コンピュート・インスタンスが実行されているOracle Cloud Infrastructure可用性ドメイン。 トレースおよびスパン属性 ディメンション
OciComputeShape コンピュート・インスタンスのシェイプ トレースおよびスパン属性 ディメンション
OciDisplayName コンピュート・インスタンスまたはKubernetesノードの表示名。 トレースおよびスパン属性 ディメンション
OciFaultDomain コンピュート・インスタンスが実行されているOracle Cloud Infrastructureフォルト・ドメインの名前。 トレースおよびスパン属性 ディメンション
OciInstanceId コンピュート・インスタンスのOCID。 トレースおよびスパン属性 ディメンション
OciRegion コンピュート・インスタンスが実行されている可用性ドメインを含むOracle Cloud Infrastructureリージョン。 トレースおよびスパン属性 ディメンション
OpcRequestIdRequest Oracle Cloud Infrastructureに送信されるリクエストの一部として設定されたopc-request-idヘッダー値。 トレースおよびスパン属性 ディメンション
OpcRequestIdResponse Oracle Cloud Infrastructureから送信されるレスポンスの一部として設定されたopc-request-idヘッダー値。 トレースおよびスパン属性 ディメンション
OperationName スパンの名前。 トレースおよびスパン属性 ディメンション
OsAvailableProcessors Java Virtual Machine (JVM)で使用可能なプロセッサの数。 トレースおよびスパン属性 メトリック
OsFamily ユーザー・エージェントから導出されたOSファミリ。たとえば、Linuxなどです。 トレースおよびスパン属性 ディメンション
OsName オペレーティング・システムの名前 トレースおよびスパン属性 ディメンション
OsVersion オペレーティングシステムのバージョン。 トレースおよびスパン属性 ディメンション
ProcessId アプリケーション・サーバーのプロセスID。 トレースおよびスパン属性 メトリック
RequestPayload リクエストの一部として取得されたリクエスト・ペイロード本文。リクエスト・ペイロードは、xpath、jsonpathまたはregexの組合せを使用して有用な情報のみを表示するようにフィルタ処理できます。詳細は、ProbeConfig.acmlファイルを確認してください。 トレースおよびスパン属性 ディメンション
ResponsePayload レスポンスの一部として取得されたレスポンス・ペイロード本文。レスポンス・ペイロードは、xpath、jsonpathまたはregexの組合せを使用して有用な情報のみを表示するようにフィルタ処理で除外できます。詳細は、ProbeConfig.acmlファイルを確認してください。 トレースおよびスパン属性 ディメンション
ServletContainerSpecification このServletContextで表されるアプリケーションのベースとなるサーブレット仕様のバージョン。

トレースおよびスパン属性 ディメンション
ServletSpecification このサーブレット・コンテナがサポートするサーブレットAPIのバージョン。 トレースおよびスパン属性 ディメンション
ServiceInstanceId エージェントのオブザーバID。 トレースおよびスパン属性 ディメンション
ServiceName サービスに割り当てた名前。 トレースおよびスパン属性 ディメンション
SessionId セッションまたはブラウザの一意の識別子。 トレースおよびスパン属性 ディメンション
SoaTaskAssigneeUsers このタスクが割り当てられたユーザーのユーザー名のリスト。

このディメンションを表示するには、ProbeConfig.acmlファイルでcapture_username=trueを設定する必要があります。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaTaskCompletionDuration タスクが開始されてから完了するまでの時間(ミリ秒)。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaTaskName タスクの名前。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaTaskNumber BPMワークリストのNumber列に表示されるタスク番号。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaTaskOutcome 完了時のタスクの結果。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaTaskRequester タスクの依頼者のユーザー名。

このディメンションを表示するには、ProbeConfig.acmlファイルでcapture_username=trueを設定する必要があります。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaTaskState タスクの状態。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaTaskSubstate タスクのサブ状態(使用可能な場合)。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SoaWorkflowNumber ワークフロー番号。

この属性は、Oracle SOA Human Workflowの使用時に存在します。

スパン属性 ディメンション
SpanID 各スパンの一意の識別子。 スパン属性 ディメンション
StartTime スパンの開始時間。 スパン属性 メトリック
Subcomponent スパンを生成したサブコンポーネント。 スパン属性は ディメンション
ThreadAllocatedMemory 関連付けられたサーブレット・スパンに対してヒープ・メモリーに割り当てられた総メモリー量の近似値(バイト単位)。この情報は、ThreadMXBeanから取得され、デフォルトで取得されます。

デフォルトの動作は、APM Java AgentのProbeConfig.acmlファイルを使用して無効にできます。(tag_thread_allocated_memoryパラメータを参照してください。)

スパン属性 ディメンション
ThreadCpuTime 関連付けられたサーブレットの合計CPU時間(ミリ秒)。この情報は、ThreadMXBeanから取得され、デフォルトで取得されます。

デフォルトの動作は、APM Java AgentのProbeConfig.acmlファイルを使用して無効にできます。(tag_thread_cpu_timeパラメータを参照してください。)

スパン属性 ディメンション
ThreadId スパンが開始したスレッドのID。 スパン属性 メトリック
ThreadIdEnd スパンが終了したスレッドのID。 スパン属性 メトリック
ThreadName スパンが開始したスレッドの名前。 スパン属性 ディメンション
ThreadNameEnd スパンが終了したスレッドの名前。 スパン属性 ディメンション
UserName システムを使用するエンド・ユーザーのユーザー名、またはユーザーを一意に識別する識別子。

ユーザー名取得および構成オプションの詳細は、Modify or Disable Default Probe Settingsを参照してください。

トレースおよびスパン属性 ディメンション
VmName 仮想マシンの名前。 トレースおよびスパン属性 ディメンション
VmVendor 仮想マシンのベンダー。 トレースおよびスパン属性 ディメンション
VmVersion 仮想マシンのバージョン。 トレースおよびスパン属性 ディメンション
WorkingDirectory アプリケーション・サーバーの作業ディレクトリ。 トレースおよびスパン属性 ディメンション