tmclient

Documentation

Index

• type TMClient
  • func New(url string, timeout time.Duration) *TMClient
  • func (c *TMClient) BandwidthCapacityKBPS() (float64, error)
  • func (c *TMClient) BandwidthKBPS() (float64, error)
  • func (c *TMClient) CRConfig() (tc.CRConfig, error)
  • func (c *TMClient) CRConfigBytes() ([]byte, error)
  • func (c *TMClient) CRConfigHistory() ([]towrap.CRConfigStat, error)
  • func (c *TMClient) CRStates(raw bool) (tc.CRStates, error)
  • func (c *TMClient) CacheAvailableCount() (int, error)
  • func (c *TMClient) CacheCount() (int, error)
  • func (c *TMClient) CacheDownCount() (int, error)
  • func (c *TMClient) CacheStats() (tc.LegacyStats, error)
  • func (c *TMClient) CacheStatsNew() (tc.Stats, error)
  • func (c *TMClient) CacheStatuses() (map[tc.CacheName]datareq.CacheStatus, error)
  • func (c *TMClient) ConfigDoc() (handler.OpsConfig, error)
  • func (c *TMClient) DSStats() (dsdata.Stats, error)
  • func (c *TMClient) EventLog() (datareq.JSONEvents, error)
  • func (c *TMClient) GetJSON(path string, obj interface{}) error
  • func (c *TMClient) MonitorConfig() (tc.TrafficMonitorConfigMap, error)
  • func (c *TMClient) PeerStates() (datareq.APIPeerStates, error)
  • func (c *TMClient) StatSummary() (datareq.StatSummary, error)
  • func (c *TMClient) Stats() (datareq.Stats, error)
  • func (c *TMClient) TrafficOpsURI() (string, error)
  • func (c *TMClient) Version() (string, error)

Types

type TMClient

type TMClient struct {
	Transport *http.Transport // optional http Transport
	// contains filtered or unexported fields
}

func New

func New(url string, timeout time.Duration) *TMClient

func (*TMClient) BandwidthCapacityKBPS

func (c *TMClient) BandwidthCapacityKBPS() (float64, error)

func (*TMClient) BandwidthKBPS

func (c *TMClient) BandwidthKBPS() (float64, error)

func (*TMClient) CRConfig

func (c *TMClient) CRConfig() (tc.CRConfig, error)

func (*TMClient) CRConfigBytes

func (c *TMClient) CRConfigBytes() ([]byte, error)

CRConfigBytes returns the raw bytes of the Monitor's CRConfig.

If you need a deserialized object, use TMClient.CRConfig() instead.

This function exists because the Monitor very intentionally serves the CRConfig bytes as published by Traffic Ops, without deserializing or reserializing it.

This can be useful to check for serialization or versioning issues, in case the Go object is missing values sent by Traffic Ops, or has other serialization issues.

func (*TMClient) CRConfigHistory

func (c *TMClient) CRConfigHistory() ([]towrap.CRConfigStat, error)

func (*TMClient) CRStates

func (c *TMClient) CRStates(raw bool) (tc.CRStates, error)

func (*TMClient) CacheAvailableCount

func (c *TMClient) CacheAvailableCount() (int, error)

func (*TMClient) CacheCount

func (c *TMClient) CacheCount() (int, error)

func (*TMClient) CacheDownCount

func (c *TMClient) CacheDownCount() (int, error)

func (*TMClient) CacheStats

func (c *TMClient) CacheStats() (tc.LegacyStats, error)

func (*TMClient) CacheStatsNew

func (c *TMClient) CacheStatsNew() (tc.Stats, error)

func (*TMClient) CacheStatuses

func (c *TMClient) CacheStatuses() (map[tc.CacheName]datareq.CacheStatus, error)

func (*TMClient) ConfigDoc

func (c *TMClient) ConfigDoc() (handler.OpsConfig, error)

func (*TMClient) DSStats

func (c *TMClient) DSStats() (dsdata.Stats, error)

func (*TMClient) EventLog

func (c *TMClient) EventLog() (datareq.JSONEvents, error)

func (*TMClient) GetJSON

func (c *TMClient) GetJSON(path string, obj interface{}) error

func (*TMClient) MonitorConfig

func (c *TMClient) MonitorConfig() (tc.TrafficMonitorConfigMap, error)

func (*TMClient) PeerStates

func (c *TMClient) PeerStates() (datareq.APIPeerStates, error)

func (*TMClient) StatSummary

func (c *TMClient) StatSummary() (datareq.StatSummary, error)

func (*TMClient) Stats

func (c *TMClient) Stats() (datareq.Stats, error)

func (*TMClient) TrafficOpsURI

func (c *TMClient) TrafficOpsURI() (string, error)

func (*TMClient) Version

func (c *TMClient) Version() (string, error)