Docs
PackagesGrafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
grafana.SLO
Explore with Pulumi AI
Create SLO Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SLO(name: string, args: SLOArgs, opts?: CustomResourceOptions);@overload
def SLO(resource_name: str,
args: SLOArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SLO(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
objectives: Optional[Sequence[SLOObjectiveArgs]] = None,
queries: Optional[Sequence[SLOQueryArgs]] = None,
alertings: Optional[Sequence[SLOAlertingArgs]] = None,
destination_datasource: Optional[SLODestinationDatasourceArgs] = None,
labels: Optional[Sequence[SLOLabelArgs]] = None,
name: Optional[str] = None)func NewSLO(ctx *Context, name string, args SLOArgs, opts ...ResourceOption) (*SLO, error)public SLO(string name, SLOArgs args, CustomResourceOptions? opts = null)type: grafana:SLO
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SLOArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SLOArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SLOArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SLOArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SLOArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var sloResource = new Grafana.SLO("sloResource", new()
{
Description = "string",
Objectives = new[]
{
new Grafana.Inputs.SLOObjectiveArgs
{
Value = 0,
Window = "string",
},
},
Queries = new[]
{
new Grafana.Inputs.SLOQueryArgs
{
Type = "string",
Freeform = new Grafana.Inputs.SLOQueryFreeformArgs
{
Query = "string",
},
Ratio = new Grafana.Inputs.SLOQueryRatioArgs
{
SuccessMetric = "string",
TotalMetric = "string",
GroupByLabels = new[]
{
"string",
},
},
},
},
Alertings = new[]
{
new Grafana.Inputs.SLOAlertingArgs
{
Annotations = new[]
{
new Grafana.Inputs.SLOAlertingAnnotationArgs
{
Key = "string",
Value = "string",
},
},
Fastburns = new[]
{
new Grafana.Inputs.SLOAlertingFastburnArgs
{
Annotations = new[]
{
new Grafana.Inputs.SLOAlertingFastburnAnnotationArgs
{
Key = "string",
Value = "string",
},
},
Labels = new[]
{
new Grafana.Inputs.SLOAlertingFastburnLabelArgs
{
Key = "string",
Value = "string",
},
},
},
},
Labels = new[]
{
new Grafana.Inputs.SLOAlertingLabelArgs
{
Key = "string",
Value = "string",
},
},
Slowburns = new[]
{
new Grafana.Inputs.SLOAlertingSlowburnArgs
{
Annotations = new[]
{
new Grafana.Inputs.SLOAlertingSlowburnAnnotationArgs
{
Key = "string",
Value = "string",
},
},
Labels = new[]
{
new Grafana.Inputs.SLOAlertingSlowburnLabelArgs
{
Key = "string",
Value = "string",
},
},
},
},
},
},
DestinationDatasource = new Grafana.Inputs.SLODestinationDatasourceArgs
{
Uid = "string",
},
Labels = new[]
{
new Grafana.Inputs.SLOLabelArgs
{
Key = "string",
Value = "string",
},
},
Name = "string",
});
example, err := grafana.NewSLO(ctx, "sloResource", &grafana.SLOArgs{
Description: pulumi.String("string"),
Objectives: grafana.SLOObjectiveArray{
&grafana.SLOObjectiveArgs{
Value: pulumi.Float64(0),
Window: pulumi.String("string"),
},
},
Queries: grafana.SLOQueryArray{
&grafana.SLOQueryArgs{
Type: pulumi.String("string"),
Freeform: &grafana.SLOQueryFreeformArgs{
Query: pulumi.String("string"),
},
Ratio: &grafana.SLOQueryRatioArgs{
SuccessMetric: pulumi.String("string"),
TotalMetric: pulumi.String("string"),
GroupByLabels: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
Alertings: grafana.SLOAlertingArray{
&grafana.SLOAlertingArgs{
Annotations: grafana.SLOAlertingAnnotationArray{
&grafana.SLOAlertingAnnotationArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Fastburns: grafana.SLOAlertingFastburnArray{
&grafana.SLOAlertingFastburnArgs{
Annotations: grafana.SLOAlertingFastburnAnnotationArray{
&grafana.SLOAlertingFastburnAnnotationArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Labels: grafana.SLOAlertingFastburnLabelArray{
&grafana.SLOAlertingFastburnLabelArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
Labels: grafana.SLOAlertingLabelArray{
&grafana.SLOAlertingLabelArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Slowburns: grafana.SLOAlertingSlowburnArray{
&grafana.SLOAlertingSlowburnArgs{
Annotations: grafana.SLOAlertingSlowburnAnnotationArray{
&grafana.SLOAlertingSlowburnAnnotationArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Labels: grafana.SLOAlertingSlowburnLabelArray{
&grafana.SLOAlertingSlowburnLabelArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
},
},
DestinationDatasource: &grafana.SLODestinationDatasourceArgs{
Uid: pulumi.String("string"),
},
Labels: grafana.SLOLabelArray{
&grafana.SLOLabelArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
})
var sloResource = new SLO("sloResource", SLOArgs.builder()
.description("string")
.objectives(SLOObjectiveArgs.builder()
.value(0)
.window("string")
.build())
.queries(SLOQueryArgs.builder()
.type("string")
.freeform(SLOQueryFreeformArgs.builder()
.query("string")
.build())
.ratio(SLOQueryRatioArgs.builder()
.successMetric("string")
.totalMetric("string")
.groupByLabels("string")
.build())
.build())
.alertings(SLOAlertingArgs.builder()
.annotations(SLOAlertingAnnotationArgs.builder()
.key("string")
.value("string")
.build())
.fastburns(SLOAlertingFastburnArgs.builder()
.annotations(SLOAlertingFastburnAnnotationArgs.builder()
.key("string")
.value("string")
.build())
.labels(SLOAlertingFastburnLabelArgs.builder()
.key("string")
.value("string")
.build())
.build())
.labels(SLOAlertingLabelArgs.builder()
.key("string")
.value("string")
.build())
.slowburns(SLOAlertingSlowburnArgs.builder()
.annotations(SLOAlertingSlowburnAnnotationArgs.builder()
.key("string")
.value("string")
.build())
.labels(SLOAlertingSlowburnLabelArgs.builder()
.key("string")
.value("string")
.build())
.build())
.build())
.destinationDatasource(SLODestinationDatasourceArgs.builder()
.uid("string")
.build())
.labels(SLOLabelArgs.builder()
.key("string")
.value("string")
.build())
.name("string")
.build());
slo_resource = grafana.SLO("sloResource",
description="string",
objectives=[grafana.SLOObjectiveArgs(
value=0,
window="string",
)],
queries=[grafana.SLOQueryArgs(
type="string",
freeform=grafana.SLOQueryFreeformArgs(
query="string",
),
ratio=grafana.SLOQueryRatioArgs(
success_metric="string",
total_metric="string",
group_by_labels=["string"],
),
)],
alertings=[grafana.SLOAlertingArgs(
annotations=[grafana.SLOAlertingAnnotationArgs(
key="string",
value="string",
)],
fastburns=[grafana.SLOAlertingFastburnArgs(
annotations=[grafana.SLOAlertingFastburnAnnotationArgs(
key="string",
value="string",
)],
labels=[grafana.SLOAlertingFastburnLabelArgs(
key="string",
value="string",
)],
)],
labels=[grafana.SLOAlertingLabelArgs(
key="string",
value="string",
)],
slowburns=[grafana.SLOAlertingSlowburnArgs(
annotations=[grafana.SLOAlertingSlowburnAnnotationArgs(
key="string",
value="string",
)],
labels=[grafana.SLOAlertingSlowburnLabelArgs(
key="string",
value="string",
)],
)],
)],
destination_datasource=grafana.SLODestinationDatasourceArgs(
uid="string",
),
labels=[grafana.SLOLabelArgs(
key="string",
value="string",
)],
name="string")
const sloResource = new grafana.SLO("sloResource", {
description: "string",
objectives: [{
value: 0,
window: "string",
}],
queries: [{
type: "string",
freeform: {
query: "string",
},
ratio: {
successMetric: "string",
totalMetric: "string",
groupByLabels: ["string"],
},
}],
alertings: [{
annotations: [{
key: "string",
value: "string",
}],
fastburns: [{
annotations: [{
key: "string",
value: "string",
}],
labels: [{
key: "string",
value: "string",
}],
}],
labels: [{
key: "string",
value: "string",
}],
slowburns: [{
annotations: [{
key: "string",
value: "string",
}],
labels: [{
key: "string",
value: "string",
}],
}],
}],
destinationDatasource: {
uid: "string",
},
labels: [{
key: "string",
value: "string",
}],
name: "string",
});
type: grafana:SLO
properties:
alertings:
- annotations:
- key: string
value: string
fastburns:
- annotations:
- key: string
value: string
labels:
- key: string
value: string
labels:
- key: string
value: string
slowburns:
- annotations:
- key: string
value: string
labels:
- key: string
value: string
description: string
destinationDatasource:
uid: string
labels:
- key: string
value: string
name: string
objectives:
- value: 0
window: string
queries:
- freeform:
query: string
ratio:
groupByLabels:
- string
successMetric: string
totalMetric: string
type: string
SLO Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SLO resource accepts the following input properties:
- Description string
- Description is a free-text field that can provide more context to an SLO.
- Objectives
List<Pulumiverse.
Grafana. Inputs. SLOObjective> - Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- Queries
List<Pulumiverse.
Grafana. Inputs. SLOQuery> - Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- Alertings
List<Pulumiverse.
Grafana. Inputs. SLOAlerting> - Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- Destination
Datasource Pulumiverse.Grafana. Inputs. SLODestination Datasource - Destination Datasource sets the datasource defined for an SLO
- Labels
List<Pulumiverse.
Grafana. Inputs. SLOLabel> - Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- Name string
- Name should be a short description of your indicator. Consider names like "API Availability"
- Description string
- Description is a free-text field that can provide more context to an SLO.
- Objectives
[]SLOObjective
Args - Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- Queries
[]SLOQuery
Args - Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- Alertings
[]SLOAlerting
Args - Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- Destination
Datasource SLODestinationDatasource Args - Destination Datasource sets the datasource defined for an SLO
- Labels
[]SLOLabel
Args - Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- Name string
- Name should be a short description of your indicator. Consider names like "API Availability"
- description String
- Description is a free-text field that can provide more context to an SLO.
- objectives List<SLOObjective>
- Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries List<SLOQuery>
- Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings List<SLOAlerting>
- Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- destination
Datasource SLODestinationDatasource - Destination Datasource sets the datasource defined for an SLO
- labels List<SLOLabel>
- Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name String
- Name should be a short description of your indicator. Consider names like "API Availability"
- description string
- Description is a free-text field that can provide more context to an SLO.
- objectives SLOObjective[]
- Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries SLOQuery[]
- Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings SLOAlerting[]
- Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- destination
Datasource SLODestinationDatasource - Destination Datasource sets the datasource defined for an SLO
- labels SLOLabel[]
- Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name string
- Name should be a short description of your indicator. Consider names like "API Availability"
- description str
- Description is a free-text field that can provide more context to an SLO.
- objectives
Sequence[SLOObjective
Args] - Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries
Sequence[SLOQuery
Args] - Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings
Sequence[SLOAlerting
Args] - Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- destination_
datasource SLODestinationDatasource Args - Destination Datasource sets the datasource defined for an SLO
- labels
Sequence[SLOLabel
Args] - Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name str
- Name should be a short description of your indicator. Consider names like "API Availability"
- description String
- Description is a free-text field that can provide more context to an SLO.
- objectives List<Property Map>
- Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries List<Property Map>
- Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings List<Property Map>
- Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- destination
Datasource Property Map - Destination Datasource sets the datasource defined for an SLO
- labels List<Property Map>
- Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name String
- Name should be a short description of your indicator. Consider names like "API Availability"
Outputs
All input properties are implicitly available as output properties. Additionally, the SLO resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing SLO Resource
Get an existing SLO resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SLOState, opts?: CustomResourceOptions): SLO@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alertings: Optional[Sequence[SLOAlertingArgs]] = None,
description: Optional[str] = None,
destination_datasource: Optional[SLODestinationDatasourceArgs] = None,
labels: Optional[Sequence[SLOLabelArgs]] = None,
name: Optional[str] = None,
objectives: Optional[Sequence[SLOObjectiveArgs]] = None,
queries: Optional[Sequence[SLOQueryArgs]] = None) -> SLOfunc GetSLO(ctx *Context, name string, id IDInput, state *SLOState, opts ...ResourceOption) (*SLO, error)public static SLO Get(string name, Input<string> id, SLOState? state, CustomResourceOptions? opts = null)public static SLO get(String name, Output<String> id, SLOState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Alertings
List<Pulumiverse.
Grafana. Inputs. SLOAlerting> - Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- Description string
- Description is a free-text field that can provide more context to an SLO.
- Destination
Datasource Pulumiverse.Grafana. Inputs. SLODestination Datasource - Destination Datasource sets the datasource defined for an SLO
- Labels
List<Pulumiverse.
Grafana. Inputs. SLOLabel> - Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- Name string
- Name should be a short description of your indicator. Consider names like "API Availability"
- Objectives
List<Pulumiverse.
Grafana. Inputs. SLOObjective> - Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- Queries
List<Pulumiverse.
Grafana. Inputs. SLOQuery> - Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- Alertings
[]SLOAlerting
Args - Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- Description string
- Description is a free-text field that can provide more context to an SLO.
- Destination
Datasource SLODestinationDatasource Args - Destination Datasource sets the datasource defined for an SLO
- Labels
[]SLOLabel
Args - Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- Name string
- Name should be a short description of your indicator. Consider names like "API Availability"
- Objectives
[]SLOObjective
Args - Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- Queries
[]SLOQuery
Args - Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings List<SLOAlerting>
- Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- description String
- Description is a free-text field that can provide more context to an SLO.
- destination
Datasource SLODestinationDatasource - Destination Datasource sets the datasource defined for an SLO
- labels List<SLOLabel>
- Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name String
- Name should be a short description of your indicator. Consider names like "API Availability"
- objectives List<SLOObjective>
- Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries List<SLOQuery>
- Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings SLOAlerting[]
- Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- description string
- Description is a free-text field that can provide more context to an SLO.
- destination
Datasource SLODestinationDatasource - Destination Datasource sets the datasource defined for an SLO
- labels SLOLabel[]
- Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name string
- Name should be a short description of your indicator. Consider names like "API Availability"
- objectives SLOObjective[]
- Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries SLOQuery[]
- Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings
Sequence[SLOAlerting
Args] - Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- description str
- Description is a free-text field that can provide more context to an SLO.
- destination_
datasource SLODestinationDatasource Args - Destination Datasource sets the datasource defined for an SLO
- labels
Sequence[SLOLabel
Args] - Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name str
- Name should be a short description of your indicator. Consider names like "API Availability"
- objectives
Sequence[SLOObjective
Args] - Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries
Sequence[SLOQuery
Args] - Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
- alertings List<Property Map>
- Configures the alerting rules that will be generated for each time window associated with the SLO. Grafana SLOs can generate alerts when the short-term error budget burn is very high, the long-term error budget burn rate is high, or when the remaining error budget is below a certain threshold. Annotations and Labels support templating.
- description String
- Description is a free-text field that can provide more context to an SLO.
- destination
Datasource Property Map - Destination Datasource sets the datasource defined for an SLO
- labels List<Property Map>
- Additional labels that will be attached to all metrics generated from the query. These labels are useful for grouping SLOs in dashboard views that you create by hand. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- name String
- Name should be a short description of your indicator. Consider names like "API Availability"
- objectives List<Property Map>
- Over each rolling time window, the remaining error budget will be calculated, and separate alerts can be generated for each time window based on the SLO burn rate or remaining error budget.
- queries List<Property Map>
- Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
Supporting Types
SLOAlerting, SLOAlertingArgs
- Annotations
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Annotation> - Annotations will be attached to all alerts generated by any of these rules.
- Fastburns
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Fastburn> - Alerting Rules generated for Fast Burn alerts
- Labels
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Label> - Labels will be attached to all alerts generated by any of these rules.
- Slowburns
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Slowburn> - Alerting Rules generated for Slow Burn alerts
- Annotations
[]SLOAlerting
Annotation - Annotations will be attached to all alerts generated by any of these rules.
- Fastburns
[]SLOAlerting
Fastburn - Alerting Rules generated for Fast Burn alerts
- Labels
[]SLOAlerting
Label - Labels will be attached to all alerts generated by any of these rules.
- Slowburns
[]SLOAlerting
Slowburn - Alerting Rules generated for Slow Burn alerts
- annotations
List<SLOAlerting
Annotation> - Annotations will be attached to all alerts generated by any of these rules.
- fastburns
List<SLOAlerting
Fastburn> - Alerting Rules generated for Fast Burn alerts
- labels
List<SLOAlerting
Label> - Labels will be attached to all alerts generated by any of these rules.
- slowburns
List<SLOAlerting
Slowburn> - Alerting Rules generated for Slow Burn alerts
- annotations
SLOAlerting
Annotation[] - Annotations will be attached to all alerts generated by any of these rules.
- fastburns
SLOAlerting
Fastburn[] - Alerting Rules generated for Fast Burn alerts
- labels
SLOAlerting
Label[] - Labels will be attached to all alerts generated by any of these rules.
- slowburns
SLOAlerting
Slowburn[] - Alerting Rules generated for Slow Burn alerts
- annotations
Sequence[SLOAlerting
Annotation] - Annotations will be attached to all alerts generated by any of these rules.
- fastburns
Sequence[SLOAlerting
Fastburn] - Alerting Rules generated for Fast Burn alerts
- labels
Sequence[SLOAlerting
Label] - Labels will be attached to all alerts generated by any of these rules.
- slowburns
Sequence[SLOAlerting
Slowburn] - Alerting Rules generated for Slow Burn alerts
- annotations List<Property Map>
- Annotations will be attached to all alerts generated by any of these rules.
- fastburns List<Property Map>
- Alerting Rules generated for Fast Burn alerts
- labels List<Property Map>
- Labels will be attached to all alerts generated by any of these rules.
- slowburns List<Property Map>
- Alerting Rules generated for Slow Burn alerts
SLOAlertingAnnotation, SLOAlertingAnnotationArgs
SLOAlertingFastburn, SLOAlertingFastburnArgs
- Annotations
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Fastburn Annotation> - Annotations to attach only to Fast Burn alerts.
- Labels
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Fastburn Label> - Labels to attach only to Fast Burn alerts.
- Annotations
[]SLOAlerting
Fastburn Annotation - Annotations to attach only to Fast Burn alerts.
- Labels
[]SLOAlerting
Fastburn Label - Labels to attach only to Fast Burn alerts.
- annotations
List<SLOAlerting
Fastburn Annotation> - Annotations to attach only to Fast Burn alerts.
- labels
List<SLOAlerting
Fastburn Label> - Labels to attach only to Fast Burn alerts.
- annotations
SLOAlerting
Fastburn Annotation[] - Annotations to attach only to Fast Burn alerts.
- labels
SLOAlerting
Fastburn Label[] - Labels to attach only to Fast Burn alerts.
- annotations
Sequence[SLOAlerting
Fastburn Annotation] - Annotations to attach only to Fast Burn alerts.
- labels
Sequence[SLOAlerting
Fastburn Label] - Labels to attach only to Fast Burn alerts.
- annotations List<Property Map>
- Annotations to attach only to Fast Burn alerts.
- labels List<Property Map>
- Labels to attach only to Fast Burn alerts.
SLOAlertingFastburnAnnotation, SLOAlertingFastburnAnnotationArgs
SLOAlertingFastburnLabel, SLOAlertingFastburnLabelArgs
SLOAlertingLabel, SLOAlertingLabelArgs
SLOAlertingSlowburn, SLOAlertingSlowburnArgs
- Annotations
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Slowburn Annotation> - Annotations to attach only to Slow Burn alerts.
- Labels
List<Pulumiverse.
Grafana. Inputs. SLOAlerting Slowburn Label> - Labels to attach only to Slow Burn alerts.
- Annotations
[]SLOAlerting
Slowburn Annotation - Annotations to attach only to Slow Burn alerts.
- Labels
[]SLOAlerting
Slowburn Label - Labels to attach only to Slow Burn alerts.
- annotations
List<SLOAlerting
Slowburn Annotation> - Annotations to attach only to Slow Burn alerts.
- labels
List<SLOAlerting
Slowburn Label> - Labels to attach only to Slow Burn alerts.
- annotations
SLOAlerting
Slowburn Annotation[] - Annotations to attach only to Slow Burn alerts.
- labels
SLOAlerting
Slowburn Label[] - Labels to attach only to Slow Burn alerts.
- annotations
Sequence[SLOAlerting
Slowburn Annotation] - Annotations to attach only to Slow Burn alerts.
- labels
Sequence[SLOAlerting
Slowburn Label] - Labels to attach only to Slow Burn alerts.
- annotations List<Property Map>
- Annotations to attach only to Slow Burn alerts.
- labels List<Property Map>
- Labels to attach only to Slow Burn alerts.
SLOAlertingSlowburnAnnotation, SLOAlertingSlowburnAnnotationArgs
SLOAlertingSlowburnLabel, SLOAlertingSlowburnLabelArgs
SLODestinationDatasource, SLODestinationDatasourceArgs
- Uid string
- UID for the Mimir Datasource
- Uid string
- UID for the Mimir Datasource
- uid String
- UID for the Mimir Datasource
- uid string
- UID for the Mimir Datasource
- uid str
- UID for the Mimir Datasource
- uid String
- UID for the Mimir Datasource
SLOLabel, SLOLabelArgs
SLOObjective, SLOObjectiveArgs
SLOQuery, SLOQueryArgs
- Type string
- Query type must be one of: "freeform", "query", "ratio", or "threshold"
- Freeform
Pulumiverse.
Grafana. Inputs. SLOQuery Freeform - Ratio
Pulumiverse.
Grafana. Inputs. SLOQuery Ratio
- Type string
- Query type must be one of: "freeform", "query", "ratio", or "threshold"
- Freeform
SLOQuery
Freeform - Ratio
SLOQuery
Ratio
- type String
- Query type must be one of: "freeform", "query", "ratio", or "threshold"
- freeform
SLOQuery
Freeform - ratio
SLOQuery
Ratio
- type string
- Query type must be one of: "freeform", "query", "ratio", or "threshold"
- freeform
SLOQuery
Freeform - ratio
SLOQuery
Ratio
- type str
- Query type must be one of: "freeform", "query", "ratio", or "threshold"
- freeform
SLOQuery
Freeform - ratio
SLOQuery
Ratio
- type String
- Query type must be one of: "freeform", "query", "ratio", or "threshold"
- freeform Property Map
- ratio Property Map
SLOQueryFreeform, SLOQueryFreeformArgs
- Query string
- Freeform Query Field
- Query string
- Freeform Query Field
- query String
- Freeform Query Field
- query string
- Freeform Query Field
- query str
- Freeform Query Field
- query String
- Freeform Query Field
SLOQueryRatio, SLOQueryRatioArgs
- Success
Metric string - Counter metric for success events (numerator)
- Total
Metric string - Metric for total events (denominator)
- Group
By List<string>Labels - Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- Success
Metric string - Counter metric for success events (numerator)
- Total
Metric string - Metric for total events (denominator)
- Group
By []stringLabels - Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- success
Metric String - Counter metric for success events (numerator)
- total
Metric String - Metric for total events (denominator)
- group
By List<String>Labels - Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- success
Metric string - Counter metric for success events (numerator)
- total
Metric string - Metric for total events (denominator)
- group
By string[]Labels - Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- success_
metric str - Counter metric for success events (numerator)
- total_
metric str - Metric for total events (denominator)
- group_
by_ Sequence[str]labels - Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
- success
Metric String - Counter metric for success events (numerator)
- total
Metric String - Metric for total events (denominator)
- group
By List<String>Labels - Defines Group By Labels used for per-label alerting. These appear as variables on SLO dashboards to enable filtering and aggregation. Labels must adhere to Prometheus label name schema - "^[a-zA-Z_][a-zA-Z0-9_]*$"
Package Details
- Repository
- grafana pulumiverse/pulumi-grafana
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
grafanaTerraform Provider.