Metrics Interface

Modifier and Type	Method and Description
MetricsResult	get(String appId, MetricId metricId) Retrieve metric data. Gets metric values for a single metric.
MetricsResult	get(String appId, MetricId metricId, String timespan, Period interval, List<MetricsAggregation> aggregation, List<MetricsSegment> segment, Integer top, String orderby, String filter) Retrieve metric data. Gets metric values for a single metric.
Observable<MetricsResult>	getAsync(String appId, MetricId metricId) Retrieve metric data. Gets metric values for a single metric.
ServiceFuture<MetricsResult>	getAsync(String appId, MetricId metricId, final ServiceCallback<MetricsResult> serviceCallback) Retrieve metric data. Gets metric values for a single metric.
Observable<MetricsResult>	getAsync(String appId, MetricId metricId, String timespan, Period interval, List<MetricsAggregation> aggregation, List<MetricsSegment> segment, Integer top, String orderby, String filter) Retrieve metric data. Gets metric values for a single metric.
ServiceFuture<MetricsResult>	getAsync(String appId, MetricId metricId, String timespan, Period interval, List<MetricsAggregation> aggregation, List<MetricsSegment> segment, Integer top, String orderby, String filter, final ServiceCallback<MetricsResult> serviceCallback) Retrieve metric data. Gets metric values for a single metric.
Object	getMetadata(String appId) Retrieve metric metatadata. Gets metadata describing the available metrics.
Observable<Object>	getMetadataAsync(String appId) Retrieve metric metatadata. Gets metadata describing the available metrics.
ServiceFuture<Object>	getMetadataAsync(String appId, final ServiceCallback<Object> serviceCallback) Retrieve metric metatadata. Gets metadata describing the available metrics.
Observable<ServiceResponse<Object>>	getMetadataWithServiceResponseAsync(String appId) Retrieve metric metatadata. Gets metadata describing the available metrics.
List<MetricsResultsItem>	getMultiple(String appId, List<MetricsPostBodySchema> body) Retrieve metric data. Gets metric values for multiple metrics.
Observable<List<MetricsResultsItem>>	getMultipleAsync(String appId, List<MetricsPostBodySchema> body) Retrieve metric data. Gets metric values for multiple metrics.
ServiceFuture<List<MetricsResultsItem>>	getMultipleAsync(String appId, List<MetricsPostBodySchema> body, final ServiceCallback<List<MetricsResultsItem>> serviceCallback) Retrieve metric data. Gets metric values for multiple metrics.
Observable<ServiceResponse<List<MetricsResultsItem>>>	getMultipleWithServiceResponseAsync(String appId, List<MetricsPostBodySchema> body) Retrieve metric data. Gets metric values for multiple metrics.
Observable<ServiceResponse<MetricsResult>>	getWithServiceResponseAsync(String appId, MetricId metricId) Retrieve metric data. Gets metric values for a single metric.
Observable<ServiceResponse<MetricsResult>>	getWithServiceResponseAsync(String appId, MetricId metricId, String timespan, Period interval, List<MetricsAggregation> aggregation, List<MetricsSegment> segment, Integer top, String orderby, String filter) Retrieve metric data. Gets metric values for a single metric.

get

public MetricsResult get(String appId, MetricId metricId)

Retrieve metric data. Gets metric values for a single metric.

Parameters:

appId - ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

metricId - ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

Returns:

the MetricsResult object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

get

public MetricsResult get(String appId, MetricId metricId, String timespan, Period interval, List aggregation, List segment, Integer top, String orderby, String filter)

Retrieve metric data. Gets metric values for a single metric.

Parameters:

appId - ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

metricId - ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

timespan - The timespan over which to retrieve metric values. This is an ISO8601 time period value. If timespan is omitted, a default time range of `PT12H` ("last 12 hours") is used. The actual timespan that is queried may be adjusted by the server based. In all cases, the actual time span used for the query is included in the response.

interval - The time interval to use when retrieving metric values. This is an ISO8601 duration. If interval is omitted, the metric value is aggregated across the entire timespan. If interval is supplied, the server may adjust the interval to a more appropriate size based on the timespan used for the query. In all cases, the actual interval used for the query is included in the response.

aggregation - The aggregation to use when computing the metric values. To retrieve more than one aggregation at a time, separate them with a comma. If no aggregation is specified, then the default aggregation for the metric is used.

segment - The name of the dimension to segment the metric values by. This dimension must be applicable to the metric you are retrieving. To segment by more than one dimension at a time, separate them with a comma (,). In this case, the metric data will be segmented in the order the dimensions are listed in the parameter.

top - The number of segments to return. This value is only valid when segment is specified.

orderby - The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.

filter - An expression used to filter the results. This value should be a valid OData filter expression where the keys of each clause should be applicable dimensions for the metric you are retrieving.

Returns:

the MetricsResult object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

ErrorResponseException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAsync

public Observable getAsync(String appId, MetricId metricId)

Retrieve metric data. Gets metric values for a single metric.

Parameters:

appId - ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

metricId - ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

Returns:

the observable to the MetricsResult object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String appId, MetricId metricId, final ServiceCallback serviceCallback)

Retrieve metric data. Gets metric values for a single metric.

Parameters:

appId - ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

metricId - ID of the metric. This is either a standard AI metric, or an application-specific custom metric. Possible values include: 'requests/count', 'requests/duration', 'requests/failed', 'users/count', 'users/authenticated', 'pageViews/count', 'pageViews/duration', 'client/processingDuration', 'client/receiveDuration', 'client/networkDuration', 'client/sendDuration', 'client/totalDuration', 'dependencies/count', 'dependencies/failed', 'dependencies/duration', 'exceptions/count', 'exceptions/browser', 'exceptions/server', 'sessions/count', 'performanceCounters/requestExecutionTime', 'performanceCounters/requestsPerSecond', 'performanceCounters/requestsInQueue', 'performanceCounters/memoryAvailableBytes', 'performanceCounters/exceptionsPerSecond', 'performanceCounters/processCpuPercentage', 'performanceCounters/processIOBytesPerSecond', 'performanceCounters/processPrivateBytes', 'performanceCounters/processorCpuPercentage', 'availabilityResults/availabilityPercentage', 'availabilityResults/duration', 'billing/telemetryCount', 'customEvents/count'

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String appId, MetricId metricId, String timespan, Period interval, List aggregation, List segment, Integer top, String orderby, String filter)