builder

Documentation

Index

• Constants
• type Builder
  • func NewBuilder(opts Options) Builder
  • func (b *Builder) Build(services []*coreV1.Service, ingresses []*networkingV1.Ingress) (checks []*sm.Check, warnings []Warning)
• type CheckOptions
• type Options
  • func NewOptions() Options
  • func (opt *Options) NewCheckOptions(annotations map[string]string) (opts CheckOptions)
• type Warning

Constants

const (
	AnnotationsPrefix   = "synthetics.grafana.com/"
	EnabledAnnotation   = AnnotationsPrefix + "enabled"
	NameAnnotation      = AnnotationsPrefix + "name"
	FrequencyAnnotation = AnnotationsPrefix + "frequency"
	TimeoutAnnotation   = AnnotationsPrefix + "timeout"
	ProbesAnnotation    = AnnotationsPrefix + "probes"
	HostAnnotation      = AnnotationsPrefix + "host" // TODO
)

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder(opts Options) Builder

func (*Builder) Build

func (b *Builder) Build(services []*coreV1.Service, ingresses []*networkingV1.Ingress) (checks []*sm.Check, warnings []Warning)

type CheckOptions

type CheckOptions struct {
	// These translate directly to check fields:
	Enabled   bool
	JobName   string
	Frequency int64
	Timeout   int64
	Labels    []sm.Label
	Probes    []string

	// These are modifiers:
	Host   string
	Target string
}

type Options

type Options struct {
	// TODO: Config options for how the checks are built
	ClusterName string
	Labels      []sm.Label
	// contains filtered or unexported fields
}

func NewOptions

func NewOptions() Options

func (*Options) NewCheckOptions

func (opt *Options) NewCheckOptions(annotations map[string]string) (opts CheckOptions)

type Warning

type Warning struct {
	Cause error
	Objs  []schema.Object
}