Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ServiceLevelIndicator.
A Service-Level Indicator (SLI) describes the "performance" of a service. For
some services, the SLI is well-defined. In such cases, the SLI can be
described easily by referencing the well-known SLI and providing the needed
parameters. Alternatively, a "custom" SLI can be defined with a query to the
underlying metric store. An SLI is defined to be good_service /
total_service over any queried time interval. The value of performance
always falls into the range 0 <= performance <= 1. A custom SLI describes
how to compute this ratio, whether this is by dividing values from a pair of
time series, cutting a Distribution into good and bad counts, or counting
time windows in which the service complies with a criterion. For separation
of concerns, a single Service-Level Indicator measures performance for only
one aspect of service quality, such as fraction of successful queries or
fast-enough queries.
Generated from protobuf message google.monitoring.v3.ServiceLevelIndicator
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ basic_sli |
Google\Cloud\Monitoring\V3\BasicSli
Basic SLI on a well-known service type. |
↳ request_based |
Google\Cloud\Monitoring\V3\RequestBasedSli
Request-based SLIs |
↳ windows_based |
Google\Cloud\Monitoring\V3\WindowsBasedSli
Windows-based SLIs |
getBasicSli
Basic SLI on a well-known service type.
Generated from protobuf field .google.monitoring.v3.BasicSli basic_sli = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\BasicSli|null | |
hasBasicSli
setBasicSli
Basic SLI on a well-known service type.
Generated from protobuf field .google.monitoring.v3.BasicSli basic_sli = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\BasicSli
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestBased
Request-based SLIs
Generated from protobuf field .google.monitoring.v3.RequestBasedSli request_based = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\RequestBasedSli|null | |
hasRequestBased
setRequestBased
Request-based SLIs
Generated from protobuf field .google.monitoring.v3.RequestBasedSli request_based = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\RequestBasedSli
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWindowsBased
Windows-based SLIs
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli windows_based = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\WindowsBasedSli|null | |
hasWindowsBased
setWindowsBased
Windows-based SLIs
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli windows_based = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Monitoring\V3\WindowsBasedSli
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
| Returns | |
|---|---|
| Type | Description |
string | |