CosmosDiagnostics.ToString Method

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.39.0

Source:

CosmosDiagnostics.cs

Gets the string field CosmosDiagnostics instance in the Azure Cosmos DB database service.

public abstract string ToString ();

override this.ToString : unit -> string

Public MustOverride Function ToString () As String

Returns

String

The string field CosmosDiagnostics instance in the Azure Cosmos DB database service.

Examples

Do not eagerly materialize the diagnostics until the moment of consumption to avoid unnecessary allocations, let the ToString be called only when needed. You can capture diagnostics conditionally, based on latency or errors:

try
{
    ItemResponse<Book> response = await container.CreateItemAsync<Book>(item: testItem);
    if (response.Diagnostics.GetClientElapsedTime() > ConfigurableSlowRequestTimeSpan)
    {
        // Log the diagnostics and add any additional info necessary to correlate to other logs 
        logger.LogInformation("Operation took longer than expected, Diagnostics: {Diagnostics}");
    }
}
catch (CosmosException cosmosException)
{
    // Log the full exception including the stack trace 
    logger.LogError(cosmosException);
    // The Diagnostics can be logged separately if required.
    logger.LogError("Cosmos DB call failed with {StatusCode}, {SubStatusCode}, Diagnostics: {Diagnostics}", cosmosException.StatusCode, cosmosException.SubStatusCode, cosmosException.Diagnostics);
}

Remarks

CosmosDiagnostics implements lazy materialization and is only materialized when ToString() is called.