tree

Documentation

Overview

Package tree is a generated protocol buffer package.

It is generated from these files:

tree_config.proto

It has these top-level messages:

SomCfg
Tree
TreeCfg

Index

• type SomCfg
  • func (*SomCfg) Descriptor() ([]byte, []int)
  • func (m *SomCfg) GetAlertStreams() []string
  • func (m *SomCfg) GetBugQueueLabel() string
  • func (*SomCfg) ProtoMessage()
  • func (m *SomCfg) Reset()
  • func (m *SomCfg) String() string
• type Tree
  • func (*Tree) Descriptor() ([]byte, []int)
  • func (m *Tree) GetDisplayName() string
  • func (m *Tree) GetName() string
  • func (m *Tree) GetSom() *SomCfg
  • func (m *Tree) GetStatusUrl() string
  • func (*Tree) ProtoMessage()
  • func (m *Tree) Reset()
  • func (m *Tree) String() string
• type TreeCfg
  • func (*TreeCfg) Descriptor() ([]byte, []int)
  • func (m *TreeCfg) GetTrees() []*Tree
  • func (*TreeCfg) ProtoMessage()
  • func (m *TreeCfg) Reset()
  • func (m *TreeCfg) String() string

Types

type SomCfg

type SomCfg struct {
	// BugQueueLabel is a Monorail label to use for a sheriffing bug queue
	// attached to this tree.
	BugQueueLabel string `protobuf:"bytes,1,opt,name=bug_queue_label,json=bugQueueLabel" json:"bug_queue_label,omitempty"`
	// AlertStreams are tree names that a sheriffing view for a tree should pull
	// from. The terminology here is a little weird since a "Sheriff-o-Matic
	// tree" can technically pull from more than one "Gatekeeper/Analyzer tree".
	AlertStreams []string `protobuf:"bytes,2,rep,name=alert_streams,json=alertStreams" json:"alert_streams,omitempty"`
}

SomCfg stores options related to the Sheriff-o-Matic frontend.

func (*SomCfg) Descriptor

func (*SomCfg) Descriptor() ([]byte, []int)

func (*SomCfg) GetAlertStreams

func (m *SomCfg) GetAlertStreams() []string

func (*SomCfg) GetBugQueueLabel

func (m *SomCfg) GetBugQueueLabel() string

func (*SomCfg) ProtoMessage

func (*SomCfg) ProtoMessage()

func (*SomCfg) Reset

func (m *SomCfg) Reset()

func (*SomCfg) String

func (m *SomCfg) String() string

type Tree

type Tree struct {
	// Name is a unique string key to mark a specific tree. Should be lowercase
	// and use only URL-safe characters.
	Name string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// DisplayName is a fancier name for the tree, which can include spaces,
	// capitalization, and any other string fanciness.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName" json:"display_name,omitempty"`
	// Som can be set to tell Sheriff-o-Matic to load the tree into its UI and
	// search for alerts.
	Som *SomCfg `protobuf:"bytes,3,opt,name=som" json:"som,omitempty"`
	// StatusUrl is a URL for the Tree-Status app attached to this tree. This
	// should eventually be replaced once we consolidate the Tree-Status app.
	StatusUrl string `protobuf:"bytes,4,opt,name=status_url,json=statusUrl" json:"status_url,omitempty"`
}

Tree stores the configuration for a single tree.

func (*Tree) Descriptor

func (*Tree) Descriptor() ([]byte, []int)

func (*Tree) GetDisplayName

func (m *Tree) GetDisplayName() string

func (*Tree) GetName

func (m *Tree) GetName() string

func (*Tree) GetSom

func (m *Tree) GetSom() *SomCfg

func (*Tree) GetStatusUrl

func (m *Tree) GetStatusUrl() string

func (*Tree) ProtoMessage

func (*Tree) ProtoMessage()

func (*Tree) Reset

func (m *Tree) Reset()

func (*Tree) String

func (m *Tree) String() string

type TreeCfg

type TreeCfg struct {
	// Trees stores all of the trees specified in a configuration file.
	Trees []*Tree `protobuf:"bytes,1,rep,name=trees" json:"trees,omitempty"`
}

TreeCfg is the project level configuration for services which require knowledge of what a tree is.

func (*TreeCfg) Descriptor

func (*TreeCfg) Descriptor() ([]byte, []int)

func (*TreeCfg) GetTrees

func (m *TreeCfg) GetTrees() []*Tree

func (*TreeCfg) ProtoMessage

func (*TreeCfg) ProtoMessage()

func (*TreeCfg) Reset

func (m *TreeCfg) Reset()

func (*TreeCfg) String

func (m *TreeCfg) String() string