230 строки
16 KiB
YAML
230 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.CosmosMetricCategory"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory"
|
|
name: "CosmosMetricCategory"
|
|
nameWithType: "CosmosMetricCategory"
|
|
summary: "Categories for Cosmos DB client-side metrics"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **CosmosMetricCategory**"
|
|
fields:
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.ALL"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.ALL"
|
|
name: "ALL"
|
|
nameWithType: "CosmosMetricCategory.ALL"
|
|
summary: "All metrics enabled"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory ALL"
|
|
desc: "All metrics enabled"
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.DEFAULT"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.DEFAULT"
|
|
name: "DEFAULT"
|
|
nameWithType: "CosmosMetricCategory.DEFAULT"
|
|
summary: "Default metrics (categories Operation<wbr>Summary, Request<wbr>Summary, System, Direct<wbr>Channels and Direct<wbr>Requests) enabled."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory DEFAULT"
|
|
desc: "Default metrics (categories OperationSummary, RequestSummary, System, DirectChannels and DirectRequests) enabled. These metrics provide good overview of end-to-end telemetry and help with triaging for most common issues"
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_ADDRESS_RESOLUTIONS"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_ADDRESS_RESOLUTIONS"
|
|
name: "DIRECT_ADDRESS_RESOLUTIONS"
|
|
nameWithType: "CosmosMetricCategory.DIRECT_ADDRESS_RESOLUTIONS"
|
|
summary: "The metrics in the Address<wbr>Resolutions category emit metrics for calls made to get replica addresses for a certain physical partition when using direct mode."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory DIRECT_ADDRESS_RESOLUTIONS"
|
|
desc: "The metrics in the AddressResolutions category emit metrics for calls made to get replica addresses for a certain physical partition when using direct mode. A higher number of calls for a certain partition can indicate either network/connectivity issues or the fact that at least one of the replica in this partition has an issue."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_CHANNELS"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_CHANNELS"
|
|
name: "DIRECT_CHANNELS"
|
|
nameWithType: "CosmosMetricCategory.DIRECT_CHANNELS"
|
|
summary: "The metrics in the Direct<wbr>Channels category emit metrics allowing to monitor connection handling by service endpoint."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory DIRECT_CHANNELS"
|
|
desc: "The metrics in the DirectChannels category emit metrics allowing to monitor connection handling by service endpoint. These metrics can be used to identify how many connections to a certain endpoint have been established, closed or are currently active. This information can help triaging whether there are any connectivity/network issues for certain endpoints (high number of closed/re-opened connections)."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_ENDPOINTS"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_ENDPOINTS"
|
|
name: "DIRECT_ENDPOINTS"
|
|
nameWithType: "CosmosMetricCategory.DIRECT_ENDPOINTS"
|
|
summary: "The metrics in the Direct<wbr>Endpoints category emit metrics allowing to monitor state by service endpoint."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory DIRECT_ENDPOINTS"
|
|
desc: "The metrics in the DirectEndpoints category emit metrics allowing to monitor state by service endpoint. These metrics can be used to identify when a service endpoint was evicted (due to reaching idle time threshold etc.). In most cases it should be sufficient to monitor DirectChannels instead."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_REQUESTS"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.DIRECT_REQUESTS"
|
|
name: "DIRECT_REQUESTS"
|
|
nameWithType: "CosmosMetricCategory.DIRECT_REQUESTS"
|
|
summary: "The metrics in the Direct<wbr>Requests category emit metrics allowing to monitor requests by service endpoint (request rate, error rate, latency etc.)."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory DIRECT_REQUESTS"
|
|
desc: "The metrics in the DirectRequests category emit metrics allowing to monitor requests by service endpoint (request rate, error rate, latency etc.). These metrics can be used to triage whether high latency or error rate is caused by a certain endpoint."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.LEGACY"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.LEGACY"
|
|
name: "LEGACY"
|
|
nameWithType: "CosmosMetricCategory.LEGACY"
|
|
summary: "The metrics in the Legacy category emit metrics that should not be used anymore and exist only for backwards compatibility reasons."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory LEGACY"
|
|
desc: "The metrics in the Legacy category emit metrics that should not be used anymore and exist only for backwards compatibility reasons."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.MINIMUM"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.MINIMUM"
|
|
name: "MINIMUM"
|
|
nameWithType: "CosmosMetricCategory.MINIMUM"
|
|
summary: "Minimum set of metrics (categories Operation<wbr>Summary and System) enabled."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory MINIMUM"
|
|
desc: "Minimum set of metrics (categories OperationSummary and System) enabled. These metrics provide a basic overview of end-to-end telemetry but won't be sufficient for triaging most issues"
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.OPERATION_DETAILS"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.OPERATION_DETAILS"
|
|
name: "OPERATION_DETAILS"
|
|
nameWithType: "CosmosMetricCategory.OPERATION_DETAILS"
|
|
summary: "The metrics in the Operation<wbr>Details category emit additional end-to-end metrics (like item count) for SDK operations."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory OPERATION_DETAILS"
|
|
desc: "The metrics in the OperationDetails category emit additional end-to-end metrics (like item count) for SDK operations."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.OPERATION_SUMMARY"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.OPERATION_SUMMARY"
|
|
name: "OPERATION_SUMMARY"
|
|
nameWithType: "CosmosMetricCategory.OPERATION_SUMMARY"
|
|
summary: "The metrics in the Operation<wbr>Summary category emit most important end-to-end metrics (like latency, request rate, request charge, request- and response-payload size etc.) for SDK operations These metrics are intended to visualize health state and impact - but alone not sufficient for triaging issues."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory OPERATION_SUMMARY"
|
|
desc: "The metrics in the OperationSummary category emit most important end-to-end metrics (like latency, request rate, request charge, request- and response-payload size etc.) for SDK operations These metrics are intended to visualize health state and impact - but alone not sufficient for triaging issues."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.REQUEST_DETAILS"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.REQUEST_DETAILS"
|
|
name: "REQUEST_DETAILS"
|
|
nameWithType: "CosmosMetricCategory.REQUEST_DETAILS"
|
|
summary: "The metrics in the Request<wbr>Details category emit additional end-to-end metrics (like timeline metrics showing where in the request pipeline latency was spent etc.) for physical network requests - they have tags allowing to distinguish by service endpoint in the backend as well as the client-machine."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory REQUEST_DETAILS"
|
|
desc: "The metrics in the RequestDetails category emit additional end-to-end metrics (like timeline metrics showing where in the request pipeline latency was spent etc.) for physical network requests - they have tags allowing to distinguish by service endpoint in the backend as well as the client-machine. So, these metrics can be very useful to triage whether impact (high latency, error rate) is skewed around certain client-machines and/or backend service endpoints."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.REQUEST_SUMMARY"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.REQUEST_SUMMARY"
|
|
name: "REQUEST_SUMMARY"
|
|
nameWithType: "CosmosMetricCategory.REQUEST_SUMMARY"
|
|
summary: "The metrics in the Request<wbr>Summary category emit most important end-to-end metrics (like latency, request rate, request charge, request- and response-payload size etc.) for physical network requests - they have tags allowing to distinguish by service endpoint in the backend as well as the client-machine."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory REQUEST_SUMMARY"
|
|
desc: "The metrics in the RequestSummary category emit most important end-to-end metrics (like latency, request rate, request charge, request- and response-payload size etc.) for physical network requests - they have tags allowing to distinguish by service endpoint in the backend as well as the client-machine. So, these metrics can be very useful to triage whether impact (high latency, error rate) is skewed around certain client-machines and/or backend service endpoints."
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.SYSTEM"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.SYSTEM"
|
|
name: "SYSTEM"
|
|
nameWithType: "CosmosMetricCategory.SYSTEM"
|
|
summary: "The metrics in the system category emit metrics that reflect system-wide CPU and memory usage based on the same snapshots taken and logged in request diagnostics"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final CosmosMetricCategory SYSTEM"
|
|
desc: "The metrics in the system category emit metrics that reflect system-wide CPU and memory usage based on the same snapshots taken and logged in request diagnostics"
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.equals(java.lang.Object)"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.equals(Object obj)"
|
|
name: "equals(Object obj)"
|
|
nameWithType: "CosmosMetricCategory.equals(Object obj)"
|
|
overridden: "java.lang.Object.equals(java.lang.Object)"
|
|
parameters:
|
|
- name: "obj"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
syntax: "public boolean equals(Object obj)"
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.fromString(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.fromString(String name)"
|
|
name: "fromString(String name)"
|
|
nameWithType: "CosmosMetricCategory.fromString(String name)"
|
|
summary: "Gets the corresponding metric category state from its string representation."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The name of the Cosmos metric category to convert."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static CosmosMetricCategory fromString(String name)"
|
|
desc: "Gets the corresponding metric category state from its string representation."
|
|
returns:
|
|
description: "The corresponding Cosmos metric category."
|
|
type: "<xref href=\"com.azure.cosmos.models.CosmosMetricCategory?alt=com.azure.cosmos.models.CosmosMetricCategory&text=CosmosMetricCategory\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.hashCode()"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.hashCode()"
|
|
name: "hashCode()"
|
|
nameWithType: "CosmosMetricCategory.hashCode()"
|
|
overridden: "java.lang.Object.hashCode()"
|
|
syntax: "public int hashCode()"
|
|
returns:
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.CosmosMetricCategory.toString()"
|
|
fullName: "com.azure.cosmos.models.CosmosMetricCategory.toString()"
|
|
name: "toString()"
|
|
nameWithType: "CosmosMetricCategory.toString()"
|
|
overridden: "java.lang.Object.toString()"
|
|
syntax: "public String toString()"
|
|
returns:
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "Categories for Cosmos DB client-side metrics"
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|