GetDeploymentServiceStatsOverTime: Retrieves service health statistics over time on given...

In datarobot: 'DataRobot' Predictive Modeling API

Retrieves service health statistics over time on given metrics for a deployment.

Description

By default this will return statistics for the last seven days prior to the next; set the start and end parameters to adjust the reporting period.

Usage

GetDeploymentServiceStatsOverTime(
  deploymentId,
  metrics = DeploymentServiceHealthMetric$TotalPredictions,
  modelId = NULL,
  start = NULL,
  end = NULL,
  bucketSize = NULL,
  quantile = NULL,
  threshold = NULL,
  segmentAttribute = NULL,
  segmentValue = NULL
)

Arguments

deploymentId	character. The ID of the deployment.
metrics	character. Optional. Metrics to query. See DeploymentServiceHealthMetric for supported values. If not provided, defaults to TotalPredictions.
modelId	character. Optional. The ID of the model to query. If provided, only data for this specific model will be retrieved; otherwise, data for the deployment's default model will be retrieved.
start	POSIXct. Optional. The start time of the reporting period for monitoring data. Defaults to seven days prior to the end of the period. Sub-hour resolution is not permitted, and the timezone must be UTC.
end	POSIXct. Optional. The end time of the reporting period for monitoring data. Defaults to the next top of the hour. Sub-hour resolution is not permitted, and the timezone must be UTC.
bucketSize	character. Optional. The time duration of a bucket. This should be a multiple of one hour and cannot be longer than the total length of the period. If not set, a default value will be calculated based on the start and end times.
quantile	numeric. Optional. Quantile for the executionTime and responseTime metrics. Defaults to 0.5.
threshold	integer. Optional. Threshold for the slowQueries metric. Defaults to 1000.
segmentAttribute	character. Optional. The name of an attribute used for segment analysis. See SegmentAnalysisAttribute for permitted values. Added in DataRobot 2.20.
segmentValue	character. Optional. The value of segmentAttribute. Added in DataRobot 2.20.

Value

• modelId character. The ID of the deployment model for which monitoring data was retrieved.

• summary data.frame. Summarizes statistics for each metric over the entire reporting period.

• buckets data.frame. Statistics for each metric, split into intervals of equal duration. There is one column representing stats for each metric queried, as well as:

  • start POSIXct. Start of the interval.

  • end POSIXct. End of the interval.

• segmentAttribute character. Added in DataRobot 2.20. The name of the segment on which segment analysis was performed.

• segmentValue character. Added in DataRobot 2.20. The value of segmentAttribute.

Examples

## Not run: 
metrics <- c(DeploymentServiceHealthMetric)
GetDeploymentServiceStatsOverTime(deploymentId, metrics = metrics)

## End(Not run)

datarobot documentation built on May 29, 2024, 4:36 a.m.