Freigeben über

CosmosDiagnosticsContext Klasse

  • Referenz
Paket:
com.azure.cosmos
Maven-Artefakt:
com.azure:azure-cosmos:4.60.0
  • java.lang.Object
    • com.azure.cosmos.CosmosDiagnosticsContext

public final class CosmosDiagnosticsContext

Diese Klasse stellt Metadaten für einen Vorgang im Cosmos DB SDK bereit, der von Diagnosehandlern verwendet werden kann.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
String getAccountName()

Der Name des Kontos im Zusammenhang mit dem Vorgang.
Integer getActualItemCount()

Die tatsächliche Anzahl von Elementen, die von einem Feedvorgang zurückgegeben werden
String getConnectionMode()

Gibt den im Client verwendeten Verbindungsmodus zurück.
Set<String> getContactedRegionNames()

Gibt den Satz der kontaktierten Regionen zurück.
String getContainerName()

Der Name des Containers, der sich auf den Vorgang bezieht.
String getDatabaseName()

Der Name der Datenbank im Zusammenhang mit dem Vorgang.
Collection<CosmosDiagnostics> getDiagnostics()

Die Diagnosedatensätze für Dienstinteraktionen im Rahmen dieses SDK-Vorgangs
Duration getDuration()

Die gesamte End-to-End-Dauer des Vorgangs.
ConsistencyLevel getEffectiveConsistencyLevel()

Die effektive Konsistenzebene des Vorgangs
Throwable getFinalError()

Der letzte Fehler, wenn der Vorgang fehlgeschlagen ist
Integer getMaxItemCount()

Die max.
int getMaxRequestPayloadSizeInBytes()

Die max.
int getMaxResponsePayloadSizeInBytes()

Die max.
String getOperationId()

Der Vorgangsbezeichner des Vorgangs– dieser kann verwendet werden, um eine Dimension für Feedvorgänge wie Abfragen hinzuzufügen, sodass Metriken und Diagnose für verschiedene Abfragetypen usw. getrennt werden können.
String getOperationType()

Der Vorgangstyp des Vorgangs
Collection<CosmosDiagnosticsRequestInfo> getRequestInfo()

Ruft eine Auflistung von CosmosDiagnosticsRequestInfo Datensätzen ab, die weitere Informationen zu einzelnen Anforderungen bereitstellen, die in der Transportschicht ausgegeben werden, um diesen Vorgang zu verarbeiten.
String getResourceType()

Der Ressourcentyp des Vorgangs.
int getRetryCount()

Gibt die Anzahl der Wiederholungsversuche und/oder Versuche für die spekulative Verarbeitung zurück.
int getStatusCode()

Der endgültige status Code des Vorgangs (möglicherweise nach Wiederholungen)
int getSubStatusCode()

Der endgültige Unter-status Code des Vorgangs (möglicherweise nach Wiederholungen)
Map<String,Object> getSystemUsage()

Gibt die Systemnutzung zurück HINWEIS: Diese Informationen sind nicht in der json-Darstellung enthalten, die von toJson() zurückgegeben wird, da sie in der Regel nur relevant ist, wenn Schwellenwerte verletzt werden. In diesem Fall ist die gesamte Diagnose json-Zeichenfolge enthalten.
float getTotalRequestCharge()

Die Gesamtanforderungsgebühr für alle Wiederholungen.
String getTrackingId()

Die Nachverfolgungs-IDeines Schreibvorgangs.
String getUserAgent()

Ruft denBenutzer-Agent-Headerwert ab, der vom Client verwendet wird, der diesen Vorgang ausgibt HINWEIS: Diese Informationen sind nicht in der JSON-Darstellung enthalten, die von toJson() zurückgegeben wird, da sie in der Regel nur relevant ist, wenn Schwellenwerte verletzt werden. In diesem Fall ist die gesamte Diagnose JSON-Zeichenfolge enthalten.
boolean isCompleted()

Gibt ein Flag zurück, das angibt, ob der Vorgang noch abgeschlossen wurde.
boolean isFailure()

Ein Flag, das angibt, ob der Vorgang basierend auf den status Codebehandlungsregeln in als fehlgeschlagen eingestuft werden soll.CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)
boolean isPointOperation()

Ein Flag, das angibt, ob der Vorgang ein Punktvorgang ist oder nicht.
boolean isThresholdViolated()

Gibt an, ob die Latenz, Anforderungsgebühr oder Nutzlastgröße des Vorgangs den angegebenen Schwellenwert überschritten hat.
String toJson()

Gibt eine JSON-Zeichenfolgendarstellung des Diagnose Kontexts zurück.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zur Methode

getAccountName

public String getAccountName()

Der Name des Kontos im Zusammenhang mit dem Vorgang.

Returns:

Der Name des Kontos, das sich auf den Vorgang bezieht

getActualItemCount

public Integer getActualItemCount()

Die tatsächliche Anzahl von Elementen, die von einem Feedvorgang zurückgegeben werden

Returns:

die tatsächliche Anzahl von Elementen, die von einem Feedvorgang zurückgegeben werden. Ist für Punktvorgänge NULL.

getConnectionMode

public String getConnectionMode()

Gibt den im Client verwendeten Verbindungsmodus zurück. HINWEIS: Diese Informationen sind nicht in der JSON-Darstellung enthalten, die von toJson() zurückgegeben wird, da sie in der Regel nur relevant ist, wenn Schwellenwerte verletzt werden. In diesem Fall ist die gesamte Diagnose JSON-Zeichenfolge enthalten.

Returns:

der im Client verwendete Verbindungsmodus.

getContactedRegionNames

public Set getContactedRegionNames()

Gibt den Satz der kontaktierten Regionen zurück.

Returns:

die Gruppe der kontaktierten Regionen

getContainerName

public String getContainerName()

Der Name des Containers, der sich auf den Vorgang bezieht.

Returns:

der Name der Auflistung, die sich auf den Vorgang bezieht

getDatabaseName

public String getDatabaseName()

Der Name der Datenbank im Zusammenhang mit dem Vorgang.

Returns:

Der Name der Datenbank, die sich auf den Vorgang bezieht

getDiagnostics

public Collection getDiagnostics()

Die Diagnosedatensätze für Dienstinteraktionen im Rahmen dieses SDK-Vorgangs

Returns:

Die Diagnosedatensätze für Dienstinteraktionen im Rahmen dieses SDK-Vorgangs

getDuration

public Duration getDuration()

Die gesamte End-to-End-Dauer des Vorgangs.

Returns:

die Gesamte End-to-End-Dauer des Vorgangs.

getEffectiveConsistencyLevel

public ConsistencyLevel getEffectiveConsistencyLevel()

Die effektive Konsistenzebene des Vorgangs

Returns:

die effektive Konsistenzebene des Vorgangs

getFinalError

public Throwable getFinalError()

Der letzte Fehler, wenn der Vorgang fehlgeschlagen ist

Returns:

der letzte Fehler, wenn der Vorgang fehlgeschlagen ist

getMaxItemCount

public Integer getMaxItemCount()

Die maximale Anzahl von Elementen, die in einem Feedvorgang angefordert werden

Returns:

die maximale Anzahl von Elementen, die in einem Feedvorgang angefordert werden. Ist für Punktvorgänge NULL.

getMaxRequestPayloadSizeInBytes

public int getMaxRequestPayloadSizeInBytes()

Die maximale Anforderungsnutzlastgröße in Bytes

Returns:

die maximale Anforderungsnutzlastgröße in Bytes

getMaxResponsePayloadSizeInBytes

public int getMaxResponsePayloadSizeInBytes()

Die maximale Antwortnutzlastgröße in Bytes.

Returns:

die maximale Antwortnutzlastgröße in Bytes

getOperationId

public String getOperationId()

Der Vorgangsbezeichner des Vorgangs– dieser kann verwendet werden, um eine Dimension für Feedvorgänge wie Abfragen hinzuzufügen, sodass Metriken und Diagnose für verschiedene Abfragetypen usw. getrennt werden können.

Returns:

Der Vorgangsbezeichner des Vorgangs

getOperationType

public String getOperationType()

Der Vorgangstyp des Vorgangs

Returns:

Der Vorgangstyp des Vorgangs

getRequestInfo

public Collection getRequestInfo()

Ruft eine Auflistung von CosmosDiagnosticsRequestInfo Datensätzen ab, die weitere Informationen zu einzelnen Anforderungen bereitstellen, die in der Transportschicht ausgegeben werden, um diesen Vorgang zu verarbeiten. HINWEIS: Diese Informationen sind nicht in der JSON-Darstellung enthalten, die von toJson() zurückgegeben wird, da sie in der Regel nur relevant ist, wenn Schwellenwerte verletzt werden. In diesem Fall ist die gesamte Diagnose JSON-Zeichenfolge enthalten. Wenn Sie diese Methode aufrufen, wird der Benutzer-Agent verzögert erfasst. Dies kann beim Schreiben einer benutzerdefinierten Methode hilfreich sein. CosmosDiagnosticsHandler

Returns:

Eine Sammlung von CosmosDiagnosticsRequestInfo Datensätzen, die weitere Informationen zu einzelnen Anforderungen bereitstellen, die in der Transportschicht ausgegeben werden, um diesen Vorgang zu verarbeiten.

getResourceType

public String getResourceType()

Der Ressourcentyp des Vorgangs.

Returns:

Der Ressourcentyp des Vorgangs

getRetryCount

public int getRetryCount()

Gibt die Anzahl der Wiederholungsversuche und/oder Versuche für die spekulative Verarbeitung zurück.

Returns:

die Anzahl der Wiederholungsversuche und/oder Versuche für die spekulative Verarbeitung.

getStatusCode

public int getStatusCode()

Der endgültige status Code des Vorgangs (möglicherweise nach Wiederholungen)

Returns:

der endgültige status Code des Vorgangs (möglicherweise nach Wiederholungen)

getSubStatusCode

public int getSubStatusCode()

Der endgültige Unter-status Code des Vorgangs (möglicherweise nach Wiederholungen)

Returns:

der endgültige Unter-status Code des Vorgangs (möglicherweise nach Wiederholungen)

getSystemUsage

public Map getSystemUsage()

Gibt die Systemnutzung zurück HINWEIS: Diese Informationen sind nicht in der json-Darstellung enthalten, die von toJson() zurückgegeben wird, da sie in der Regel nur relevant ist, wenn Schwellenwerte verletzt werden. In diesem Fall ist die gesamte Diagnose json-Zeichenfolge enthalten. Wenn Sie diese Methode aufrufen, wird die Systemnutzung verzögert erfasst. Dies kann beim Schreiben einer benutzerdefinierten Methode hilfreich sein. CosmosDiagnosticsHandler

Returns:

die Systemnutzung

getTotalRequestCharge

public float getTotalRequestCharge()

Die Gesamtanforderungsgebühr für alle Wiederholungen.

Returns:

die Gesamtanforderungsgebühr für alle Wiederholungen.

getTrackingId

public String getTrackingId()

Die trackingId eines Schreibvorgangs. Ist null für Lese-/Abfrage- oder Feedvorgänge oder wenn nicht idempotente Schreibvorgänge für Schreibvorgänge deaktiviert oder nur ohne trackingId-Weitergabe aktiviert sind.

Returns:

die trackingId eines Vorgangs

getUserAgent

public String getUserAgent()

Ruft den UserAgent-Headerwert ab, der vom Client verwendet wird, der diesen Vorgang ausgibt HINWEIS: Diese Informationen sind nicht in der JSON-Darstellung enthalten, die von toJson() zurückgegeben wird, da sie in der Regel nur relevant ist, wenn Schwellenwerte verletzt werden. In diesem Fall ist die gesamte Diagnose json-string enthalten.

Returns:

Der UserAgent-Headerwert, der für den Client verwendet wird, der diesen Vorgang ausgegeben hat.

isCompleted

public boolean isCompleted()

Gibt ein Flag zurück, das angibt, ob der Vorgang noch abgeschlossen wurde.

Returns:

ein Flag, das angibt, ob der Vorgang noch abgeschlossen wurde.

isFailure

public boolean isFailure()

Ein Flag, das angibt, ob der Vorgang basierend auf den status Codebehandlungsregeln in als fehlgeschlagen eingestuft werden soll.CosmosDiagnosticsThresholds#setFailureHandler(java.util.function.BiPredicate)

Returns:

ein Flag, das angibt, ob der Vorgang als fehlgeschlagen betrachtet werden soll oder nicht.

isPointOperation

public boolean isPointOperation()

Ein Flag, das angibt, ob der Vorgang ein Punktvorgang ist oder nicht.

Returns:

ein Flag, das angibt, ob es sich bei dem Vorgang um einen Punktvorgang handelt oder nicht.

isThresholdViolated

public boolean isThresholdViolated()

Gibt an, ob die Latenz, Anforderungsgebühr oder Nutzlastgröße des Vorgangs den angegebenen Schwellenwert überschritten hat.

Returns:

ein Flag, das angibt, ob die Latenz, die Anforderungsgebühr oder die Nutzlastgröße des Vorgangs den Schwellenwert überschritten hat.

toJson

public String toJson()

Gibt eine JSON-Zeichenfolgendarstellung des Diagnose Kontexts zurück. Diese Zeichenfolge verwendet aus Gründen der Lesbarkeit das JSON-Format, sollte jedoch als undurchsichtige Zeichenfolge behandelt werden - das Format kann und wird sich zwischen SDK-Versionen ändern - für jede automatische Verarbeitung der Diagnose Informationen, die get-properties der öffentlichen API verwendet werden sollten.

Returns:

eine JSON-Zeichenfolgendarstellung des Diagnose Kontexts. Diese Zeichenfolge verwendet aus Gründen der Lesbarkeit das JSON-Format, sollte jedoch als undurchsichtige Zeichenfolge behandelt werden - das Format kann und wird sich zwischen SDK-Versionen ändern - für jede automatische Verarbeitung der Diagnose Informationen, die get-properties der öffentlichen API verwendet werden sollten.

Gilt für: