metrics

README

metrics

Usage

type CPUResult

type CPUResult struct {
	Info  []cpu.InfoStat  `json:"info"`
	Load  load.AvgStat    `json:"load"`
	Times []cpu.TimesStat `json:"times"`
}

CPUResult is the result of the CPU handler.

type DiskResult

type DiskResult struct {
	IO         map[string]disk.IOCountersStat `json:"io"`
	Partitions []disk.PartitionStat           `json:"partitions"`
	Usage      []*disk.UsageStat              `json:"usage"`
}

DiskResult is the result for the Disk handler.

type MemoryResult

type MemoryResult struct {
	Swap    *mem.SwapMemoryStat    `json:"swap"`
	Virtual *mem.VirtualMemoryStat `json:"virtual"`
}

MemoryResult is the result for the Memory handler.

type Metrics

type Metrics struct{}

Metrics is a provider of system info and metrics functionality.

func (*Metrics) CPU

func (m *Metrics) CPU(req *acomm.Request) (interface{}, *url.URL, error)

CPU returns information about the CPU hardware, times, and load.

func (*Metrics) Disk

func (m *Metrics) Disk(req *acomm.Request) (interface{}, *url.URL, error)

Disk returns information about the disk partitions, io, and usage.

func (*Metrics) Hardware

func (m *Metrics) Hardware(req *acomm.Request) (interface{}, *url.URL, error)

Hardware returns information about the hardware.

func (*Metrics) Host

func (m *Metrics) Host(req *acomm.Request) (interface{}, *url.URL, error)

Host returns information about the host machine.

func (*Metrics) Memory

func (m *Metrics) Memory(req *acomm.Request) (interface{}, *url.URL, error)

Memory returns information about the virtual and swap memory.

func (*Metrics) Network

func (m *Metrics) Network(req *acomm.Request) (interface{}, *url.URL, error)

Network returns information about the net interfaces and io.

func (*Metrics) RegisterTasks

func (m *Metrics) RegisterTasks(server *provider.Server)

RegisterTasks registers all of Metric's task handlers with the server.

type MockMetrics

type MockMetrics struct {
	Data *MockMetricsData
}

MockMetrics is a mock Metrics provider.

func NewMockMetrics

func NewMockMetrics() *MockMetrics

NewMockMetrics creates a new MockMetrics and populates default data.

func (*MockMetrics) CPU

func (m *MockMetrics) CPU(req *acomm.Request) (interface{}, *url.URL, error)

CPU returns mock CPU information.

func (*MockMetrics) Disk

func (m *MockMetrics) Disk(req *acomm.Request) (interface{}, *url.URL, error)

Disk returns mock disk information.

func (*MockMetrics) Hardware

func (m *MockMetrics) Hardware(req *acomm.Request) (interface{}, *url.URL, error)

Hardware returns mock hardware information.

func (*MockMetrics) Host

func (m *MockMetrics) Host(req *acomm.Request) (interface{}, *url.URL, error)

Host returns mock host information.

func (*MockMetrics) Memory

func (m *MockMetrics) Memory(req *acomm.Request) (interface{}, *url.URL, error)

Memory returns mock memory information.

func (*MockMetrics) Network

func (m *MockMetrics) Network(req *acomm.Request) (interface{}, *url.URL, error)

Network returns mock network information.

func (*MockMetrics) RegisterTasks

func (m *MockMetrics) RegisterTasks(server *provider.Server)

RegisterTasks registes all MockMetric task handlers.

type MockMetricsData

type MockMetricsData struct {
	CPU      *CPUResult
	Disk     *DiskResult
	Hardware interface{}
	Host     *host.InfoStat
	Memory   *MemoryResult
	Network  *NetworkResult
}

MockMetricsData is the in-memory data structure for the MockMetrics.

type NetworkResult

type NetworkResult struct {
	IO         []net.IOCountersStat `json:"io"`
	Interfaces []net.InterfaceStat  `json:"interfaces"`
}

NetworkResult is the result for the Network handler.

-- Generated with godocdown

Documentation

Index

• type CPUResult
• type DiskResult
• type MemoryResult
• type Metrics
  • func (m *Metrics) CPU(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *Metrics) Disk(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *Metrics) Hardware(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *Metrics) Host(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *Metrics) Memory(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *Metrics) Network(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *Metrics) RegisterTasks(server *provider.Server)
• type MockMetrics
  • func NewMockMetrics() *MockMetrics
  • func (m *MockMetrics) CPU(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *MockMetrics) Disk(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *MockMetrics) Hardware(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *MockMetrics) Host(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *MockMetrics) Memory(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *MockMetrics) Network(req *acomm.Request) (interface{}, *url.URL, error)
  • func (m *MockMetrics) RegisterTasks(server *provider.Server)
• type MockMetricsData
• type NetworkResult

Types

type CPUResult

type CPUResult struct {
	Info  []cpu.InfoStat  `json:"info"`
	Load  load.AvgStat    `json:"load"`
	Times []cpu.TimesStat `json:"times"`
}

CPUResult is the result of the CPU handler.

type DiskResult

type DiskResult struct {
	IO         map[string]disk.IOCountersStat `json:"io"`
	Partitions []disk.PartitionStat           `json:"partitions"`
	Usage      []*disk.UsageStat              `json:"usage"`
}

DiskResult is the result for the Disk handler.

type MemoryResult

type MemoryResult struct {
	Swap    *mem.SwapMemoryStat    `json:"swap"`
	Virtual *mem.VirtualMemoryStat `json:"virtual"`
}

MemoryResult is the result for the Memory handler.

type Metrics

type Metrics struct{}

Metrics is a provider of system info and metrics functionality.

func (*Metrics) CPU

func (m *Metrics) CPU(req *acomm.Request) (interface{}, *url.URL, error)

CPU returns information about the CPU hardware, times, and load.

func (*Metrics) Disk

func (m *Metrics) Disk(req *acomm.Request) (interface{}, *url.URL, error)

Disk returns information about the disk partitions, io, and usage.

func (*Metrics) Hardware

func (m *Metrics) Hardware(req *acomm.Request) (interface{}, *url.URL, error)

Hardware returns information about the hardware.

func (*Metrics) Host

func (m *Metrics) Host(req *acomm.Request) (interface{}, *url.URL, error)

Host returns information about the host machine.

func (*Metrics) Memory

func (m *Metrics) Memory(req *acomm.Request) (interface{}, *url.URL, error)

Memory returns information about the virtual and swap memory.

func (*Metrics) Network

func (m *Metrics) Network(req *acomm.Request) (interface{}, *url.URL, error)

Network returns information about the net interfaces and io.

func (*Metrics) RegisterTasks

func (m *Metrics) RegisterTasks(server *provider.Server)

RegisterTasks registers all of Metric's task handlers with the server.

type MockMetrics

type MockMetrics struct {
	Data *MockMetricsData
}

MockMetrics is a mock Metrics provider.

func NewMockMetrics

func NewMockMetrics() *MockMetrics

NewMockMetrics creates a new MockMetrics and populates default data.

func (*MockMetrics) CPU

func (m *MockMetrics) CPU(req *acomm.Request) (interface{}, *url.URL, error)

CPU returns mock CPU information.

func (*MockMetrics) Disk

func (m *MockMetrics) Disk(req *acomm.Request) (interface{}, *url.URL, error)

Disk returns mock disk information.

func (*MockMetrics) Hardware

func (m *MockMetrics) Hardware(req *acomm.Request) (interface{}, *url.URL, error)

Hardware returns mock hardware information.

func (*MockMetrics) Host

func (m *MockMetrics) Host(req *acomm.Request) (interface{}, *url.URL, error)

Host returns mock host information.

func (*MockMetrics) Memory

func (m *MockMetrics) Memory(req *acomm.Request) (interface{}, *url.URL, error)

Memory returns mock memory information.

func (*MockMetrics) Network

func (m *MockMetrics) Network(req *acomm.Request) (interface{}, *url.URL, error)

Network returns mock network information.

func (*MockMetrics) RegisterTasks

func (m *MockMetrics) RegisterTasks(server *provider.Server)

RegisterTasks registes all MockMetric task handlers.

type MockMetricsData

type MockMetricsData struct {
	CPU      *CPUResult
	Disk     *DiskResult
	Hardware interface{}
	Host     *host.InfoStat
	Memory   *MemoryResult
	Network  *NetworkResult
}

MockMetricsData is the in-memory data structure for the MockMetrics.

type NetworkResult

type NetworkResult struct {
	IO         []net.IOCountersStat `json:"io"`
	Interfaces []net.InterfaceStat  `json:"interfaces"`
}

NetworkResult is the result for the Network handler.