CosmosDiagnosticsContext クラス
- java.
lang. Object - com.
azure. cosmos. CosmosDiagnosticsContext
- com.
public final class CosmosDiagnosticsContext
このクラスは、診断ハンドラーで使用できる Cosmos DB SDK での操作のメタデータを提供します
メソッドの概要
| 修飾子と型 | メソッドと説明 |
|---|---|
| String |
getAccountName()
操作に関連するアカウントの名前 |
| Integer |
getActualItemCount()
フィード操作によって返されるアイテムの実際の数 |
| String |
getConnectionMode()
クライアントで使用されている接続モードを返します。 |
| Set<String> |
getContactedRegionNames()
接触するリージョンのセットを返します |
| String |
getContainerName()
操作に関連するコンテナーの名前 |
| String |
getDatabaseName()
操作に関連するデータベースの名前 |
|
Collection<Cosmos |
getDiagnostics()
この SDK 操作のスコープ内でのサービス操作の診断レコード |
| Duration |
getDuration()
操作のエンド ツー エンドの合計期間。 |
|
Consistency |
getEffectiveConsistencyLevel()
操作の有効な整合性レベル |
| Throwable |
getFinalError()
操作が失敗したときの最後のエラー |
| Integer |
getMaxItemCount()
最大値。 |
| int |
getMaxRequestPayloadSizeInBytes()
最大値。 |
| int |
getMaxResponsePayloadSizeInBytes()
最大値。 |
| String |
getOperationId()
操作の操作識別子 (これは、クエリなどのフィード操作のディメンションを追加するために使用できます。そのため、メトリックと診断は、さまざまなクエリの種類などに対して分離できます。 |
| String |
getOperationType()
操作の操作の種類 |
|
Collection<Cosmos |
getRequestInfo()
この操作を処理するためにトランスポート層で発行された個々の CosmosDiagnosticsRequestInfo 要求に関する詳細情報を提供するレコードのコレクションを取得します。 |
| String |
getResourceType()
操作のリソースの種類 |
| int |
getRetryCount()
投機的処理の再試行回数または試行回数を返します。 |
| int |
getStatusCode()
操作の最終的な状態コード (再試行後の可能性あり) |
| int |
getSubStatusCode()
操作の最終的なサブ状態コード (再試行後の可能性あり) |
| Map<String,Object> |
getSystemUsage()
システムの使用状況に関する注意を返します。この情報は、通常、しきい値に違反した場合にのみ関連するため、この情報は からtoJson()返される json 表現には含まれません。この場合、診断 json 文字列全体が含まれます。 |
| float |
getTotalRequestCharge()
すべての再試行に対する要求の合計料金。 |
| String |
getTrackingId()
書き込み操作の追跡 |
| String |
getUserAgent()
この操作を発行するクライアントによって使用される User |
| boolean |
isCompleted()
操作がまだ完了しているかどうかを示すフラグを返します。 |
| boolean |
isFailure()
の状態コード処理ルールに基づいて、操作を失敗と見なす必要があるかどうかを示すフラグ CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate) |
| boolean |
isPointOperation()
操作がポイント操作であるかどうかを示すフラグ。 |
| boolean |
isThresholdViolated()
操作の待機時間、要求の料金、またはペイロード のサイズが指定されたしきい値を超えたかどうかを示します |
| String |
toJson()
診断 コンテキストの json 文字列表現を返します。 |
メソッドの継承元: java.lang.Object
メソッドの詳細
getAccountName
public String getAccountName()
操作に関連するアカウントの名前
Returns:
getActualItemCount
public Integer getActualItemCount()
フィード操作によって返されるアイテムの実際の数
Returns:
getConnectionMode
public String getConnectionMode()
クライアントで使用されている接続モードを返します。 注: この情報は、通常、しきい値に違反した場合にのみ関連するため、 からtoJson()返される json 表現には含まれません。この場合、json 文字列全体診断含まれます。
Returns:
getContactedRegionNames
public Set
接触するリージョンのセットを返します
Returns:
getContainerName
public String getContainerName()
操作に関連するコンテナーの名前
Returns:
getDatabaseName
public String getDatabaseName()
操作に関連するデータベースの名前
Returns:
getDiagnostics
public Collection
この SDK 操作のスコープ内でのサービス操作の診断レコード
Returns:
getDuration
public Duration getDuration()
操作のエンド ツー エンドの合計期間。
Returns:
getEffectiveConsistencyLevel
public ConsistencyLevel getEffectiveConsistencyLevel()
操作の有効な整合性レベル
Returns:
getFinalError
public Throwable getFinalError()
操作が失敗したときの最後のエラー
Returns:
getMaxItemCount
public Integer getMaxItemCount()
フィード操作で要求されたアイテムの最大数
Returns:
getMaxRequestPayloadSizeInBytes
public int getMaxRequestPayloadSizeInBytes()
要求ペイロードの最大サイズ (バイト単位)
Returns:
getMaxResponsePayloadSizeInBytes
public int getMaxResponsePayloadSizeInBytes()
最大応答ペイロード サイズ (バイト単位)。
Returns:
getOperationId
public String getOperationId()
操作の操作識別子 (これは、クエリなどのフィード操作のディメンションを追加するために使用できます。そのため、メトリックと診断は、さまざまなクエリの種類などに対して分離できます。
Returns:
getOperationType
public String getOperationType()
操作の操作の種類
Returns:
getRequestInfo
public Collection
この操作を処理するためにトランスポート層で発行された個々の CosmosDiagnosticsRequestInfo 要求に関する詳細情報を提供するレコードのコレクションを取得します。 注: この情報は、通常、しきい値に違反した場合にのみ関連するため、 からtoJson()返される json 表現には含まれません。この場合、json 文字列全体診断含まれます。 このメソッドを呼び出すと、ユーザー エージェントが遅延収集されます。これは、カスタム エージェントを記述するときに役立ちます CosmosDiagnosticsHandler
Returns:
getResourceType
public String getResourceType()
操作のリソースの種類
Returns:
getRetryCount
public int getRetryCount()
投機的処理の再試行回数または試行回数を返します。
Returns:
getStatusCode
public int getStatusCode()
操作の最終的な状態コード (再試行後の可能性あり)
Returns:
getSubStatusCode
public int getSubStatusCode()
操作の最終的なサブ状態コード (再試行後の可能性あり)
Returns:
getSystemUsage
public Map
システムの使用状況に関する注意を返します。この情報は、通常、しきい値に違反した場合にのみ関連するため、この情報は からtoJson()返される json 表現には含まれません。この場合、診断 json 文字列全体が含まれます。 このメソッドを呼び出すと、システムの使用状況が遅れて収集されます。これは、カスタム の記述時に役立ちます CosmosDiagnosticsHandler
Returns:
getTotalRequestCharge
public float getTotalRequestCharge()
すべての再試行に対する要求の合計料金。
Returns:
getTrackingId
public String getTrackingId()
書き込み操作の trackingId。 読み取り/クエリまたはフィード操作の場合、または非べき等書き込みが書き込みに対して無効になっている場合、または trackingId 伝達なしでのみ有効になっている場合は null になります。
Returns:
getUserAgent
public String getUserAgent()
この操作を発行するクライアントによって使用される UserAgent ヘッダー値を取得します。この情報は、通常、しきい値に違反した場合にのみ関連するため、この情報はからtoJson()返される json 表現には含まれません。この場合、診断 json-string 全体が含まれます。
Returns:
isCompleted
public boolean isCompleted()
操作がまだ完了しているかどうかを示すフラグを返します。
Returns:
isFailure
public boolean isFailure()
の状態コード処理ルールに基づいて、操作を失敗と見なす必要があるかどうかを示すフラグ CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)
Returns:
isPointOperation
public boolean isPointOperation()
操作がポイント操作であるかどうかを示すフラグ。
Returns:
isThresholdViolated
public boolean isThresholdViolated()
操作の待機時間、要求の料金、またはペイロード のサイズが指定されたしきい値を超えたかどうかを示します
Returns:
toJson
public String toJson()
診断 コンテキストの json 文字列表現を返します。 この文字列は読みやすくするために json 形式を使用しますが、形式は不透明な文字列として扱う必要があります。SDK のバージョン間で変更される可能性があります。診断情報の自動処理では、パブリック API の get プロパティを使用する必要があります。
Returns:
適用対象
Azure SDK for Java