Package com.azure.cosmos.models

Class CosmosMetricName

java.lang.Object
com.azure.cosmos.models.CosmosMetricName
public final class CosmosMetricName extends Object
Names of Cosmos DB client-side meters

  • Field Details

    • OPERATION_SUMMARY_CALLS

      public static final CosmosMetricName OPERATION_SUMMARY_CALLS
      Number of operation calls (Counter)

    • OPERATION_SUMMARY_LATENCY

      public static final CosmosMetricName OPERATION_SUMMARY_LATENCY
      Total latency (across requests including retries) of the operation (Timer)

    • OPERATION_SUMMARY_REQUEST_CHARGE

      public static final CosmosMetricName OPERATION_SUMMARY_REQUEST_CHARGE
      Request charge for the operation (DistributionSummary)

    • OPERATION_DETAILS_REGIONS_CONTACTED

      public static final CosmosMetricName OPERATION_DETAILS_REGIONS_CONTACTED
      Number of regions contacted for processing the operation (DistributionSummary)

    • OPERATION_DETAILS_ACTUAL_ITEM_COUNT

      public static final CosmosMetricName OPERATION_DETAILS_ACTUAL_ITEM_COUNT
      Actual item count - relevant for non-point-operations - indicating the actual number of docs returned in the response (DistributionSummary) NOTE: No percentiles or histogram supported

    • OPERATION_DETAILS_MAX_ITEM_COUNT

      public static final CosmosMetricName OPERATION_DETAILS_MAX_ITEM_COUNT
      Max. item count - relevant for non-point-operations - indicating the requested max. number of docs returned in a single response (DistributionSummary) NOTE: No percentiles or histogram supported

    • REQUEST_SUMMARY_DIRECT_REQUESTS

      public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_REQUESTS
      Number of requests (Counter) NOTE: No percentiles or histogram supported

    • REQUEST_SUMMARY_DIRECT_LATENCY

      public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_LATENCY
      Latency of the request (Timer)

    • REQUEST_SUMMARY_DIRECT_BACKEND_LATENCY

      public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_BACKEND_LATENCY
      Backend-latency of the request (DistributionSummary)

    • REQUEST_SUMMARY_DIRECT_REQUEST_CHARGE

      public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_REQUEST_CHARGE
      Request charge for a request (DistributionSummary)

    • REQUEST_SUMMARY_DIRECT_ACTUAL_ITEM_COUNT

      public static final CosmosMetricName REQUEST_SUMMARY_DIRECT_ACTUAL_ITEM_COUNT
      Actual item count - relevant for non-point-operations - indicating the actual number of docs returned in the response (DistributionSummary) NOTE: No percentiles or histogram supported

    • REQUEST_SUMMARY_GATEWAY_REQUESTS

      public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_REQUESTS
      Number of requests (Counter) NOTE: No percentiles or histogram supported

    • REQUEST_SUMMARY_GATEWAY_LATENCY

      public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_LATENCY
      Latency of the request (Timer)

    • REQUEST_SUMMARY_GATEWAY_REQUEST_CHARGE

      public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_REQUEST_CHARGE
      Request charge for a request (DistributionSummary)

    • REQUEST_SUMMARY_GATEWAY_ACTUAL_ITEM_COUNT

      public static final CosmosMetricName REQUEST_SUMMARY_GATEWAY_ACTUAL_ITEM_COUNT
      Actual item count - relevant for non-point-operations - indicating the actual number of docs returned in the response (DistributionSummary) NOTE: No percentiles or histogram supported

    • REQUEST_SUMMARY_SIZE_REQUEST

      public static final CosmosMetricName REQUEST_SUMMARY_SIZE_REQUEST
      Size of the request payload (DistributionSummary) NOTE: No percentiles or histogram supported

    • REQUEST_SUMMARY_SIZE_RESPONSE

      public static final CosmosMetricName REQUEST_SUMMARY_SIZE_RESPONSE
      Size of the response payload (DistributionSummary) NOTE: No percentiles or histogram supported

    • REQUEST_DETAILS_DIRECT_TIMELINE

      public static final CosmosMetricName REQUEST_DETAILS_DIRECT_TIMELINE
      Latency in different steps of the request pipeline (Timer)

    • REQUEST_DETAILS_GATEWAY_TIMELINE

      public static final CosmosMetricName REQUEST_DETAILS_GATEWAY_TIMELINE
      Latency in different steps of the request pipeline (Timer)

    • DIRECT_CHANNELS_ACQUIRED_COUNT

      public static final CosmosMetricName DIRECT_CHANNELS_ACQUIRED_COUNT
      Number of acquired channels (new connections) for this endpoint (FunctionCounter)

    • DIRECT_CHANNELS_CLOSED_COUNT

      public static final CosmosMetricName DIRECT_CHANNELS_CLOSED_COUNT
      Number of closed channels / connections for this endpoint (FunctionCounter)

    • DIRECT_CHANNELS_AVAILABLE_COUNT

      public static final CosmosMetricName DIRECT_CHANNELS_AVAILABLE_COUNT
      Snapshot of the number of available channels (active connections) for this endpoint (Gauge)

    • DIRECT_ENDPOINTS_COUNT

      public static final CosmosMetricName DIRECT_ENDPOINTS_COUNT
      Snapshot of the number of endpoints (Gauge)

    • DIRECT_ENDPOINTS_EVICTED

      public static final CosmosMetricName DIRECT_ENDPOINTS_EVICTED
      Number of evicted/closed endpoints (FunctionCounter)

    • DIRECT_ADDRESS_RESOLUTION_REQUESTS

      public static final CosmosMetricName DIRECT_ADDRESS_RESOLUTION_REQUESTS
      Number of RNTBD address resolution requests (Counter)

    • DIRECT_ADDRESS_RESOLUTION_LATENCY

      public static final CosmosMetricName DIRECT_ADDRESS_RESOLUTION_LATENCY
      Latency of the RNTBD address resolution request (Timer)

    • DIRECT_REQUEST_LATENCY

      public static final CosmosMetricName DIRECT_REQUEST_LATENCY
      Latency of RNTBD requests for this endpoint (Timer)

    • DIRECT_REQUEST_LATENCY_FAILED

      public static final CosmosMetricName DIRECT_REQUEST_LATENCY_FAILED
      Latency of failed RNTBD requests for this endpoint (Timer)

    • DIRECT_REQUEST_LATENCY_SUCCESS

      public static final CosmosMetricName DIRECT_REQUEST_LATENCY_SUCCESS
      Latency of successful RNTBD requests for this endpoint (Timer)

    • DIRECT_REQUEST_CONCURRENT_COUNT

      public static final CosmosMetricName DIRECT_REQUEST_CONCURRENT_COUNT
      Snapshot of number of concurrent RNTBD requests for this endpoint (Gauge)

    • DIRECT_REQUEST_QUEUED_COUNT

      public static final CosmosMetricName DIRECT_REQUEST_QUEUED_COUNT
      Snapshot of number of queued RNTBD requests for this endpoint (Gauge)

    • DIRECT_REQUEST_SIZE_REQUEST

      public static final CosmosMetricName DIRECT_REQUEST_SIZE_REQUEST
      Size of the request payload (DistributionSummary)

    • DIRECT_REQUEST_SIZE_RESPONSE

      public static final CosmosMetricName DIRECT_REQUEST_SIZE_RESPONSE
      Size of the response payload (DistributionSummary)

    • SYSTEM_CPU

      public static final CosmosMetricName SYSTEM_CPU
      Avg. system-wide CPU load (DistributionSummary)

    • SYSTEM_MEMORY_FREE

      public static final CosmosMetricName SYSTEM_MEMORY_FREE
      JVM's Free available memory (DistributionSummary)

    • LEGACY_DIRECT_ENDPOINT_STATISTICS_ACQUIRED

      public static final CosmosMetricName LEGACY_DIRECT_ENDPOINT_STATISTICS_ACQUIRED
      Distribution summary over snapshot of acquired channels for the endpoint at time of a request (DistributionSummary)

    • LEGACY_DIRECT_ENDPOINT_STATISTICS_AVAILABLE

      public static final CosmosMetricName LEGACY_DIRECT_ENDPOINT_STATISTICS_AVAILABLE
      Distribution summary over snapshot of available channels for the endpoint at time of a request (DistributionSummary)

    • LEGACY_DIRECT_ENDPOINT_STATISTICS_INFLIGHT

      public static final CosmosMetricName LEGACY_DIRECT_ENDPOINT_STATISTICS_INFLIGHT
      Distribution summary over snapshot of inflight channels for the endpoint at time of a request (DistributionSummary)

  • Method Details

    • fromString

      public static CosmosMetricName fromString(String name)
      Gets the corresponding metric category state from its string representation.
      Parameters:
      name - The name of the Cosmos metric category to convert.
      Returns:
      The corresponding Cosmos metric category.

    • getCategory

      public CosmosMetricCategory getCategory()
      Gets the meter category of the meter
      Returns:
      the category of the meter

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object