Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Honeycombio Provider
  3. API Docs
  4. Slo
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

honeycombio.Slo

Explore with Pulumi AI

honeycombio logo
honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
honeycombio/terraform-provider-honeycombio

    # Resource: honeycombio.Slo

    Creates a service level objective (SLO). For more information about SLOs, check out Set Service Level Objectives (SLOs).

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fs from "fs";
import * as honeycombio from "@pulumi/honeycombio";

const requestLatencySli = new honeycombio.DerivedColumn("requestLatencySli", {
    alias: "sli.request_latency",
    description: "SLI: request latency less than 300ms",
    dataset: _var.dataset,
    expression: fs.readFileSync("../sli/sli.request_latency.honeycomb", "utf8"),
});
const slo = new honeycombio.Slo("slo", {
    description: "example of an SLO",
    dataset: _var.dataset,
    sli: requestLatencySli.alias,
    targetPercentage: 99.9,
    timePeriod: 30,
});

    import pulumi
import pulumi_honeycombio as honeycombio

request_latency_sli = honeycombio.DerivedColumn("requestLatencySli",
    alias="sli.request_latency",
    description="SLI: request latency less than 300ms",
    dataset=var["dataset"],
    expression=(lambda path: open(path).read())("../sli/sli.request_latency.honeycomb"))
slo = honeycombio.Slo("slo",
    description="example of an SLO",
    dataset=var["dataset"],
    sli=request_latency_sli.alias,
    target_percentage=99.9,
    time_period=30)

    package main

import (
	"os"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/honeycombio/honeycombio"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := os.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		requestLatencySli, err := honeycombio.NewDerivedColumn(ctx, "requestLatencySli", &honeycombio.DerivedColumnArgs{
			Alias:       pulumi.String("sli.request_latency"),
			Description: pulumi.String("SLI: request latency less than 300ms"),
			Dataset:     pulumi.Any(_var.Dataset),
			Expression:  pulumi.String(readFileOrPanic("../sli/sli.request_latency.honeycomb")),
		})
		if err != nil {
			return err
		}
		_, err = honeycombio.NewSlo(ctx, "slo", &honeycombio.SloArgs{
			Description:      pulumi.String("example of an SLO"),
			Dataset:          pulumi.Any(_var.Dataset),
			Sli:              requestLatencySli.Alias,
			TargetPercentage: pulumi.Float64(99.9),
			TimePeriod:       pulumi.Float64(30),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.IO;
using System.Linq;
using Pulumi;
using Honeycombio = Pulumi.Honeycombio;

return await Deployment.RunAsync(() => 
{
    var requestLatencySli = new Honeycombio.DerivedColumn("requestLatencySli", new()
    {
        Alias = "sli.request_latency",
        Description = "SLI: request latency less than 300ms",
        Dataset = @var.Dataset,
        Expression = File.ReadAllText("../sli/sli.request_latency.honeycomb"),
    });

    var slo = new Honeycombio.Slo("slo", new()
    {
        Description = "example of an SLO",
        Dataset = @var.Dataset,
        Sli = requestLatencySli.Alias,
        TargetPercentage = 99.9,
        TimePeriod = 30,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.honeycombio.DerivedColumn;
import com.pulumi.honeycombio.DerivedColumnArgs;
import com.pulumi.honeycombio.Slo;
import com.pulumi.honeycombio.SloArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var requestLatencySli = new DerivedColumn("requestLatencySli", DerivedColumnArgs.builder()
            .alias("sli.request_latency")
            .description("SLI: request latency less than 300ms")
            .dataset(var_.dataset())
            .expression(Files.readString(Paths.get("../sli/sli.request_latency.honeycomb")))
            .build());

        var slo = new Slo("slo", SloArgs.builder()
            .description("example of an SLO")
            .dataset(var_.dataset())
            .sli(requestLatencySli.alias())
            .targetPercentage(99.9)
            .timePeriod(30)
            .build());

    }
}

    resources:
  requestLatencySli:
    type: honeycombio:DerivedColumn
    properties:
      alias: sli.request_latency
      description: 'SLI: request latency less than 300ms'
      dataset: ${var.dataset}
      # heredoc also works
      expression:
        fn::readFile: ../sli/sli.request_latency.honeycomb
  slo:
    type: honeycombio:Slo
    properties:
      description: example of an SLO
      dataset: ${var.dataset}
      sli: ${requestLatencySli.alias}
      targetPercentage: 99.9
      timePeriod: 30

    Note As Derived Columns cannot be renamed or deleted while in use, it is recommended to use the create_before_destroy lifecycle argument on your SLI resources as shown in the example above. This way you will avoid running into conflicts if the Derived Column needs to be recreated.

    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,
        dataset: Optional[str] = None,
        sli: Optional[str] = None,
        target_percentage: Optional[float] = None,
        time_period: Optional[float] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        slo_id: Optional[str] = None)
    func NewSlo(ctx *Context, name string, args SloArgs, opts ...ResourceOption) (*Slo, error)
    public Slo(string name, SloArgs args, CustomResourceOptions? opts = null)
    public Slo(String name, SloArgs args)
public Slo(String name, SloArgs args, CustomResourceOptions options)

    type: honeycombio: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sloResource = new Honeycombio.Slo("sloResource", new()
{
    Dataset = "string",
    Sli = "string",
    TargetPercentage = 0,
    TimePeriod = 0,
    Description = "string",
    Name = "string",
    SloId = "string",
});

    example, err := honeycombio.NewSlo(ctx, "sloResource", &honeycombio.SloArgs{
Dataset: pulumi.String("string"),
Sli: pulumi.String("string"),
TargetPercentage: pulumi.Float64(0),
TimePeriod: pulumi.Float64(0),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
SloId: pulumi.String("string"),
})

    var sloResource = new Slo("sloResource", SloArgs.builder()
    .dataset("string")
    .sli("string")
    .targetPercentage(0)
    .timePeriod(0)
    .description("string")
    .name("string")
    .sloId("string")
    .build());

    slo_resource = honeycombio.Slo("sloResource",
    dataset="string",
    sli="string",
    target_percentage=0,
    time_period=0,
    description="string",
    name="string",
    slo_id="string")

    const sloResource = new honeycombio.Slo("sloResource", {
    dataset: "string",
    sli: "string",
    targetPercentage: 0,
    timePeriod: 0,
    description: "string",
    name: "string",
    sloId: "string",
});

    type: honeycombio:Slo
properties:
    dataset: string
    description: string
    name: string
    sli: string
    sloId: string
    targetPercentage: 0
    timePeriod: 0

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Slo resource accepts the following input properties:

    Dataset string
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    Sli string
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    TargetPercentage double
    The percentage of qualified events that you expect to succeed during the time_period.
    TimePeriod double
    The time period, in days, over which your SLO will be evaluated.
    Description string
    A description of the SLO's intent and context.
    Name string
    The name of the SLO.
    SloId string
    ID of the SLO.
    Dataset string
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    Sli string
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    TargetPercentage float64
    The percentage of qualified events that you expect to succeed during the time_period.
    TimePeriod float64
    The time period, in days, over which your SLO will be evaluated.
    Description string
    A description of the SLO's intent and context.
    Name string
    The name of the SLO.
    SloId string
    ID of the SLO.
    dataset String
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    sli String
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    targetPercentage Double
    The percentage of qualified events that you expect to succeed during the time_period.
    timePeriod Double
    The time period, in days, over which your SLO will be evaluated.
    description String
    A description of the SLO's intent and context.
    name String
    The name of the SLO.
    sloId String
    ID of the SLO.
    dataset string
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    sli string
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    targetPercentage number
    The percentage of qualified events that you expect to succeed during the time_period.
    timePeriod number
    The time period, in days, over which your SLO will be evaluated.
    description string
    A description of the SLO's intent and context.
    name string
    The name of the SLO.
    sloId string
    ID of the SLO.
    dataset str
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    sli str
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    target_percentage float
    The percentage of qualified events that you expect to succeed during the time_period.
    time_period float
    The time period, in days, over which your SLO will be evaluated.
    description str
    A description of the SLO's intent and context.
    name str
    The name of the SLO.
    slo_id str
    ID of the SLO.
    dataset String
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    sli String
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    targetPercentage Number
    The percentage of qualified events that you expect to succeed during the time_period.
    timePeriod Number
    The time period, in days, over which your SLO will be evaluated.
    description String
    A description of the SLO's intent and context.
    name String
    The name of the SLO.
    sloId String
    ID of the SLO.

    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,
        dataset: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        sli: Optional[str] = None,
        slo_id: Optional[str] = None,
        target_percentage: Optional[float] = None,
        time_period: Optional[float] = None) -> Slo
    func 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)
    resources:  _:    type: honeycombio:Slo    get:      id: ${id}
    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.
    The following state arguments are supported:
    Dataset string
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    Description string
    A description of the SLO's intent and context.
    Name string
    The name of the SLO.
    Sli string
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    SloId string
    ID of the SLO.
    TargetPercentage double
    The percentage of qualified events that you expect to succeed during the time_period.
    TimePeriod double
    The time period, in days, over which your SLO will be evaluated.
    Dataset string
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    Description string
    A description of the SLO's intent and context.
    Name string
    The name of the SLO.
    Sli string
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    SloId string
    ID of the SLO.
    TargetPercentage float64
    The percentage of qualified events that you expect to succeed during the time_period.
    TimePeriod float64
    The time period, in days, over which your SLO will be evaluated.
    dataset String
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    description String
    A description of the SLO's intent and context.
    name String
    The name of the SLO.
    sli String
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    sloId String
    ID of the SLO.
    targetPercentage Double
    The percentage of qualified events that you expect to succeed during the time_period.
    timePeriod Double
    The time period, in days, over which your SLO will be evaluated.
    dataset string
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    description string
    A description of the SLO's intent and context.
    name string
    The name of the SLO.
    sli string
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    sloId string
    ID of the SLO.
    targetPercentage number
    The percentage of qualified events that you expect to succeed during the time_period.
    timePeriod number
    The time period, in days, over which your SLO will be evaluated.
    dataset str
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    description str
    A description of the SLO's intent and context.
    name str
    The name of the SLO.
    sli str
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    slo_id str
    ID of the SLO.
    target_percentage float
    The percentage of qualified events that you expect to succeed during the time_period.
    time_period float
    The time period, in days, over which your SLO will be evaluated.
    dataset String
    The dataset this SLO is created in. Must be the same dataset as the SLI unless the SLI's dataset is "__all__".
    description String
    A description of the SLO's intent and context.
    name String
    The name of the SLO.
    sli String
    The alias of the Derived Column that will be used as the SLI to indicate event success. The derived column used as the SLI must be in the same dataset as the SLO. Additionally, the column evaluation should consistently return nil, true, or false, as these are the only valid values for an SLI.
    sloId String
    ID of the SLO.
    targetPercentage Number
    The percentage of qualified events that you expect to succeed during the time_period.
    timePeriod Number
    The time period, in days, over which your SLO will be evaluated.

    Import

    SLOs can be imported using a combination of the dataset name and their ID, e.g.

    $ pulumi import honeycombio:index/slo:Slo my_slo my-dataset/bj9BwOb1uKz

    You can find the ID in the URL bar when visiting the SLO from the UI.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    honeycombio honeycombio/terraform-provider-honeycombio
    License
    Notes
    This Pulumi package is based on the honeycombio Terraform Provider.
    honeycombio logo
    honeycombio 0.31.0 published on Friday, Mar 7, 2025 by honeycombio
    honeycombio/terraform-provider-honeycombio