client

Documentation

Index

• type AcadockClient
• type Client
  • func NewClient(endpoint string, opts ...ClientOpts) (*Client, error)
  • func (c *Client) AllContainersUsage() (ContainersUsage, error)
  • func (c *Client) CpuUsage(dockerId string) (*CpuUsage, error)
  • func (c *Client) HostUsage(opts HostUsageOpts) (HostUsage, error)
  • func (c *Client) Memory(dockerId string) (*MemoryUsage, error)
  • func (c *Client) NetUsage(dockerId string) (*NetUsage, error)
  • func (c *Client) Usage(dockerId string, net bool) (*Usage, error)
• type ClientOpts
  • func WithAuthentication(user, pass string) ClientOpts
• type ContainersUsage
  • func NewContainersUsage() ContainersUsage
• type CpuUsage
• type HostCpuUsage
• type HostMemoryUsage
• type HostUsage
• type HostUsageOpts
• type MemoryUsage
• type NetUsage
• type Usage

Types

type AcadockClient

type AcadockClient interface {
	AllContainersUsage() (ContainersUsage, error)
	Memory(dockerId string) (*MemoryUsage, error)
	CpuUsage(dockerId string) (*CpuUsage, error)
	NetUsage(dockerId string) (*NetUsage, error)
	Usage(dockerId string, net bool) (*Usage, error)
	HostUsage(opts HostUsageOpts) (HostUsage, error)
}

type Client

type Client struct {
	Endpoint string
	Username string
	Password string
}

func NewClient

func NewClient(endpoint string, opts ...ClientOpts) (*Client, error)

func (*Client) AllContainersUsage

func (c *Client) AllContainersUsage() (ContainersUsage, error)

func (*Client) CpuUsage

func (c *Client) CpuUsage(dockerId string) (*CpuUsage, error)

func (*Client) HostUsage

func (c *Client) HostUsage(opts HostUsageOpts) (HostUsage, error)

func (*Client) Memory

func (c *Client) Memory(dockerId string) (*MemoryUsage, error)

func (*Client) NetUsage

func (c *Client) NetUsage(dockerId string) (*NetUsage, error)

func (*Client) Usage

func (c *Client) Usage(dockerId string, net bool) (*Usage, error)

type ClientOpts

type ClientOpts func(*Client) *Client

func WithAuthentication

func WithAuthentication(user, pass string) ClientOpts

type ContainersUsage

type ContainersUsage map[string]Usage

func NewContainersUsage

func NewContainersUsage() ContainersUsage

type CpuUsage

type CpuUsage struct {
	UsageInPercents int `json:"usage_in_percents"`
}

type HostCpuUsage

type HostCpuUsage struct {
	Usage                            float64 `json:"usage"`
	Amount                           int     `json:"amount"`
	QueueLengthExponentiallySmoothed float64 `json:"queue_length_exponentially_smoothed"`
}

type HostMemoryUsage

type HostMemoryUsage struct {
	Free            uint64 `json:"free"`
	Total           uint64 `json:"total"`
	Swap            uint64 `json:"swap"`
	MemoryUsage     uint64 `json:"memory_usage"`
	MemoryCommitted uint64 `json:"memory_committed"`
	MaxMemoryUsage  uint64 `json:"max_memory_usage"`
	SwapUsage       uint64 `json:"swap_usage"`
	SwapCommitted   uint64 `json:"swap_committed"`
	MaxSwapUsage    uint64 `json:"max_swap_usage"`
}

type HostUsage

type HostUsage struct {
	CPU    HostCpuUsage    `json:"cpu"`
	Memory HostMemoryUsage `json:"memory"`
}

type HostUsageOpts

type HostUsageOpts struct {
	IncludeContainerIfLabel string
}

type MemoryUsage

type MemoryUsage struct {
	MemoryUsage    int64 `json:"memory_usage"`
	SwapUsage      int64 `json:"swap_usage"`
	MemoryLimit    int64 `json:"memory_limit"`
	SwapLimit      int64 `json:"swap_limit"`
	MaxMemoryUsage int64 `json:"max_memory_usage"`
	MaxSwapUsage   int64 `json:"max_swap_usage"`
}

type NetUsage

type NetUsage struct {
	netstat.NetworkStat
	RxBps int64 `json:"rx_bps"`
	TxBps int64 `json:"tx_bps"`
}

type Usage

type Usage struct {
	Memory *MemoryUsage      `json:"memory"`
	Cpu    *CpuUsage         `json:"cpu"`
	Net    *NetUsage         `json:"net,omitempty"`
	Labels map[string]string `json:"labels,omitempty"`
}