Struct ServiceLevelObjective

#[non_exhaustive]
pub struct ServiceLevelObjective {

    pub created_at: Option<i64>,
    pub creator: Option<Creator>,
    pub description: Option<Option<String>>,
    pub groups: Option<Vec<String>>,
    pub id: Option<String>,
    pub modified_at: Option<i64>,
    pub monitor_ids: Option<Vec<i64>>,
    pub monitor_tags: Option<Vec<String>>,
    pub name: String,
    pub query: Option<ServiceLevelObjectiveQuery>,
    pub sli_specification: Option<SLOSliSpec>,
    pub tags: Option<Vec<String>>,
    pub target_threshold: Option<f64>,
    pub thresholds: Vec<SLOThreshold>,
    pub timeframe: Option<SLOTimeframe>,
    pub type_: SLOType,
    pub warning_threshold: Option<f64>,
    pub additional_properties: BTreeMap<String, Value>,
    /* private fields */
}

A service level objective object includes a service level indicator, thresholds for one or more timeframes, and metadata (name, description, tags, etc.).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

created_at: Option<i64>

Creation timestamp (UNIX time in seconds)

Always included in service level objective responses.

creator: Option<Creator>

Object describing the creator of the shared element.

description: Option<Option<String>>

A user-defined description of the service level objective.

Always included in service level objective responses (but may be null). Optional in create/update requests.

groups: Option<Vec<String>>

A list of (up to 100) monitor groups that narrow the scope of a monitor service level objective.

Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the monitor_ids field is one.

id: Option<String>

A unique identifier for the service level objective object.

Always included in service level objective responses.

modified_at: Option<i64>

Modification timestamp (UNIX time in seconds)

Always included in service level objective responses.

monitor_ids: Option<Vec<i64>>

A list of monitor ids that defines the scope of a monitor service level objective. Required if type is monitor.

monitor_tags: Option<Vec<String>>

The union of monitor tags for all monitors referenced by the monitor_ids field. Always included in service level objective responses for monitor-based service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the monitor_ids field).

name: String

The name of the service level objective object.

query: Option<ServiceLevelObjectiveQuery>

A metric-based SLO. Required if type is metric. Note that Datadog only allows the sum by aggregator to be used because this will sum up all request counts instead of averaging them, or taking the max or min of all of those requests.

sli_specification: Option<SLOSliSpec>

A generic SLI specification. This is currently used for time-slice SLOs only.

tags: Option<Vec<String>>

A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests.

target_threshold: Option<f64>

The target threshold such that when the service level indicator is above this threshold over the given timeframe, the objective is being met.

thresholds: Vec<SLOThreshold>

The thresholds (timeframes and associated targets) for this service level objective object.

timeframe: Option<SLOTimeframe>

The SLO time window options. Note that “custom” is not a valid option for creating or updating SLOs. It is only used when querying SLO history over custom timeframes.

type_: SLOType

The type of the service level objective.

warning_threshold: Option<f64>

The optional warning threshold such that when the service level indicator is below this value for the given threshold, but above the target threshold, the objective appears in a “warning” state. This value must be greater than the target threshold.

additional_properties: BTreeMap<String, Value>

Implementations

impl ServiceLevelObjective

pub fn new( name: String, thresholds: Vec<SLOThreshold>, type_: SLOType, ) -> ServiceLevelObjective

Examples found in repository

examples/v1_service-level-objectives_UpdateSLO.rs (lines 15-19)

async fn main() {
    // there is a valid "slo" in the system
    let slo_data_0_id = std::env::var("SLO_DATA_0_ID").unwrap();
    let slo_data_0_name = std::env::var("SLO_DATA_0_NAME").unwrap();
    let body = ServiceLevelObjective::new(
        slo_data_0_name.clone(),
        vec![SLOThreshold::new(97.0, SLOTimeframe::SEVEN_DAYS).warning(98.0 as f64)],
        SLOType::METRIC,
    )
    .query(ServiceLevelObjectiveQuery::new(
        "sum:httpservice.hits{!code:3xx}.as_count()".to_string(),
        "sum:httpservice.hits{code:2xx}.as_count()".to_string(),
    ))
    .target_threshold(97.0 as f64)
    .timeframe(SLOTimeframe::SEVEN_DAYS)
    .warning_threshold(98.0 as f64);
    let configuration = datadog::Configuration::new();
    let api = ServiceLevelObjectivesAPI::with_config(configuration);
    let resp = api.update_slo(slo_data_0_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn created_at(self, value: i64) -> Self

pub fn creator(self, value: Creator) -> Self

pub fn description(self, value: Option<String>) -> Self

pub fn groups(self, value: Vec<String>) -> Self

pub fn id(self, value: String) -> Self

pub fn modified_at(self, value: i64) -> Self

pub fn monitor_ids(self, value: Vec<i64>) -> Self

pub fn monitor_tags(self, value: Vec<String>) -> Self

pub fn query(self, value: ServiceLevelObjectiveQuery) -> Self

Examples found in repository

examples/v1_service-level-objectives_UpdateSLO.rs (lines 20-23)

async fn main() {
    // there is a valid "slo" in the system
    let slo_data_0_id = std::env::var("SLO_DATA_0_ID").unwrap();
    let slo_data_0_name = std::env::var("SLO_DATA_0_NAME").unwrap();
    let body = ServiceLevelObjective::new(
        slo_data_0_name.clone(),
        vec![SLOThreshold::new(97.0, SLOTimeframe::SEVEN_DAYS).warning(98.0 as f64)],
        SLOType::METRIC,
    )
    .query(ServiceLevelObjectiveQuery::new(
        "sum:httpservice.hits{!code:3xx}.as_count()".to_string(),
        "sum:httpservice.hits{code:2xx}.as_count()".to_string(),
    ))
    .target_threshold(97.0 as f64)
    .timeframe(SLOTimeframe::SEVEN_DAYS)
    .warning_threshold(98.0 as f64);
    let configuration = datadog::Configuration::new();
    let api = ServiceLevelObjectivesAPI::with_config(configuration);
    let resp = api.update_slo(slo_data_0_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn sli_specification(self, value: SLOSliSpec) -> Self

pub fn tags(self, value: Vec<String>) -> Self

pub fn target_threshold(self, value: f64) -> Self

Examples found in repository

examples/v1_service-level-objectives_UpdateSLO.rs (line 24)

async fn main() {
    // there is a valid "slo" in the system
    let slo_data_0_id = std::env::var("SLO_DATA_0_ID").unwrap();
    let slo_data_0_name = std::env::var("SLO_DATA_0_NAME").unwrap();
    let body = ServiceLevelObjective::new(
        slo_data_0_name.clone(),
        vec![SLOThreshold::new(97.0, SLOTimeframe::SEVEN_DAYS).warning(98.0 as f64)],
        SLOType::METRIC,
    )
    .query(ServiceLevelObjectiveQuery::new(
        "sum:httpservice.hits{!code:3xx}.as_count()".to_string(),
        "sum:httpservice.hits{code:2xx}.as_count()".to_string(),
    ))
    .target_threshold(97.0 as f64)
    .timeframe(SLOTimeframe::SEVEN_DAYS)
    .warning_threshold(98.0 as f64);
    let configuration = datadog::Configuration::new();
    let api = ServiceLevelObjectivesAPI::with_config(configuration);
    let resp = api.update_slo(slo_data_0_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn timeframe(self, value: SLOTimeframe) -> Self

Examples found in repository

examples/v1_service-level-objectives_UpdateSLO.rs (line 25)

async fn main() {
    // there is a valid "slo" in the system
    let slo_data_0_id = std::env::var("SLO_DATA_0_ID").unwrap();
    let slo_data_0_name = std::env::var("SLO_DATA_0_NAME").unwrap();
    let body = ServiceLevelObjective::new(
        slo_data_0_name.clone(),
        vec![SLOThreshold::new(97.0, SLOTimeframe::SEVEN_DAYS).warning(98.0 as f64)],
        SLOType::METRIC,
    )
    .query(ServiceLevelObjectiveQuery::new(
        "sum:httpservice.hits{!code:3xx}.as_count()".to_string(),
        "sum:httpservice.hits{code:2xx}.as_count()".to_string(),
    ))
    .target_threshold(97.0 as f64)
    .timeframe(SLOTimeframe::SEVEN_DAYS)
    .warning_threshold(98.0 as f64);
    let configuration = datadog::Configuration::new();
    let api = ServiceLevelObjectivesAPI::with_config(configuration);
    let resp = api.update_slo(slo_data_0_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn warning_threshold(self, value: f64) -> Self

Examples found in repository

examples/v1_service-level-objectives_UpdateSLO.rs (line 26)

async fn main() {
    // there is a valid "slo" in the system
    let slo_data_0_id = std::env::var("SLO_DATA_0_ID").unwrap();
    let slo_data_0_name = std::env::var("SLO_DATA_0_NAME").unwrap();
    let body = ServiceLevelObjective::new(
        slo_data_0_name.clone(),
        vec![SLOThreshold::new(97.0, SLOTimeframe::SEVEN_DAYS).warning(98.0 as f64)],
        SLOType::METRIC,
    )
    .query(ServiceLevelObjectiveQuery::new(
        "sum:httpservice.hits{!code:3xx}.as_count()".to_string(),
        "sum:httpservice.hits{code:2xx}.as_count()".to_string(),
    ))
    .target_threshold(97.0 as f64)
    .timeframe(SLOTimeframe::SEVEN_DAYS)
    .warning_threshold(98.0 as f64);
    let configuration = datadog::Configuration::new();
    let api = ServiceLevelObjectivesAPI::with_config(configuration);
    let resp = api.update_slo(slo_data_0_id.clone(), body).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

pub fn additional_properties(self, value: BTreeMap<String, Value>) -> Self

Trait Implementations

impl Clone for ServiceLevelObjective

fn clone(&self) -> ServiceLevelObjective

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServiceLevelObjective

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServiceLevelObjective

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServiceLevelObjective

fn eq(&self, other: &ServiceLevelObjective) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ServiceLevelObjective

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServiceLevelObjective