common

Documentation

Index

• Constants
• func GenerateUUID() string
• func GrabEphemeralPort() (port uint16, err error)
• func LocalIP() (string, error)
• func Register(c *VcapComponent, mbusClient yagnats.NATSClient)
• func StartComponent(c *VcapComponent)
• type Duration
  • func (d Duration) MarshalJSON() ([]byte, error)
  • func (d *Duration) UnmarshalJSON(b []byte) error
• type GenericVarz
• type Healthz
  • func UpdateHealthz() *Healthz
  • func (v *Healthz) Value() string
• type Lockable
• type LogCounter
  • func NewLogCounter() *LogCounter
  • func (lc *LogCounter) AddRecord(record *steno.Record)
  • func (lc *LogCounter) Flush()
  • func (lc *LogCounter) GetCodec() steno.Codec
  • func (lc *LogCounter) GetCount(key string) int
  • func (lc *LogCounter) MarshalJSON() ([]byte, error)
  • func (lc *LogCounter) SetCodec(codec steno.Codec)
• type ProcessStatus
  • func NewProcessStatus() *ProcessStatus
  • func (p *ProcessStatus) StopUpdate()
  • func (p *ProcessStatus) Update()
• type RouterStart
• type Time
  • func (t Time) Elapsed() Duration
  • func (t Time) MarshalJSON() ([]byte, error)
  • func (t *Time) UnmarshalJSON(b []byte) error
• type Varz
  • func UpdateVarz() *Varz
  • func (v *Varz) MarshalJSON() ([]byte, error)
• type VcapComponent
  • func (c *VcapComponent) ListenAndServe()

Constants

const RefreshInterval time.Duration = time.Second * 1

Functions

func GenerateUUID

func GenerateUUID() string

func GrabEphemeralPort

func GrabEphemeralPort() (port uint16, err error)

func LocalIP

func LocalIP() (string, error)

func Register

func Register(c *VcapComponent, mbusClient yagnats.NATSClient)

func StartComponent

func StartComponent(c *VcapComponent)

Types

type Duration

type Duration time.Duration

func (Duration) MarshalJSON

func (d Duration) MarshalJSON() ([]byte, error)

func (*Duration) UnmarshalJSON

func (d *Duration) UnmarshalJSON(b []byte) error

type GenericVarz

type GenericVarz struct {
	// Static common metrics
	NumCores int `json:"num_cores"`

	// Dynamic common metrics
	MemStat int64   `json:"mem"`
	Cpu     float64 `json:"cpu"`

	Uptime    Duration    `json:"uptime"`
	LogCounts *LogCounter `json:"log_counts"`
}

type Healthz

type Healthz struct {
	LockableObject Lockable
}

func UpdateHealthz

func UpdateHealthz() *Healthz

func (*Healthz) Value

func (v *Healthz) Value() string

type Lockable

type Lockable interface {
	Lock()
	Unlock()
}

type LogCounter

type LogCounter struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewLogCounter

func NewLogCounter() *LogCounter

func (*LogCounter) AddRecord

func (lc *LogCounter) AddRecord(record *steno.Record)

func (*LogCounter) Flush

func (lc *LogCounter) Flush()

func (*LogCounter) GetCodec

func (lc *LogCounter) GetCodec() steno.Codec

func (*LogCounter) GetCount

func (lc *LogCounter) GetCount(key string) int

func (*LogCounter) MarshalJSON

func (lc *LogCounter) MarshalJSON() ([]byte, error)

func (*LogCounter) SetCodec

func (lc *LogCounter) SetCodec(codec steno.Codec)

type ProcessStatus

type ProcessStatus struct {
	sync.Mutex

	CpuUsage float64
	MemRss   int64
	// contains filtered or unexported fields
}

func NewProcessStatus

func NewProcessStatus() *ProcessStatus

func (*ProcessStatus) StopUpdate

func (p *ProcessStatus) StopUpdate()

func (*ProcessStatus) Update

func (p *ProcessStatus) Update()

type RouterStart

type RouterStart struct {
	Id                               string   `json:"id"`
	Hosts                            []string `json:"hosts"`
	MinimumRegisterIntervalInSeconds int      `json:"minimumRegisterIntervalInSeconds"`
}

type Time

type Time time.Time

func (Time) Elapsed

func (t Time) Elapsed() Duration

func (Time) MarshalJSON

func (t Time) MarshalJSON() ([]byte, error)

func (*Time) UnmarshalJSON

func (t *Time) UnmarshalJSON(b []byte) error

type Varz

type Varz struct {
	sync.Mutex
	GenericVarz
	UniqueVarz interface{} // Every component's unique metrics
}

func UpdateVarz

func UpdateVarz() *Varz

func (*Varz) MarshalJSON

func (v *Varz) MarshalJSON() ([]byte, error)

type VcapComponent

type VcapComponent struct {
	// These fields are from individual components
	Type        string                    `json:"type"`
	Index       uint                      `json:"index"`
	Host        string                    `json:"host"`
	Credentials []string                  `json:"credentials"`
	Config      interface{}               `json:"config"`
	Varz        *Varz                     `json:"-"`
	Healthz     *Healthz                  `json:"-"`
	InfoRoutes  map[string]json.Marshaler `json:"-"`
	Logger      *steno.Logger             `json:"-"`

	// These fields are automatically generated
	UUID   string   `json:"uuid"`
	Start  Time     `json:"start"`
	Uptime Duration `json:"uptime"`
}

var Component VcapComponent

func (*VcapComponent) ListenAndServe

func (c *VcapComponent) ListenAndServe()