/AWS1/CL_CWSSVCLEVELOBJIVEBU00¶
A structure containing an SLO budget report that you have requested.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_arn TYPE /AWS1/CWSSVCLEVELOBJECTIVEARN /AWS1/CWSSVCLEVELOBJECTIVEARN¶
The ARN of the SLO that this report is for.
iv_name TYPE /AWS1/CWSSVCLEVELOBJECTIVENAME /AWS1/CWSSVCLEVELOBJECTIVENAME¶
The name of the SLO that this report is for.
iv_budgetstatus TYPE /AWS1/CWSSVCLEVELOBJIVEBUDGE00 /AWS1/CWSSVCLEVELOBJIVEBUDGE00¶
The status of this SLO, as it relates to the error budget for the entire time interval.
OKmeans that the SLO had remaining budget above the warning threshold, as of the time that you specified inTimeStamp.
WARNINGmeans that the SLO's remaining budget was below the warning threshold, as of the time that you specified inTimeStamp.
BREACHEDmeans that the SLO's budget was exhausted, as of the time that you specified inTimeStamp.
INSUFFICIENT_DATAmeans that the specified start and end times were before the SLO was created, or that attainment data is missing.
Optional arguments:¶
iv_evaluationtype TYPE /AWS1/CWSEVALUATIONTYPE /AWS1/CWSEVALUATIONTYPE¶
Displays whether this budget report is for a period-based SLO or a request-based SLO.
iv_attainment TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.
If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.
If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.
iv_totalbudgetseconds TYPE /AWS1/CWSTOTALBUDGETSECONDS /AWS1/CWSTOTALBUDGETSECONDS¶
The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.
iv_budgetsecondsremaining TYPE /AWS1/CWSBUDGETSECSREMAINING /AWS1/CWSBUDGETSECSREMAINING¶
The budget amount remaining before the SLO status becomes
BREACHING, at the time specified in theTimestempparameter of the request. If this value is negative, then the SLO is already inBREACHINGstatus.This field is included only if the SLO is a period-based SLO.
iv_totalbudgetrequests TYPE /AWS1/CWSTOTALBUDGETREQUESTS /AWS1/CWSTOTALBUDGETREQUESTS¶
This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.
This number can go up and down between reports with different time stamps, based on both how many total requests occur.
iv_budgetrequestsremaining TYPE /AWS1/CWSBUDGETREQSREMAINING /AWS1/CWSBUDGETREQSREMAINING¶
This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.
This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.
io_sli TYPE REF TO /AWS1/CL_CWSSVCLEVELINDICATOR /AWS1/CL_CWSSVCLEVELINDICATOR¶
A structure that contains information about the performance metric that this SLO monitors.
io_requestbasedsli TYPE REF TO /AWS1/CL_CWSREQBASEDSVCLEVEL00 /AWS1/CL_CWSREQBASEDSVCLEVEL00¶
This structure contains information about the performance metric that a request-based SLO monitors.
io_goal TYPE REF TO /AWS1/CL_CWSGOAL /AWS1/CL_CWSGOAL¶
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
Queryable Attributes¶
Arn¶
The ARN of the SLO that this report is for.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
Name¶
The name of the SLO that this report is for.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
EvaluationType¶
Displays whether this budget report is for a period-based SLO or a request-based SLO.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVALUATIONTYPE() |
Getter for EVALUATIONTYPE, with configurable default |
ASK_EVALUATIONTYPE() |
Getter for EVALUATIONTYPE w/ exceptions if field has no valu |
HAS_EVALUATIONTYPE() |
Determine if EVALUATIONTYPE has a value |
BudgetStatus¶
The status of this SLO, as it relates to the error budget for the entire time interval.
OKmeans that the SLO had remaining budget above the warning threshold, as of the time that you specified inTimeStamp.
WARNINGmeans that the SLO's remaining budget was below the warning threshold, as of the time that you specified inTimeStamp.
BREACHEDmeans that the SLO's budget was exhausted, as of the time that you specified inTimeStamp.
INSUFFICIENT_DATAmeans that the specified start and end times were before the SLO was created, or that attainment data is missing.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUDGETSTATUS() |
Getter for BUDGETSTATUS, with configurable default |
ASK_BUDGETSTATUS() |
Getter for BUDGETSTATUS w/ exceptions if field has no value |
HAS_BUDGETSTATUS() |
Determine if BUDGETSTATUS has a value |
Attainment¶
A number between 0 and 100 that represents the success percentage of your application compared to the goal set by the SLO.
If this is a period-based SLO, the number is the percentage of time periods that the service has attained the SLO's attainment goal, as of the time of the request.
If this is a request-based SLO, the number is the number of successful requests divided by the number of total requests, multiplied by 100, during the time range that you specified in your request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTAINMENT() |
Getter for ATTAINMENT, with configurable default |
ASK_ATTAINMENT() |
Getter for ATTAINMENT w/ exceptions if field has no value |
STR_ATTAINMENT() |
String format for ATTAINMENT, with configurable default |
HAS_ATTAINMENT() |
Determine if ATTAINMENT has a value |
TotalBudgetSeconds¶
The total number of seconds in the error budget for the interval. This field is included only if the SLO is a period-based SLO.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOTALBUDGETSECONDS() |
Getter for TOTALBUDGETSECONDS, with configurable default |
ASK_TOTALBUDGETSECONDS() |
Getter for TOTALBUDGETSECONDS w/ exceptions if field has no |
HAS_TOTALBUDGETSECONDS() |
Determine if TOTALBUDGETSECONDS has a value |
BudgetSecondsRemaining¶
The budget amount remaining before the SLO status becomes
BREACHING, at the time specified in theTimestempparameter of the request. If this value is negative, then the SLO is already inBREACHINGstatus.This field is included only if the SLO is a period-based SLO.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUDGETSECONDSREMAINING() |
Getter for BUDGETSECONDSREMAINING, with configurable default |
ASK_BUDGETSECONDSREMAINING() |
Getter for BUDGETSECONDSREMAINING w/ exceptions if field has |
HAS_BUDGETSECONDSREMAINING() |
Determine if BUDGETSECONDSREMAINING has a value |
TotalBudgetRequests¶
This field is displayed only for request-based SLOs. It displays the total number of failed requests that can be tolerated during the time range between the start of the interval and the time stamp supplied in the budget report request. It is based on the total number of requests that occurred, and the percentage specified in the attainment goal. If the number of failed requests matches this number or is higher, then this SLO is currently breaching.
This number can go up and down between reports with different time stamps, based on both how many total requests occur.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TOTALBUDGETREQUESTS() |
Getter for TOTALBUDGETREQUESTS, with configurable default |
ASK_TOTALBUDGETREQUESTS() |
Getter for TOTALBUDGETREQUESTS w/ exceptions if field has no |
HAS_TOTALBUDGETREQUESTS() |
Determine if TOTALBUDGETREQUESTS has a value |
BudgetRequestsRemaining¶
This field is displayed only for request-based SLOs. It displays the number of failed requests that can be tolerated before any more successful requests occur, and still have the application meet its SLO goal.
This number can go up and down between different reports, based on both how many successful requests and how many failed requests occur in that time.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUDGETREQUESTSREMAINING() |
Getter for BUDGETREQUESTSREMAINING, with configurable defaul |
ASK_BUDGETREQUESTSREMAINING() |
Getter for BUDGETREQUESTSREMAINING w/ exceptions if field ha |
HAS_BUDGETREQUESTSREMAINING() |
Determine if BUDGETREQUESTSREMAINING has a value |
Sli¶
A structure that contains information about the performance metric that this SLO monitors.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SLI() |
Getter for SLI |
RequestBasedSli¶
This structure contains information about the performance metric that a request-based SLO monitors.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REQUESTBASEDSLI() |
Getter for REQUESTBASEDSLI |
Goal¶
This structure contains the attributes that determine the goal of an SLO. This includes the time period for evaluation and the attainment threshold.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GOAL() |
Getter for GOAL |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SVCLEVELOBJIVEBUDGETREPORTS¶
TYPES TT_SVCLEVELOBJIVEBUDGETREPORTS TYPE STANDARD TABLE OF REF TO /AWS1/CL_CWSSVCLEVELOBJIVEBU00 WITH DEFAULT KEY
.