config

Documentation

Index

• Constants
• Variables
• type AggregateSettings
• type AlertsSettings
• type AnnotationSettings
• type BitBucket
• type CI
• type Check
  • func (c Check) Decode() (s CheckSettings, err error)
  • func (c Check) MarshalJSON() ([]byte, error)
• type CheckSettings
• type Checks
• type Config
  • func Load(path string, failOnMissing bool) (cfg Config, err error)
  • func (cfg *Config) DisableOnlineChecks()
  • func (cfg *Config) GetChecksForRule(ctx context.Context, path string, r parser.Rule, disabledChecks []string) []checks.RuleChecker
  • func (cfg *Config) SetDisabledChecks(l []string)
  • func (cfg Config) String() string
• type ContextCommandKey
• type ContextCommandVal
• type CostSettings
• type GitHub
• type Match
  • func (m Match) IsMatch(ctx context.Context, path string, r parser.Rule) bool
• type MatchAnnotation
• type MatchLabel
• type Parser
  • func (p Parser) CompileRelaxed() (r []*regexp.Regexp)
• type PrometheusConfig
• type RejectSettings
• type Repository
• type Rule
• type RuleLinkSettings

Constants

const (
	AlertingRuleType  = "alerting"
	RecordingRuleType = "recording"
	InvalidRuleType   = "invalid"
)

Variables

var (
	CommandKey   ContextCommandKey = "command"
	CICommand    ContextCommandVal = "ci"
	LintCommand  ContextCommandVal = "lint"
	WatchCommand ContextCommandVal = "watch"
)

Types

type AggregateSettings

type AggregateSettings struct {
	Name     string   `hcl:",label" json:"name"`
	Keep     []string `hcl:"keep,optional" json:"keep,omitempty"`
	Strip    []string `hcl:"strip,optional" json:"strip,omitempty"`
	Severity string   `hcl:"severity,optional" json:"severity,omitempty"`
}

type AlertsSettings

type AlertsSettings struct {
	Range   string `hcl:"range" json:"range"`
	Step    string `hcl:"step" json:"step"`
	Resolve string `hcl:"resolve" json:"resolve"`
}

type AnnotationSettings

type AnnotationSettings struct {
	Key      string `hcl:",label" json:"key"`
	Value    string `hcl:"value,optional" json:"value,omitempty"`
	Required bool   `hcl:"required,optional" json:"required,omitempty"`
	Severity string `hcl:"severity,optional" json:"severity,omitempty"`
}

type BitBucket

type BitBucket struct {
	URI        string `hcl:"uri"`
	Timeout    string `hcl:"timeout,optional"`
	Project    string `hcl:"project"`
	Repository string `hcl:"repository"`
}

type CI

type CI struct {
	Include    []string `hcl:"include,optional" json:"include,omitempty"`
	MaxCommits int      `hcl:"maxCommits,optional" json:"maxCommits,omitempty"`
	BaseBranch string   `hcl:"baseBranch,optional" json:"baseBranch,omitempty"`
}

type Check

type Check struct {
	Name string   `hcl:",label" json:"name"`
	Body hcl.Body `hcl:",remain" json:"-"`
}

func (Check) Decode

func (c Check) Decode() (s CheckSettings, err error)

func (Check) MarshalJSON

func (c Check) MarshalJSON() ([]byte, error)

type CheckSettings

type CheckSettings interface {
	Validate() error
}

type Checks

type Checks struct {
	Enabled  []string `hcl:"enabled,optional" json:"enabled,omitempty"`
	Disabled []string `hcl:"disabled,optional" json:"disabled,omitempty"`
}

type Config

type Config struct {
	CI                *CI                      `hcl:"ci,block" json:"ci,omitempty"`
	Parser            *Parser                  `hcl:"parser,block" json:"parser,omitempty"`
	Repository        *Repository              `hcl:"repository,block" json:"repository,omitempty"`
	Prometheus        []PrometheusConfig       `hcl:"prometheus,block" json:"prometheus,omitempty"`
	Checks            *Checks                  `hcl:"checks,block" json:"checks,omitempty"`
	Check             []Check                  `hcl:"check,block" json:"check,omitempty"`
	Rules             []Rule                   `hcl:"rule,block" json:"rules,omitempty"`
	PrometheusServers []*promapi.FailoverGroup `json:"-"`
}

func Load

func Load(path string, failOnMissing bool) (cfg Config, err error)

func (*Config) DisableOnlineChecks

func (cfg *Config) DisableOnlineChecks()

func (*Config) GetChecksForRule

func (cfg *Config) GetChecksForRule(ctx context.Context, path string, r parser.Rule, disabledChecks []string) []checks.RuleChecker

func (*Config) SetDisabledChecks

func (cfg *Config) SetDisabledChecks(l []string)

func (Config) String

func (cfg Config) String() string

type ContextCommandKey

type ContextCommandKey string

type ContextCommandVal

type ContextCommandVal string

type CostSettings

type CostSettings struct {
	MaxSeries int    `hcl:"maxSeries,optional" json:"maxSeries,omitempty"`
	Severity  string `hcl:"severity,optional" json:"severity,omitempty"`
}

type GitHub

type GitHub struct {
	BaseURI   string `hcl:"baseuri,optional"`
	UploadURI string `hcl:"uploaduri,optional"`
	Timeout   string `hcl:"timeout,optional"`
	Owner     string `hcl:"owner"`
	Repo      string `hcl:"repo"`
}

type Match

type Match struct {
	Path       string             `hcl:"path,optional" json:"path,omitempty"`
	Name       string             `hcl:"name,optional" json:"name,omitempty"`
	Kind       string             `hcl:"kind,optional" json:"kind,omitempty"`
	For        string             `hcl:"for,optional" json:"for,omitempty"`
	Label      *MatchLabel        `hcl:"label,block" json:"label,omitempty"`
	Annotation *MatchAnnotation   `hcl:"annotation,block" json:"annotation,omitempty"`
	Command    *ContextCommandVal `hcl:"command,optional" json:"command,omitempty"`
}

func (Match) IsMatch

func (m Match) IsMatch(ctx context.Context, path string, r parser.Rule) bool

type MatchAnnotation

type MatchAnnotation struct {
	Key   string `hcl:",label" json:"key"`
	Value string `hcl:"value" json:"value"`
}

type MatchLabel

type MatchLabel struct {
	Key   string `hcl:",label" json:"key"`
	Value string `hcl:"value" json:"value"`
}

type Parser

type Parser struct {
	Relaxed []string `hcl:"relaxed,optional" json:"relaxed,omitempty"`
}

func (Parser) CompileRelaxed

func (p Parser) CompileRelaxed() (r []*regexp.Regexp)

type PrometheusConfig

type PrometheusConfig struct {
	Name        string            `hcl:",label" json:"name"`
	URI         string            `hcl:"uri" json:"uri"`
	Headers     map[string]string `hcl:"headers,optional" json:"headers,omitempty"`
	Failover    []string          `hcl:"failover,optional" json:"failover,omitempty"`
	Timeout     string            `hcl:"timeout,optional"  json:"timeout"`
	Concurrency int               `hcl:"concurrency,optional" json:"concurrency"`
	RateLimit   int               `hcl:"rateLimit,optional" json:"rateLimit"`
	Uptime      string            `hcl:"uptime,optional" json:"uptime"`
	Include     []string          `hcl:"include,optional" json:"include,omitempty"`
	Exclude     []string          `hcl:"exclude,optional" json:"exclude,omitempty"`
	Required    bool              `hcl:"required,optional" json:"required"`
}

type RejectSettings

type RejectSettings struct {
	Regex            string `hcl:",label" json:"key,omitempty"`
	LabelKeys        bool   `hcl:"label_keys,optional" json:"label_keys,omitempty"`
	LabelValues      bool   `hcl:"label_values,optional" json:"label_values,omitempty"`
	AnnotationKeys   bool   `hcl:"annotation_keys,optional" json:"annotation_keys,omitempty"`
	AnnotationValues bool   `hcl:"annotation_values,optional" json:"annotation_values,omitempty"`
	Severity         string `hcl:"severity,optional" json:"severity,omitempty"`
}

type Repository

type Repository struct {
	BitBucket *BitBucket `hcl:"bitbucket,block" json:"bitbucket,omitempty"`
	GitHub    *GitHub    `hcl:"github,block" json:"github,omitempty"`
}

type Rule

type Rule struct {
	Match      []Match              `hcl:"match,block" json:"match,omitempty"`
	Ignore     []Match              `hcl:"ignore,block" json:"ignore,omitempty"`
	Aggregate  []AggregateSettings  `hcl:"aggregate,block" json:"aggregate,omitempty"`
	Annotation []AnnotationSettings `hcl:"annotation,block" json:"annotation,omitempty"`
	Label      []AnnotationSettings `hcl:"label,block" json:"label,omitempty"`
	Cost       *CostSettings        `hcl:"cost,block" json:"cost,omitempty"`
	Alerts     *AlertsSettings      `hcl:"alerts,block" json:"alerts,omitempty"`
	Reject     []RejectSettings     `hcl:"reject,block" json:"reject,omitempty"`
	RuleLink   []RuleLinkSettings   `hcl:"link,block" json:"link,omitempty"`
}

type RuleLinkSettings

type RuleLinkSettings struct {
	Regex    string            `hcl:",label" json:"key,omitempty"`
	URI      string            `hcl:"uri,optional" json:"uri,omitempty"`
	Timeout  string            `hcl:"timeout,optional" json:"timeout,omitempty"`
	Headers  map[string]string `hcl:"headers,optional" json:"headers,omitempty"`
	Severity string            `hcl:"severity,optional" json:"severity,omitempty"`
}