CosmosMetricTagName Class

Package:

com.azure.cosmos.models

Maven Artifact:

com.azure:azure-cosmos:4.79.1

• java.lang.Object
• • com.azure.cosmos.models.CosmosMetricTagName

public final class CosmosMetricTagName

The tag names that can be used for Cosmos client-side meters. Not all tag names are applicable for all meters, but this identifier can be used to tune which tags to use for individual meters or also define the default tags that should be used when no meter-specific suppression exists.

Field Summary

Modifier and Type	Field and Description
static final CosmosMetricTagName	ADDRESS_RESOLUTION_COLLECTION_MAP_REFRESH An indicator whether an address resolution refresh requested a collection routing map cache refresh Applicable to address resolutions
static final CosmosMetricTagName	ADDRESS_RESOLUTION_FORCED_REFRESH An indicator whether an address resolution refresh requested a cache refresh Applicable to address resolutions
static final CosmosMetricTagName	ALL All possible tags
static final CosmosMetricTagName	CLIENT_CORRELATION_ID An identifier for the instance of the Cosmos client Applicable to all meters
static final CosmosMetricTagName	CONSISTENCY_LEVEL Effective Consistency model Applicable to operations and requests
static final CosmosMetricTagName	CONTAINER Container identifier applicable to operations and requests
static final CosmosMetricTagName	DEFAULT Default tags
static final CosmosMetricTagName	MINIMUM Minimum tags that are required and cannot be disabled
static final CosmosMetricTagName	OPERATION Operation type Applicable to operations
static final CosmosMetricTagName	OPERATION_STATUS_CODE Operation status code.
static final CosmosMetricTagName	OPERATION_SUB_STATUS_CODE Operation sub-status code.
static final CosmosMetricTagName	PARTITION_ID The PartitionId (Guid) Applicable to requests
static final CosmosMetricTagName	PARTITION_KEY_RANGE_ID A numeric identifier for a physical partition Applicable to operations and requests
static final CosmosMetricTagName	REGION_NAME The region names of the regions handling the operation/request Applicable to requests and operations
static final CosmosMetricTagName	REPLICA_ID The ReplicaId (int identifier plus suffix "s" (secondary - read-only - replica) or "p" (primary- write - replica) Applicable to requests
static final CosmosMetricTagName	REQUEST_OPERATION_TYPE Request operation type Applicable to requests
static final CosmosMetricTagName	REQUEST_STATUS_CODE Request status code Applicable to requests
static final CosmosMetricTagName	SERVICE_ADDRESS The service endpoint (hostname + port, partitionId, replicaId) Applicable to requests
static final CosmosMetricTagName	SERVICE_ENDPOINT The service endpoint (hostname + port) Applicable to requests, direct channel, direct endpoint and direct requests

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static CosmosMetricTagName	fromString(String name) Gets the corresponding metric category state from its string representation.
int	hashCode()
String	toString()

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Details

ADDRESS_RESOLUTION_COLLECTION_MAP_REFRESH

public static final CosmosMetricTagName ADDRESS_RESOLUTION_COLLECTION_MAP_REFRESH

An indicator whether an address resolution refresh requested a collection routing map cache refresh Applicable to address resolutions

ADDRESS_RESOLUTION_FORCED_REFRESH

public static final CosmosMetricTagName ADDRESS_RESOLUTION_FORCED_REFRESH

An indicator whether an address resolution refresh requested a cache refresh Applicable to address resolutions

ALL

public static final CosmosMetricTagName ALL

All possible tags

CLIENT_CORRELATION_ID

public static final CosmosMetricTagName CLIENT_CORRELATION_ID

An identifier for the instance of the Cosmos client Applicable to all meters

CONSISTENCY_LEVEL

public static final CosmosMetricTagName CONSISTENCY_LEVEL

Effective Consistency model Applicable to operations and requests

CONTAINER

public static final CosmosMetricTagName CONTAINER

Container identifier applicable to operations and requests

DEFAULT

public static final CosmosMetricTagName DEFAULT

Default tags

MINIMUM

public static final CosmosMetricTagName MINIMUM

Minimum tags that are required and cannot be disabled

OPERATION

public static final CosmosMetricTagName OPERATION

Operation type Applicable to operations

OPERATION_STATUS_CODE

public static final CosmosMetricTagName OPERATION_STATUS_CODE

Operation status code. Applicable to operations

OPERATION_SUB_STATUS_CODE

public static final CosmosMetricTagName OPERATION_SUB_STATUS_CODE

Operation sub-status code. Applicable to operations

PARTITION_ID

public static final CosmosMetricTagName PARTITION_ID

The PartitionId (Guid) Applicable to requests

PARTITION_KEY_RANGE_ID

public static final CosmosMetricTagName PARTITION_KEY_RANGE_ID

A numeric identifier for a physical partition Applicable to operations and requests

REGION_NAME

public static final CosmosMetricTagName REGION_NAME

The region names of the regions handling the operation/request Applicable to requests and operations

REPLICA_ID

public static final CosmosMetricTagName REPLICA_ID

The ReplicaId (int identifier plus suffix "s" (secondary - read-only - replica) or "p" (primary- write - replica) Applicable to requests

REQUEST_OPERATION_TYPE

public static final CosmosMetricTagName REQUEST_OPERATION_TYPE

Request operation type Applicable to requests

REQUEST_STATUS_CODE

public static final CosmosMetricTagName REQUEST_STATUS_CODE

Request status code Applicable to requests

SERVICE_ADDRESS

public static final CosmosMetricTagName SERVICE_ADDRESS

The service endpoint (hostname + port, partitionId, replicaId) Applicable to requests

SERVICE_ENDPOINT

public static final CosmosMetricTagName SERVICE_ENDPOINT

The service endpoint (hostname + port) Applicable to requests, direct channel, direct endpoint and direct requests

Method Details

equals

public boolean equals(Object obj)

Overrides:

CosmosMetricTagName.equals(Object obj)

Parameters:

obj

fromString

public static CosmosMetricTagName 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.

hashCode

public int hashCode()

Overrides:

CosmosMetricTagName.hashCode()

toString

public String toString()

Overrides:

CosmosMetricTagName.toString()