fettle v0.1.0 Fettle.Spec View Source

Describes health check meta-data; created from configuration and used to generate reports.

All the fields must have values, but some can be provided from the global config, see Fettle.Config.

FieldSummaryDefault
idUnique IDdefaults to value of name
nameUnique NameHuman readable name, required
descriptionDescription of what check doesdefaults to value of name
severitySeverity of failure, from 1, critical, to 3, informationalrequired
panic_guide_urlURL for Ops to go to when check failsrequired, but can default to config value
business_impactWhat business process will be impacted if check failsrequired, but can default to config value
technical_summaryWhat has gone wrong, technically, if check failsrequired, but can default to config value
initial_delay_msNumber of milliseconds to wait before running first checkdefaults from config
period_msNumber of milliseconds to wait between runs of the same checkdefaults from config
timeout_msNumber of milliseconds to wait before timing-out a running checkdefaults from config

Link to this section Summary

Link to this section Types

Link to this type severity() View Source
severity() :: 1 | 2 | 3
Link to this type t() View Source
t() :: %Fettle.Spec{business_impact: String.t, description: String.t, id: String.t, initial_delay_ms: non_neg_integer, name: String.t, panic_guide_url: String.t, period_ms: non_neg_integer, severity: severity, technical_summary: String.t, timeout_ms: non_neg_integer}