Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. getSlos
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.getSlos

Explore with Pulumi AI

grafana logo
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    Using getSlos

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSlos(opts?: InvokeOptions): Promise<GetSlosResult>
function getSlosOutput(opts?: InvokeOptions): Output<GetSlosResult>
    def get_slos(opts: Optional[InvokeOptions] = None) -> GetSlosResult
def get_slos_output(opts: Optional[InvokeOptions] = None) -> Output[GetSlosResult]
    func GetSlos(ctx *Context, opts ...InvokeOption) (*GetSlosResult, error)
func GetSlosOutput(ctx *Context, opts ...InvokeOption) GetSlosResultOutput

    > Note: This function is named GetSlos in the Go SDK.

    public static class GetSlos 
{
    public static Task<GetSlosResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetSlosResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSlosResult> getSlos(InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: grafana:index/getSlos:getSlos
  arguments:
    # arguments dictionary

    getSlos Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Slos List<Pulumiverse.Grafana.Outputs.GetSlosSlo>
    Id string
    The provider-assigned unique ID for this managed resource.
    Slos []GetSlosSlo
    id String
    The provider-assigned unique ID for this managed resource.
    slos List<GetSlosSlo>
    id string
    The provider-assigned unique ID for this managed resource.
    slos GetSlosSlo[]
    id str
    The provider-assigned unique ID for this managed resource.
    slos Sequence[GetSlosSlo]
    id String
    The provider-assigned unique ID for this managed resource.
    slos List<Property Map>

    Supporting Types

    GetSlosSlo

    Alertings List<Pulumiverse.Grafana.Inputs.GetSlosSloAlerting>
    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.
    DestinationDatasources List<Pulumiverse.Grafana.Inputs.GetSlosSloDestinationDatasource>
    Destination Datasource sets the datasource defined for an SLO
    Labels List<Pulumiverse.Grafana.Inputs.GetSlosSloLabel>
    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.GetSlosSloObjective>
    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.GetSlosSloQuery>
    Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
    Uuid string
    A unique, random identifier. This value will also be the name of the resource stored in the API server. This value is read-only.
    Alertings []GetSlosSloAlerting
    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.
    DestinationDatasources []GetSlosSloDestinationDatasource
    Destination Datasource sets the datasource defined for an SLO
    Labels []GetSlosSloLabel
    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 []GetSlosSloObjective
    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 []GetSlosSloQuery
    Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
    Uuid string
    A unique, random identifier. This value will also be the name of the resource stored in the API server. This value is read-only.
    alertings List<GetSlosSloAlerting>
    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.
    destinationDatasources List<GetSlosSloDestinationDatasource>
    Destination Datasource sets the datasource defined for an SLO
    labels List<GetSlosSloLabel>
    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<GetSlosSloObjective>
    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<GetSlosSloQuery>
    Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
    uuid String
    A unique, random identifier. This value will also be the name of the resource stored in the API server. This value is read-only.
    alertings GetSlosSloAlerting[]
    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.
    destinationDatasources GetSlosSloDestinationDatasource[]
    Destination Datasource sets the datasource defined for an SLO
    labels GetSlosSloLabel[]
    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 GetSlosSloObjective[]
    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 GetSlosSloQuery[]
    Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
    uuid string
    A unique, random identifier. This value will also be the name of the resource stored in the API server. This value is read-only.
    alertings Sequence[GetSlosSloAlerting]
    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_datasources Sequence[GetSlosSloDestinationDatasource]
    Destination Datasource sets the datasource defined for an SLO
    labels Sequence[GetSlosSloLabel]
    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[GetSlosSloObjective]
    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[GetSlosSloQuery]
    Query describes the indicator that will be measured against the objective. Freeform Query types are currently supported.
    uuid str
    A unique, random identifier. This value will also be the name of the resource stored in the API server. This value is read-only.
    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.
    destinationDatasources List<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.
    uuid String
    A unique, random identifier. This value will also be the name of the resource stored in the API server. This value is read-only.

    GetSlosSloAlerting

    Annotations List<Pulumiverse.Grafana.Inputs.GetSlosSloAlertingAnnotation>
    Annotations will be attached to all alerts generated by any of these rules.
    Fastburns List<Pulumiverse.Grafana.Inputs.GetSlosSloAlertingFastburn>
    Alerting Rules generated for Fast Burn alerts
    Labels List<Pulumiverse.Grafana.Inputs.GetSlosSloAlertingLabel>
    Labels will be attached to all alerts generated by any of these rules.
    Slowburns List<Pulumiverse.Grafana.Inputs.GetSlosSloAlertingSlowburn>
    Alerting Rules generated for Slow Burn alerts
    Annotations []GetSlosSloAlertingAnnotation
    Annotations will be attached to all alerts generated by any of these rules.
    Fastburns []GetSlosSloAlertingFastburn
    Alerting Rules generated for Fast Burn alerts
    Labels []GetSlosSloAlertingLabel
    Labels will be attached to all alerts generated by any of these rules.
    Slowburns []GetSlosSloAlertingSlowburn
    Alerting Rules generated for Slow Burn alerts
    annotations List<GetSlosSloAlertingAnnotation>
    Annotations will be attached to all alerts generated by any of these rules.
    fastburns List<GetSlosSloAlertingFastburn>
    Alerting Rules generated for Fast Burn alerts
    labels List<GetSlosSloAlertingLabel>
    Labels will be attached to all alerts generated by any of these rules.
    slowburns List<GetSlosSloAlertingSlowburn>
    Alerting Rules generated for Slow Burn alerts
    annotations GetSlosSloAlertingAnnotation[]
    Annotations will be attached to all alerts generated by any of these rules.
    fastburns GetSlosSloAlertingFastburn[]
    Alerting Rules generated for Fast Burn alerts
    labels GetSlosSloAlertingLabel[]
    Labels will be attached to all alerts generated by any of these rules.
    slowburns GetSlosSloAlertingSlowburn[]
    Alerting Rules generated for Slow Burn alerts
    annotations Sequence[GetSlosSloAlertingAnnotation]
    Annotations will be attached to all alerts generated by any of these rules.
    fastburns Sequence[GetSlosSloAlertingFastburn]
    Alerting Rules generated for Fast Burn alerts
    labels Sequence[GetSlosSloAlertingLabel]
    Labels will be attached to all alerts generated by any of these rules.
    slowburns Sequence[GetSlosSloAlertingSlowburn]
    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

    GetSlosSloAlertingAnnotation

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetSlosSloAlertingFastburn

    Annotations []GetSlosSloAlertingFastburnAnnotation
    Annotations to attach only to Fast Burn alerts.
    Labels []GetSlosSloAlertingFastburnLabel
    Labels to attach only to Fast Burn alerts.
    annotations List<GetSlosSloAlertingFastburnAnnotation>
    Annotations to attach only to Fast Burn alerts.
    labels List<GetSlosSloAlertingFastburnLabel>
    Labels to attach only to Fast Burn alerts.
    annotations GetSlosSloAlertingFastburnAnnotation[]
    Annotations to attach only to Fast Burn alerts.
    labels GetSlosSloAlertingFastburnLabel[]
    Labels to attach only to Fast Burn alerts.
    annotations Sequence[GetSlosSloAlertingFastburnAnnotation]
    Annotations to attach only to Fast Burn alerts.
    labels Sequence[GetSlosSloAlertingFastburnLabel]
    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.

    GetSlosSloAlertingFastburnAnnotation

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetSlosSloAlertingFastburnLabel

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetSlosSloAlertingLabel

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetSlosSloAlertingSlowburn

    Annotations []GetSlosSloAlertingSlowburnAnnotation
    Annotations to attach only to Slow Burn alerts.
    Labels []GetSlosSloAlertingSlowburnLabel
    Labels to attach only to Slow Burn alerts.
    annotations List<GetSlosSloAlertingSlowburnAnnotation>
    Annotations to attach only to Slow Burn alerts.
    labels List<GetSlosSloAlertingSlowburnLabel>
    Labels to attach only to Slow Burn alerts.
    annotations GetSlosSloAlertingSlowburnAnnotation[]
    Annotations to attach only to Slow Burn alerts.
    labels GetSlosSloAlertingSlowburnLabel[]
    Labels to attach only to Slow Burn alerts.
    annotations Sequence[GetSlosSloAlertingSlowburnAnnotation]
    Annotations to attach only to Slow Burn alerts.
    labels Sequence[GetSlosSloAlertingSlowburnLabel]
    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.

    GetSlosSloAlertingSlowburnAnnotation

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetSlosSloAlertingSlowburnLabel

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetSlosSloDestinationDatasource

    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

    GetSlosSloLabel

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetSlosSloObjective

    Value double
    Value between 0 and 1. If the value of the query is above the objective, the SLO is met.
    Window string
    A Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.
    Value float64
    Value between 0 and 1. If the value of the query is above the objective, the SLO is met.
    Window string
    A Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.
    value Double
    Value between 0 and 1. If the value of the query is above the objective, the SLO is met.
    window String
    A Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.
    value number
    Value between 0 and 1. If the value of the query is above the objective, the SLO is met.
    window string
    A Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.
    value float
    Value between 0 and 1. If the value of the query is above the objective, the SLO is met.
    window str
    A Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.
    value Number
    Value between 0 and 1. If the value of the query is above the objective, the SLO is met.
    window String
    A Prometheus-parsable time duration string like 24h, 60m. This is the time window the objective is measured over.

    GetSlosSloQuery

    Type string
    Query type must be one of: "freeform", "query", "ratio", or "threshold"
    Freeform Pulumiverse.Grafana.Inputs.GetSlosSloQueryFreeform
    Ratio Pulumiverse.Grafana.Inputs.GetSlosSloQueryRatio
    Type string
    Query type must be one of: "freeform", "query", "ratio", or "threshold"
    Freeform GetSlosSloQueryFreeform
    Ratio GetSlosSloQueryRatio
    type String
    Query type must be one of: "freeform", "query", "ratio", or "threshold"
    freeform GetSlosSloQueryFreeform
    ratio GetSlosSloQueryRatio
    type string
    Query type must be one of: "freeform", "query", "ratio", or "threshold"
    freeform GetSlosSloQueryFreeform
    ratio GetSlosSloQueryRatio
    type str
    Query type must be one of: "freeform", "query", "ratio", or "threshold"
    freeform GetSlosSloQueryFreeform
    ratio GetSlosSloQueryRatio
    type String
    Query type must be one of: "freeform", "query", "ratio", or "threshold"
    freeform Property Map
    ratio Property Map

    GetSlosSloQueryFreeform

    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

    GetSlosSloQueryRatio

    SuccessMetric string
    Counter metric for success events (numerator)
    TotalMetric string
    Metric for total events (denominator)
    GroupByLabels List<string>
    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_]*$"
    SuccessMetric string
    Counter metric for success events (numerator)
    TotalMetric string
    Metric for total events (denominator)
    GroupByLabels []string
    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_]*$"
    successMetric String
    Counter metric for success events (numerator)
    totalMetric String
    Metric for total events (denominator)
    groupByLabels List<String>
    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_]*$"
    successMetric string
    Counter metric for success events (numerator)
    totalMetric string
    Metric for total events (denominator)
    groupByLabels string[]
    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_labels Sequence[str]
    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_]*$"
    successMetric String
    Counter metric for success events (numerator)
    totalMetric String
    Metric for total events (denominator)
    groupByLabels List<String>
    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 grafana Terraform Provider.
    grafana logo
    Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
    pulumiverse/pulumi-grafana