CosmosDiagnosticsContext Clase

Paquete:

com.azure.cosmos

Artefacto Maven:

com.azure:azure-cosmos:4.60.0

• java.lang.Object
• • com.azure.cosmos.CosmosDiagnosticsContext

public final class CosmosDiagnosticsContext

Esta clase proporciona metadatos para una operación en el SDK de Cosmos DB que los controladores de diagnóstico pueden usar.

Resumen del método

Modificador y tipo	Método y descripción
String	getAccountName() Nombre de la cuenta relacionada con la operación
Integer	getActualItemCount() Número real de elementos devueltos por una operación de fuente
String	getConnectionMode() Devuelve el modo de conexión usado en el cliente.
Set<String>	getContactedRegionNames() Devuelve el conjunto de regiones contactadas.
String	getContainerName() Nombre del contenedor relacionado con la operación
String	getDatabaseName() Nombre de la base de datos relacionada con la operación
Collection<CosmosDiagnostics>	getDiagnostics() Los registros de diagnóstico para las interacciones del servicio dentro del ámbito de esta operación del SDK
Duration	getDuration() Duración total de un extremo a otro de la operación.
ConsistencyLevel	getEffectiveConsistencyLevel() Nivel de coherencia eficaz de la operación
Throwable	getFinalError() Error final cuando se produjo un error en la operación
Integer	getMaxItemCount() Máximo.
int	getMaxRequestPayloadSizeInBytes() El valor máximo.
int	getMaxResponsePayloadSizeInBytes() El valor máximo.
String	getOperationId() Identificador de operación de la operación: se puede usar para agregar una dimensión para las operaciones de fuente ( como consultas), por lo que las métricas y los diagnósticos se pueden separar para diferentes tipos de consulta, etc.
String	getOperationType() Tipo de operación de la operación
Collection<CosmosDiagnosticsRequestInfo>	getRequestInfo() Obtiene una colección de CosmosDiagnosticsRequestInfo registros que proporcionan más información sobre las solicitudes individuales emitidas en la capa de transporte para procesar esta operación.
String	getResourceType() Tipo de recurso de la operación
int	getRetryCount() Devuelve el número de reintentos o intentos de procesamiento especulativo.
int	getStatusCode() El código de estado final de la operación (posiblemente después de los reintentos)
int	getSubStatusCode() El código de subestado final de la operación (posiblemente después de los reintentos)
Map<String,Object>	getSystemUsage() Devuelve la nota de uso del sistema: esta información no se incluye en la representación json devuelta porque toJson() normalmente solo es relevante cuando se infringen los umbrales, en cuyo caso se incluye toda la cadena json de diagnóstico.
float	getTotalRequestCharge() Cargo total de la solicitud en todos los reintentos.
String	getTrackingId() Identificador de seguimientode una operación de escritura.
String	getUserAgent() Obtiene elvalor de encabezado del Agente de usuario utilizado por el cliente que emite esta operación NOTA: esta información no se incluye en la representación json devuelta porque toJson() normalmente solo es relevante cuando se infringen los umbrales, en cuyo caso se incluye toda la cadena json de diagnóstico.
boolean	isCompleted() Devuelve una marca que indica si la operación se ha completado todavía.
boolean	isFailure() Marca que indica si la operación debe considerarse errónea o no en función de las reglas de control de código de estado de . CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)
boolean	isPointOperation() Marca que indica si la operación es una operación de punto o no.
boolean	isThresholdViolated() Indica si la latencia, el cargo de solicitud o el tamaño de carga de la operación superaron el umbral especificado.
String	toJson() Devuelve una representación json-string del contexto de diagnóstico.

Métodos heredados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalles del método

getAccountName

public String getAccountName()

Nombre de la cuenta relacionada con la operación

Returns:

el nombre de la cuenta relacionada con la operación

getActualItemCount

public Integer getActualItemCount()

Número real de elementos devueltos por una operación de fuente

Returns:

el número real de elementos devueltos por una operación de fuente. Será null para las operaciones de punto.

getConnectionMode

public String getConnectionMode()

Devuelve el modo de conexión usado en el cliente. NOTA: esta información no se incluye en la representación json devuelta porque toJson() normalmente solo es relevante cuando se infringen los umbrales, en cuyo caso se incluye toda la cadena json de diagnóstico.

Returns:

modo de conexión usado en el cliente.

getContactedRegionNames

public Set getContactedRegionNames()

Devuelve el conjunto de regiones contactadas.

Returns:

el conjunto de regiones contactadas

getContainerName

public String getContainerName()

Nombre del contenedor relacionado con la operación

Returns:

el nombre de la colección relacionada con la operación

getDatabaseName

public String getDatabaseName()

Nombre de la base de datos relacionada con la operación

Returns:

el nombre de la base de datos relacionada con la operación.

getDiagnostics

public Collection getDiagnostics()

Los registros de diagnóstico para las interacciones del servicio dentro del ámbito de esta operación del SDK

Returns:

registros de diagnóstico para las interacciones del servicio dentro del ámbito de esta operación del SDK

getDuration

public Duration getDuration()

Duración total de un extremo a otro de la operación.

Returns:

duración total de un extremo a otro de la operación.

getEffectiveConsistencyLevel

public ConsistencyLevel getEffectiveConsistencyLevel()

Nivel de coherencia eficaz de la operación

Returns:

el nivel de coherencia eficaz de la operación

getFinalError

public Throwable getFinalError()

Error final cuando se produjo un error en la operación

Returns:

el error final cuando se produjo un error en la operación

getMaxItemCount

public Integer getMaxItemCount()

Número máximo de elementos solicitados en una operación de fuente.

Returns:

el número máximo de elementos solicitados en una operación de fuente. Será null para las operaciones de punto.

getMaxRequestPayloadSizeInBytes

public int getMaxRequestPayloadSizeInBytes()

Tamaño máximo de carga de la solicitud en bytes.

Returns:

el tamaño máximo de la carga de la solicitud en bytes

getMaxResponsePayloadSizeInBytes

public int getMaxResponsePayloadSizeInBytes()

Tamaño máximo de carga de respuesta en bytes.

Returns:

el tamaño máximo de la carga de respuesta en bytes

getOperationId

public String getOperationId()

Identificador de operación de la operación: se puede usar para agregar una dimensión para las operaciones de fuente ( como consultas), por lo que las métricas y los diagnósticos se pueden separar para diferentes tipos de consulta, etc.

Returns:

el identificador de operación de la operación

getOperationType

public String getOperationType()

Tipo de operación de la operación

Returns:

el tipo de operación de la operación

getRequestInfo

public Collection getRequestInfo()

Obtiene una colección de CosmosDiagnosticsRequestInfo registros que proporcionan más información sobre las solicitudes individuales emitidas en la capa de transporte para procesar esta operación. NOTA: Esta información no se incluye en la representación json devuelta porque toJson() normalmente solo es relevante cuando se infringen los umbrales, en cuyo caso se incluye toda la cadena json de diagnóstico. Al llamar a este método, se recopilará de forma diferir el agente de usuario, lo que puede ser útil al escribir un personalizado. CosmosDiagnosticsHandler

Returns:

una colección de CosmosDiagnosticsRequestInfo registros que proporcionan más información sobre las solicitudes individuales emitidas en la capa de transporte para procesar esta operación.

getResourceType

public String getResourceType()

Tipo de recurso de la operación

Returns:

el tipo de recurso de la operación

getRetryCount

public int getRetryCount()

Devuelve el número de reintentos o intentos de procesamiento especulativo.

Returns:

el número de reintentos o intentos de procesamiento especulativo.

getStatusCode

public int getStatusCode()

El código de estado final de la operación (posiblemente después de los reintentos)

Returns:

el código de estado final de la operación (posiblemente después de los reintentos)

getSubStatusCode

public int getSubStatusCode()

El código de subestado final de la operación (posiblemente después de los reintentos)

Returns:

el código de subestado final de la operación (posiblemente después de los reintentos)

getSystemUsage

public Map getSystemUsage()

Devuelve la nota de uso del sistema: esta información no se incluye en la representación json devuelta porque toJson() normalmente solo es relevante cuando se infringen los umbrales, en cuyo caso se incluye toda la cadena json de diagnóstico. Al llamar a este método, se recopilará de forma diferir el uso del sistema, lo que puede ser útil al escribir un personalizado. CosmosDiagnosticsHandler

Returns:

el uso del sistema

getTotalRequestCharge

public float getTotalRequestCharge()

Cargo total de la solicitud en todos los reintentos.

Returns:

el cargo total de la solicitud en todos los reintentos.

getTrackingId

public String getTrackingId()

TrackingId de una operación de escritura. Será null para las operaciones de lectura/consulta o fuente, o cuando las escrituras no idempotentes están deshabilitadas para escrituras o solo habilitadas sin propagación trackingId.

Returns:

trackingId de una operación

getUserAgent

public String getUserAgent()

Obtiene el valor de encabezado UserAgent utilizado por el cliente que emite esta operación NOTA: esta información no se incluye en la representación json devuelta porque toJson() normalmente solo es relevante cuando se infringen los umbrales, en cuyo caso se incluye toda la cadena json de diagnóstico.

Returns:

el valor del encabezado UserAgent usado para el cliente que emitió esta operación

isCompleted

public boolean isCompleted()

Devuelve una marca que indica si la operación se ha completado todavía.

Returns:

una marca que indica si la operación se ha completado todavía.

isFailure

public boolean isFailure()

Marca que indica si la operación debe considerarse errónea o no en función de las reglas de control de código de estado de . CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)

Returns:

una marca que indica si la operación debe considerarse errónea o no

isPointOperation

public boolean isPointOperation()

Marca que indica si la operación es una operación de punto o no.

Returns:

una marca que indica si la operación es una operación de punto o no.

isThresholdViolated

public boolean isThresholdViolated()

Indica si la latencia, el cargo de solicitud o el tamaño de carga de la operación superaron el umbral especificado.

Returns:

una marca que indica si la latencia, el cargo de solicitud o el tamaño de carga de la operación superaron su umbral.

toJson

public String toJson()

Devuelve una representación json-string del contexto de diagnóstico. Esta cadena usa el formato JSON para mejorar la legibilidad, pero debe tratarse como una cadena opaca( el formato puede y cambiará entre las versiones del SDK) para cualquier procesamiento automático de la información de diagnóstico que se deben usar las propiedades get de la API pública.

Returns:

una representación json-string del contexto de diagnóstico. Esta cadena usa el formato JSON para mejorar la legibilidad, pero debe tratarse como una cadena opaca( el formato puede y cambiará entre las versiones del SDK) para cualquier procesamiento automático de la información de diagnóstico que se deben usar las propiedades get de la API pública.