GetDeploymentServiceStats {datarobot}R Documentation

Retrieve service health statistics for a deployment.

Description

Retrieve service health statistics for a deployment.

Usage

GetDeploymentServiceStats(
  deploymentId,
  modelId = NULL,
  start = NULL,
  end = NULL,
  executionTimeQuantile = NULL,
  responseTimeQuantile = NULL,
  slowRequestsThreshold = NULL,
  segmentAttribute = NULL,
  segmentValue = NULL
)

Arguments

deploymentId

character. The ID of the deployment.

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.

executionTimeQuantile

numeric. Optional. Quantile for the executionTime metric. Defaults to 0.5.

responseTimeQuantile

numeric. Optional. Quantile for the responseTime metric. Defaults to 0.5.

slowRequestsThreshold

integer. Optional. Threshold for the slowRequests 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

An object representing service health metrics for the deployment, containing:

Examples

## Not run: 
  deploymentId <- "59a5af20c80891534e3c2bde"
  startTime = ISOdate(2020, 12, 25, 1, 0, 0, tz = "UTC")
  endTime = ISOdate(2021, 01, 06, 1, 0, 0, tz = "UTC")
  GetDeploymentServiceStats(deploymentId, startTime, endTime)

## End(Not run)
## Not run: 
  deploymentId <- "59a5af20c80891534e3c2bde"
  GetDeploymentServiceStats(deploymentId,
                            segmentAttribute = SegmentAnalysisAttribute$DataRobotRemoteIP,
                            segmentValue = "192.168.0.1")

## End(Not run)

[Package datarobot version 2.18.6 Index]