Class: DatadogAPIClient::V1::SLOHistoryMonitor

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v1/models/slo_history_monitor.rb

Overview

An object that holds an SLI value and its associated data. It can represent an SLO’s overall SLI value. This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



68
69
70
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 68

def additional_properties
  @additional_properties
end

#error_budget_remaining ⇒ Object

A mapping of threshold ‘timeframe` to the remaining error budget.



26
27
28
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 26

def error_budget_remaining
  @error_budget_remaining
end

#errors ⇒ Object

An array of error objects returned while querying the history data for the service level objective.



29
30
31
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 29

def errors
  @errors
end

#group ⇒ Object

For groups in a grouped SLO, this is the group name.



32
33
34
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 32

def group
  @group
end

#history ⇒ Object

The state transition history for the monitor. It is represented as an array of pairs. Each pair is an array containing the timestamp of the transition as an integer in Unix epoch format in the first element, and the state as an integer in the second element. An integer value of ‘0` for state means uptime, `1` means downtime, and `2` means no data. Periods of no data are counted either as uptime or downtime depending on monitor settings. See [SLO documentation](docs.datadoghq.com/service_management/service_level_objectives/monitor/#missing-data) for detailed information.



41
42
43
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 41

def history
  @history
end

#monitor_modified ⇒ Object

For ‘monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.



44
45
46
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 44

def monitor_modified
  @monitor_modified
end

#monitor_type ⇒ Object

For ‘monitor` based SLOs, this describes the type of monitor.



47
48
49
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 47

def monitor_type
  @monitor_type
end

#name ⇒ Object

For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name.



50
51
52
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 50

def name
  @name
end

#precision ⇒ Object

The amount of decimal places the SLI value is accurate to for the given from ‘&&` to timestamp. Use `span_precision` instead.



53
54
55
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 53

def precision
  @precision
end

#preview ⇒ Object

For ‘monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation.



57
58
59
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 57

def preview
  @preview
end

#sli_value ⇒ Object

The current SLI value of the SLO over the history window.



60
61
62
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 60

def sli_value
  @sli_value
end

#span_precision ⇒ Object

The amount of decimal places the SLI value is accurate to for the given from ‘&&` to timestamp.



63
64
65
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 63

def span_precision
  @span_precision
end

#uptime ⇒ Object

Use ‘sli_value` instead.



66
67
68
 
# File 'lib/datadog_api_client/v1/models/slo_history_monitor.rb', line 66

def uptime
  @uptime
end