CosmosDiagnosticsContext Classe

Paquet:

com.azure.cosmos

Artefact Maven:

com.azure:azure-cosmos:4.60.0

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

public final class CosmosDiagnosticsContext

Cette classe fournit des métadonnées pour une opération dans le Kit de développement logiciel (SDK) Cosmos DB qui peut être utilisée par les gestionnaires de diagnostic

Résumé de la méthode

Modificateur et type	Méthode et description
String	getAccountName() Nom du compte lié à l’opération
Integer	getActualItemCount() Nombre réel d’éléments retournés par une opération de flux
String	getConnectionMode() Retourne le mode de connexion utilisé dans le client.
Set<String>	getContactedRegionNames() Retourne l’ensemble des régions contactées
String	getContainerName() Nom du conteneur lié à l’opération
String	getDatabaseName() Nom de la base de données associée à l’opération
Collection<CosmosDiagnostics>	getDiagnostics() Enregistrements de diagnostic pour les interactions de service dans l’étendue de cette opération sdk
Duration	getDuration() Durée totale de l’opération de bout en bout.
ConsistencyLevel	getEffectiveConsistencyLevel() Niveau de cohérence effectif de l’opération
Throwable	getFinalError() Erreur finale lors de l’échec de l’opération
Integer	getMaxItemCount() Max.
int	getMaxRequestPayloadSizeInBytes() Le maximum.
int	getMaxResponsePayloadSizeInBytes() Le maximum.
String	getOperationId() Identificateur d’opération de l’opération : il peut être utilisé pour ajouter une dimension pour les opérations de flux, comme les requêtes, ainsi, les métriques et les diagnostics peuvent être séparés pour différents types de requête, etc.
String	getOperationType() Type d’opération de l’opération
Collection<CosmosDiagnosticsRequestInfo>	getRequestInfo() Obtient une collection d’enregistrements fournissant plus d’informations CosmosDiagnosticsRequestInfo sur les demandes individuelles émises dans la couche de transport pour traiter cette opération.
String	getResourceType() Type de ressource de l’opération
int	getRetryCount() Retourne le nombre de nouvelles tentatives et/ou de tentatives de traitement spéculatif.
int	getStatusCode() Code status final de l’opération (éventuellement après les nouvelles tentatives)
int	getSubStatusCode() Dernier code de sous-status de l’opération (éventuellement après les nouvelles tentatives)
Map<String,Object>	getSystemUsage() Retourne la remarque d’utilisation du système : ces informations ne sont pas incluses dans la représentation json retournée à partir detoJson(), car elles sont généralement pertinentes uniquement en cas de violation de seuils, auquel cas l’intégralité de la diagnostics json-string est incluse.
float	getTotalRequestCharge() Frais de requête totaux pour toutes les nouvelles tentatives.
String	getTrackingId() ID de suivid’une opération d’écriture.
String	getUserAgent() Obtient la valeur d’en-tête de l’agent utilisateurutilisée par le client qui émet cette opération REMARQUE : ces informations ne sont pas incluses dans la représentation json retournée à partir de toJson() car elles sont généralement pertinentes uniquement en cas de violation de seuils, auquel cas l’intégralité de la diagnostics json-string est incluse.
boolean	isCompleted() Retourne un indicateur indiquant si l’opération est encore terminée.
boolean	isFailure() Indicateur indiquant si l’opération doit être considérée comme ayant échoué ou non en fonction de la status règles de gestion du code dansCosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)
boolean	isPointOperation() Indicateur indiquant si l’opération est une opération de point ou non.
boolean	isThresholdViolated() Indique si la latence, la charge de la demande ou la taille de la charge utile de l’opération a dépassé le seuil donné
String	toJson() Retourne une représentation json-string du contexte diagnostics.

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails de la méthode

getAccountName

public String getAccountName()

Nom du compte lié à l’opération

Returns:

nom du compte lié à l’opération

getActualItemCount

public Integer getActualItemCount()

Nombre réel d’éléments retournés par une opération de flux

Returns:

nombre réel d’éléments retournés par une opération de flux. Sera null pour les opérations de point.

getConnectionMode

public String getConnectionMode()

Retourne le mode de connexion utilisé dans le client. REMARQUE : ces informations ne sont pas incluses dans la représentation json retournée partoJson(), car elles ne sont généralement pertinentes que lorsque les seuils sont violés, auquel cas l’intégralité de la diagnostics json-string est incluse.

Returns:

mode de connexion utilisé dans le client.

getContactedRegionNames

public Set getContactedRegionNames()

Retourne l’ensemble des régions contactées

Returns:

l’ensemble des régions contactées

getContainerName

public String getContainerName()

Nom du conteneur lié à l’opération

Returns:

nom de la collection liée à l’opération

getDatabaseName

public String getDatabaseName()

Nom de la base de données associée à l’opération

Returns:

nom de la base de données associée à l’opération

getDiagnostics

public Collection getDiagnostics()

Enregistrements de diagnostic pour les interactions de service dans l’étendue de cette opération sdk

Returns:

les enregistrements de diagnostic pour les interactions de service dans l’étendue de cette opération sdk

getDuration

public Duration getDuration()

Durée totale de l’opération de bout en bout.

Returns:

durée totale de bout en bout de l’opération.

getEffectiveConsistencyLevel

public ConsistencyLevel getEffectiveConsistencyLevel()

Niveau de cohérence effectif de l’opération

Returns:

le niveau de cohérence effectif de l’opération

getFinalError

public Throwable getFinalError()

Erreur finale lors de l’échec de l’opération

Returns:

l’erreur finale lors de l’échec de l’opération

getMaxItemCount

public Integer getMaxItemCount()

Nombre maximal d’éléments demandés dans une opération de flux

Returns:

nombre maximal d’éléments demandés dans une opération de flux. Sera null pour les opérations de point.

getMaxRequestPayloadSizeInBytes

public int getMaxRequestPayloadSizeInBytes()

Taille maximale de la charge utile de la requête en octets

Returns:

taille maximale de la charge utile de la requête en octets

getMaxResponsePayloadSizeInBytes

public int getMaxResponsePayloadSizeInBytes()

Taille maximale de la charge utile de réponse en octets.

Returns:

la taille maximale de la charge utile de réponse en octets

getOperationId

public String getOperationId()

Identificateur d’opération de l’opération : il peut être utilisé pour ajouter une dimension pour les opérations de flux, comme les requêtes, ainsi, les métriques et les diagnostics peuvent être séparés pour différents types de requête, etc.

Returns:

identificateur d’opération de l’opération

getOperationType

public String getOperationType()

Type d’opération de l’opération

Returns:

type d’opération de l’opération

getRequestInfo

public Collection getRequestInfo()

Obtient une collection d’enregistrements fournissant plus d’informations CosmosDiagnosticsRequestInfo sur les demandes individuelles émises dans la couche de transport pour traiter cette opération. REMARQUE : ces informations ne sont pas incluses dans la représentation json retournée, toJson() car elles ne sont généralement pertinentes que lorsque des seuils sont violés, auquel cas l’intégralité de la diagnostics json-string est incluse. L’appel de cette méthode collecte de manière paresseuse l’agent utilisateur, ce qui peut être utile lors de l’écriture d’une méthode personnalisée CosmosDiagnosticsHandler

Returns:

collection d’enregistrements fournissant plus d’informations CosmosDiagnosticsRequestInfo sur les demandes individuelles émises dans la couche de transport pour traiter cette opération.

getResourceType

public String getResourceType()

Type de ressource de l’opération

Returns:

type de ressource de l’opération

getRetryCount

public int getRetryCount()

Retourne le nombre de nouvelles tentatives et/ou de tentatives de traitement spéculatif.

Returns:

nombre de nouvelles tentatives et/ou de tentatives de traitement spéculatif.

getStatusCode

public int getStatusCode()

Code status final de l’opération (éventuellement après les nouvelles tentatives)

Returns:

le code status final de l’opération (éventuellement après les nouvelles tentatives)

getSubStatusCode

public int getSubStatusCode()

Dernier code de sous-status de l’opération (éventuellement après les nouvelles tentatives)

Returns:

le code sous-status final de l’opération (éventuellement après de nouvelles tentatives)

getSystemUsage

public Map getSystemUsage()

Retourne la remarque d’utilisation du système : ces informations ne sont pas incluses dans la représentation json retournée à partir detoJson(), car elles sont généralement pertinentes uniquement en cas de violation de seuils, auquel cas l’intégralité de la diagnostics json-string est incluse. L’appel de cette méthode collecte paresseusement l’utilisation du système, ce qui peut être utile lors de l’écriture d’une méthode personnalisée CosmosDiagnosticsHandler

Returns:

utilisation du système

getTotalRequestCharge

public float getTotalRequestCharge()

Frais de requête totaux pour toutes les nouvelles tentatives.

Returns:

le total des frais de requête pour toutes les nouvelles tentatives.

getTrackingId

public String getTrackingId()

TrackingId d’une opération d’écriture. Sera null pour les opérations de lecture/requête ou de flux ou lorsque les écritures non idempotentes sont désactivées pour les écritures ou uniquement activées sans propagation trackingId.

Returns:

trackingId d’une opération

getUserAgent

public String getUserAgent()

Obtient la valeur d’en-tête UserAgent utilisée par le client qui émet cette opération REMARQUE : ces informations ne sont pas incluses dans la représentation json retournée, toJson() car elles sont généralement pertinentes uniquement en cas de violation des seuils, auquel cas l’intégralité de la diagnostics json-string est incluse.

Returns:

valeur d’en-tête UserAgent utilisée pour le client qui a émis cette opération

isCompleted

public boolean isCompleted()

Retourne un indicateur indiquant si l’opération est encore terminée.

Returns:

indicateur indiquant si l’opération est encore terminée.

isFailure

public boolean isFailure()

Indicateur indiquant si l’opération doit être considérée comme ayant échoué ou non en fonction de la status règles de gestion du code dansCosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)

Returns:

indicateur indiquant si l’opération doit être considérée comme ayant échoué ou non

isPointOperation

public boolean isPointOperation()

Indicateur indiquant si l’opération est une opération de point ou non.

Returns:

indicateur indiquant si l’opération est une opération de point ou non.

isThresholdViolated

public boolean isThresholdViolated()

Indique si la latence, la charge de la demande ou la taille de la charge utile de l’opération a dépassé le seuil donné

Returns:

indicateur indiquant si la latence, la charge de la demande ou la taille de la charge utile de l’opération a dépassé son seuil.

toJson

public String toJson()

Retourne une représentation json-string du contexte diagnostics. Cette chaîne utilise le format json pour la lisibilité, mais elle doit être traitée comme une chaîne opaque - le format peut et sera modifié d’une version du KIT de développement logiciel (SDK) - pour tout traitement automatique des informations diagnostics les propriétés get de l’API publique doivent être utilisées.

Returns:

représentation json-string du contexte diagnostics. Cette chaîne utilise le format json pour la lisibilité, mais elle doit être traitée comme une chaîne opaque - le format peut et sera modifié d’une version du KIT de développement logiciel (SDK) - pour tout traitement automatique des informations diagnostics les propriétés get de l’API publique doivent être utilisées.