通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosDiagnosticsContext 类

  • 参考
包:
com.azure.cosmos
Maven 项目:
com.azure:azure-cosmos:4.60.0
  • java.lang.Object
    • com.azure.cosmos.CosmosDiagnosticsContext

public final class CosmosDiagnosticsContext

此类提供 Cosmos DB SDK 中可由诊断处理程序使用的操作的元数据

方法摘要

修饰符和类型 方法和描述
String getAccountName()

与操作相关的帐户的名称
Integer getActualItemCount()

源操作返回的实际项数
String getConnectionMode()

返回客户端中使用的连接模式。
Set<String> getContactedRegionNames()

返回一组已联系的区域
String getContainerName()

与操作相关的容器的名称
String getDatabaseName()

与操作相关的数据库的名称
Collection<CosmosDiagnostics> getDiagnostics()

此 SDK 操作范围内的服务交互的诊断记录
Duration getDuration()

操作的总端到端持续时间。
ConsistencyLevel getEffectiveConsistencyLevel()

操作的有效一致性级别
Throwable getFinalError()

操作失败时的最终错误
Integer getMaxItemCount()

最大值。
int getMaxRequestPayloadSizeInBytes()

最大值。
int getMaxResponsePayloadSizeInBytes()

最大值。
String getOperationId()

操作的操作标识符 - 这可用于为源操作（如查询）添加维度，因此，可以针对不同的查询类型等分隔指标和诊断。
String getOperationType()

操作的操作类型
Collection<CosmosDiagnosticsRequestInfo> getRequestInfo()

获取记录的集合， CosmosDiagnosticsRequestInfo 提供有关传输层中发出的处理此操作的各个请求的详细信息。
String getResourceType()

操作的资源类型
int getRetryCount()

返回推理处理的重试次数和/或尝试次数。
int getStatusCode()

操作的最终状态代码可能在重试后 ()

int getSubStatusCode()

操作的最终子状态代码可能在重试后 ()

Map<String,Object> getSystemUsage()

返回系统使用情况 注意：此信息不包含在toJson()返回的 json 表示形式中，因为它通常仅在违反阈值时才相关，在这种情况下，将包含整个诊断 json 字符串。
float getTotalRequestCharge()

所有重试的总请求费用。
String getTrackingId()

写入操作的跟踪ID。
String getUserAgent()

获取发出此操作的客户端所使用的用户代理标头值 注意：此信息不包含在返回的 toJson() json 表示形式中，因为它通常仅在违反阈值时才相关，在这种情况下，将包含整个诊断 json 字符串。
boolean isCompleted()

返回一个标志，指示操作是否已完成。
boolean isFailure()

一个标志，指示是否应根据状态代码处理规则将操作视为失败 CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)
boolean isPointOperation()

指示操作是否为点操作的标志。
boolean isThresholdViolated()

指示操作的延迟、请求费用或有效负载大小是否超过给定阈值
String toJson()

返回诊断上下文的 json 字符串表示形式。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

方法详细信息

getAccountName

public String getAccountName()

与操作相关的帐户的名称

Returns:

与操作相关的帐户的名称

getActualItemCount

public Integer getActualItemCount()

源操作返回的实际项数

Returns:

源操作返回的实际项数。 对于点操作，将为 null。

getConnectionMode

public String getConnectionMode()

返回客户端中使用的连接模式。 注意：此信息不包括在toJson()从 返回的 json 表示形式中，因为它通常仅在违反阈值时才相关，在这种情况下，将包括整个诊断 json 字符串。

Returns:

客户端中使用的连接模式。

getContactedRegionNames

public Set getContactedRegionNames()

返回一组已联系的区域

Returns:

联系区域集

getContainerName

public String getContainerName()

与操作相关的容器的名称

Returns:

与操作相关的集合的名称

getDatabaseName

public String getDatabaseName()

与操作相关的数据库的名称

Returns:

与操作相关的数据库的名称

getDiagnostics

public Collection getDiagnostics()

此 SDK 操作范围内的服务交互的诊断记录

Returns:

此 SDK 操作范围内服务交互的诊断记录

getDuration

public Duration getDuration()

操作的总端到端持续时间。

Returns:

操作的总端到端持续时间。

getEffectiveConsistencyLevel

public ConsistencyLevel getEffectiveConsistencyLevel()

操作的有效一致性级别

Returns:

操作的有效一致性级别

getFinalError

public Throwable getFinalError()

操作失败时的最终错误

Returns:

操作失败时的最终错误

getMaxItemCount

public Integer getMaxItemCount()

源操作中请求的最大项数

Returns:

源操作中请求的最大项数。 对于点操作，将为 null。

getMaxRequestPayloadSizeInBytes

public int getMaxRequestPayloadSizeInBytes()

最大请求有效负载大小（以字节为单位）

Returns:

最大请求有效负载大小（以字节为单位）

getMaxResponsePayloadSizeInBytes

public int getMaxResponsePayloadSizeInBytes()

最大响应有效负载大小（以字节为单位）。

Returns:

最大响应有效负载大小（以字节为单位）

getOperationId

public String getOperationId()

操作的操作标识符 - 这可用于为源操作（如查询）添加维度，因此，可以针对不同的查询类型等分隔指标和诊断。

Returns:

操作的操作标识符

getOperationType

public String getOperationType()

操作的操作类型

Returns:

操作的操作类型

getRequestInfo

public Collection getRequestInfo()

获取记录的集合， CosmosDiagnosticsRequestInfo 提供有关传输层中发出的处理此操作的各个请求的详细信息。 注意：此信息不包括在返回toJson()的 json 表示形式中，因为它通常仅在违反阈值时才相关，在这种情况下，将包含整个诊断 json 字符串。 调用此方法将延迟收集用户代理 - 这在编写自定义时很有用 CosmosDiagnosticsHandler

Returns:

记录集合， CosmosDiagnosticsRequestInfo 提供有关传输层中发出的处理此操作的各个请求的详细信息。

getResourceType

public String getResourceType()

操作的资源类型

Returns:

操作的资源类型

getRetryCount

public int getRetryCount()

返回推理处理的重试次数和/或尝试次数。

Returns:

推理处理的重试次数和/或尝试次数。

getStatusCode

public int getStatusCode()

操作的最终状态代码可能在重试后 ()

Returns:

操作的最终状态代码可能在重试后 ()

getSubStatusCode

public int getSubStatusCode()

操作的最终子状态代码可能在重试后 ()

Returns:

操作的最终子状态代码可能在重试后 ()

getSystemUsage

public Map getSystemUsage()

返回系统使用情况 注意：此信息不包含在toJson()返回的 json 表示形式中，因为它通常仅在违反阈值时才相关，在这种情况下，将包含整个诊断 json 字符串。 调用此方法将延迟收集系统使用情况 - 这在编写自定义时很有用 CosmosDiagnosticsHandler

Returns:

系统使用情况

getTotalRequestCharge

public float getTotalRequestCharge()

所有重试的总请求费用。

Returns:

所有重试的总请求费用。

getTrackingId

public String getTrackingId()

写入操作的 trackingId。 对于读取/查询或馈送操作，或者当非幂等写入被禁用写入或仅启用没有 trackingId 传播时，将为 null。

Returns:

操作的 trackingId

getUserAgent

public String getUserAgent()

获取发出此操作的客户端使用的 UserAgent 标头值 注意：此信息不包括在返回的 toJson() json 表示形式中，因为它通常仅在违反阈值时才相关，在这种情况下，将包含整个诊断 json 字符串。

Returns:

用于发出此操作的客户端的 UserAgent 标头值

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-properties。

Returns:

诊断上下文的 json 字符串表示形式。 此字符串使用 json 格式来实现可读性，但对于任何自动处理诊断信息时，应将其视为不透明的字符串（格式可以在 SDK 版本之间更改），应使用公共 API 的 get-properties。

适用于