CosmosDiagnosticsContext Classe

Pacote:

com.azure.cosmos

Artefato Maven:

com.azure:azure-cosmos:4.60.0

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

public final class CosmosDiagnosticsContext

Essa classe fornece metadados para uma operação no SDK do Cosmos DB que pode ser usada por manipuladores de diagnóstico

Resumo do método

Modificador e tipo	Método e descrição
String	getAccountName() O nome da conta relacionada à operação
Integer	getActualItemCount() O número real de itens retornados por uma operação de feed
String	getConnectionMode() Retorna o modo de conexão usado no cliente.
Set<String>	getContactedRegionNames() Retorna o conjunto de regiões contatadas
String	getContainerName() O nome do contêiner relacionado à operação
String	getDatabaseName() O nome do banco de dados relacionado à operação
Collection<CosmosDiagnostics>	getDiagnostics() Os registros de diagnóstico para interações de serviço dentro do escopo dessa operação do SDK
Duration	getDuration() A duração total de ponta a ponta da operação.
ConsistencyLevel	getEffectiveConsistencyLevel() O nível de consistência efetivo da operação
Throwable	getFinalError() O erro final quando a operação falhou
Integer	getMaxItemCount() O máximo.
int	getMaxRequestPayloadSizeInBytes() O máximo.
int	getMaxResponsePayloadSizeInBytes() O máximo.
String	getOperationId() O identificador de operação da operação - isso pode ser usado para adicionar uma dimensão para operações de feed - como consultas - para que métricas e diagnóstico possam ser separados para diferentes tipos de consulta etc.
String	getOperationType() O tipo de operação da operação
Collection<CosmosDiagnosticsRequestInfo>	getRequestInfo() Obtém uma coleção de CosmosDiagnosticsRequestInfo registros que fornecem mais informações sobre solicitações individuais emitidas na camada de transporte para processar essa operação.
String	getResourceType() O tipo de recurso da operação
int	getRetryCount() Retorna o número de repetições e/ou tentativas de processamento especulativo.
int	getStatusCode() O código final status da operação (possivelmente após novas tentativas)
int	getSubStatusCode() O código de sub-status final da operação (possivelmente após novas tentativas)
Map<String,Object>	getSystemUsage() Retorna a OBSERVAÇÃO de uso do sistema: essas informações não são incluídas na representação json retornada porque toJson() geralmente só são relevantes quando os limites são violados; nesse caso, toda a diagnóstico cadeia de caracteres json está incluída.
float	getTotalRequestCharge() O custo total da solicitação em todas as tentativas.
String	getTrackingId() A ID de rastreamentode uma operação de gravação.
String	getUserAgent() Obtém o valor de cabeçalho do Agente de Usuáriousado pelo cliente que emite esta operação OBSERVAÇÃO: essas informações não são incluídas na representação json retornada porque toJson() geralmente só são relevantes quando os limites são violados; nesse caso, toda a diagnóstico cadeia de caracteres json está incluída.
boolean	isCompleted() Retorna um sinalizador que indica se a operação foi concluída ainda.
boolean	isFailure() Um sinalizador que indica se a operação deve ser considerada com falha ou não com base no status regras de tratamento de código noCosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)
boolean	isPointOperation() Um sinalizador que indica se a operação é uma operação de ponto ou não.
boolean	isThresholdViolated() Indica se a latência, a cobrança da solicitação ou o tamanho do conteúdo da operação excedeu o limite especificado
String	toJson() Retorna uma representação de cadeia de caracteres json do contexto diagnóstico.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

getAccountName

public String getAccountName()

O nome da conta relacionada à operação

Returns:

o nome da conta relacionada à operação

getActualItemCount

public Integer getActualItemCount()

O número real de itens retornados por uma operação de feed

Returns:

o número real de itens retornados por uma operação de feed. Será nulo para operações de ponto.

getConnectionMode

public String getConnectionMode()

Retorna o modo de conexão usado no cliente. OBSERVAÇÃO: essas informações não estão incluídas na representação json retornada de toJson() porque geralmente só são relevantes quando os limites são violados; nesse caso, toda a diagnóstico cadeia de caracteres json está incluída.

Returns:

o modo de conexão usado no cliente.

getContactedRegionNames

public Set getContactedRegionNames()

Retorna o conjunto de regiões contatadas

Returns:

o conjunto de regiões contatadas

getContainerName

public String getContainerName()

O nome do contêiner relacionado à operação

Returns:

o nome da coleção relacionada à operação

getDatabaseName

public String getDatabaseName()

O nome do banco de dados relacionado à operação

Returns:

o nome do banco de dados relacionado à operação

getDiagnostics

public Collection getDiagnostics()

Os registros de diagnóstico para interações de serviço dentro do escopo dessa operação do SDK

Returns:

os registros de diagnóstico para interações de serviço dentro do escopo dessa operação do SDK

getDuration

public Duration getDuration()

A duração total de ponta a ponta da operação.

Returns:

a duração total de ponta a ponta da operação.

getEffectiveConsistencyLevel

public ConsistencyLevel getEffectiveConsistencyLevel()

O nível de consistência efetivo da operação

Returns:

o nível de consistência efetivo da operação

getFinalError

public Throwable getFinalError()

O erro final quando a operação falhou

Returns:

o erro final quando a operação falhou

getMaxItemCount

public Integer getMaxItemCount()

O número máximo de itens solicitados em uma operação de feed

Returns:

o número máximo de itens solicitados em uma operação de feed. Será nulo para operações de ponto.

getMaxRequestPayloadSizeInBytes

public int getMaxRequestPayloadSizeInBytes()

O tamanho máximo do conteúdo da solicitação em bytes

Returns:

o tamanho máximo da carga de solicitação em bytes

getMaxResponsePayloadSizeInBytes

public int getMaxResponsePayloadSizeInBytes()

O tamanho máximo da carga de resposta em bytes.

Returns:

o tamanho máximo da carga de resposta em bytes

getOperationId

public String getOperationId()

O identificador de operação da operação - isso pode ser usado para adicionar uma dimensão para operações de feed - como consultas - para que métricas e diagnóstico possam ser separados para diferentes tipos de consulta etc.

Returns:

o identificador de operação da operação

getOperationType

public String getOperationType()

O tipo de operação da operação

Returns:

o tipo de operação da operação

getRequestInfo

public Collection getRequestInfo()

Obtém uma coleção de CosmosDiagnosticsRequestInfo registros que fornecem mais informações sobre solicitações individuais emitidas na camada de transporte para processar essa operação. OBSERVAÇÃO: essas informações não estão incluídas na representação json retornada de toJson() porque geralmente só são relevantes quando os limites são violados; nesse caso, toda a diagnóstico cadeia de caracteres json está incluída. Chamar esse método coletará lentamente o agente do usuário , o que pode ser útil ao escrever um personalizado CosmosDiagnosticsHandler

Returns:

uma coleção de CosmosDiagnosticsRequestInfo registros que fornecem mais informações sobre solicitações individuais emitidas na camada de transporte para processar essa operação.

getResourceType

public String getResourceType()

O tipo de recurso da operação

Returns:

o tipo de recurso da operação

getRetryCount

public int getRetryCount()

Retorna o número de repetições e/ou tentativas de processamento especulativo.

Returns:

o número de tentativas e/ou tentativas de processamento especulativo.

getStatusCode

public int getStatusCode()

O código final status da operação (possivelmente após novas tentativas)

Returns:

o código de status final da operação (possivelmente após novas tentativas)

getSubStatusCode

public int getSubStatusCode()

O código de sub-status final da operação (possivelmente após novas tentativas)

Returns:

o código de sub-status final da operação (possivelmente após novas tentativas)

getSystemUsage

public Map getSystemUsage()

Retorna a OBSERVAÇÃO de uso do sistema: essas informações não são incluídas na representação json retornada porque toJson() geralmente só são relevantes quando os limites são violados; nesse caso, toda a diagnóstico cadeia de caracteres json está incluída. Chamar esse método coletará lentamente o uso do sistema , o que pode ser útil ao escrever um personalizado CosmosDiagnosticsHandler

Returns:

o uso do sistema

getTotalRequestCharge

public float getTotalRequestCharge()

O custo total da solicitação em todas as tentativas.

Returns:

o custo total da solicitação em todas as tentativas.

getTrackingId

public String getTrackingId()

A trackingId de uma operação de gravação. Será nulo para operações de leitura/consulta ou feed ou quando gravações não idempotentes forem desabilitadas para gravações ou habilitadas somente sem propagação trackingId.

Returns:

a trackingId de uma operação

getUserAgent

public String getUserAgent()

Obtém o valor de cabeçalho UserAgent usado pelo cliente que está emitindo esta operação OBSERVAÇÃO: essas informações não são incluídas na representação json retornada porque toJson() geralmente só são relevantes quando os limites são violados; nesse caso, toda a diagnóstico cadeia de caracteres json está incluída.

Returns:

o valor do cabeçalho UserAgent usado para o cliente que emitiu esta operação

isCompleted

public boolean isCompleted()

Retorna um sinalizador que indica se a operação foi concluída ainda.

Returns:

um sinalizador que indica se a operação foi concluída ainda.

isFailure

public boolean isFailure()

Um sinalizador que indica se a operação deve ser considerada com falha ou não com base no status regras de tratamento de código noCosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)

Returns:

um sinalizador que indica se a operação deve ser considerada com falha ou não

isPointOperation

public boolean isPointOperation()

Um sinalizador que indica se a operação é uma operação de ponto ou não.

Returns:

um sinalizador que indica se a operação é uma operação de ponto ou não.

isThresholdViolated

public boolean isThresholdViolated()

Indica se a latência, a cobrança da solicitação ou o tamanho do conteúdo da operação excedeu o limite especificado

Returns:

um sinalizador que indica se a latência, a cobrança da solicitação ou o tamanho do conteúdo da operação excedeu seu limite.

toJson

public String toJson()

Retorna uma representação de cadeia de caracteres json do contexto diagnóstico. Essa cadeia de caracteres usa o formato json para facilitar a leitura, mas deve ser tratada como uma cadeia de caracteres opaca – o formato pode e mudará entre as versões do SDK – para qualquer processamento automático das informações de diagnóstico as propriedades get da API pública devem ser usadas.

Returns:

uma representação de cadeia de caracteres json do contexto diagnóstico. Essa cadeia de caracteres usa o formato json para facilitar a leitura, mas deve ser tratada como uma cadeia de caracteres opaca – o formato pode e mudará entre as versões do SDK – para qualquer processamento automático das informações de diagnóstico as propriedades get da API pública devem ser usadas.