package client

import "github.com/google/cadvisor/client"

TODO(cAdvisor): Package comment.

Index ¶

• type Client
• func NewClient(url string) (*Client, error)
• func (self *Client) AllDockerContainers(query *info.ContainerInfoRequest) (cinfo []info.ContainerInfo, err error)
• func (self *Client) ContainerInfo(name string, query *info.ContainerInfoRequest) (cinfo *info.ContainerInfo, err error)
• func (self *Client) DockerContainer(name string, query *info.ContainerInfoRequest) (cinfo info.ContainerInfo, err error)
• func (self *Client) EventStaticInfo(name string) (einfo []*info.Event, err error)
• func (self *Client) EventStreamingInfo(name string, einfo chan *info.Event) (err error)
• func (self *Client) MachineInfo() (minfo *info.MachineInfo, err error)
• func (self *Client) SubcontainersInfo(name string, query *info.ContainerInfoRequest) ([]info.ContainerInfo, error)

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client represents the base URL for a cAdvisor client.

func NewClient ¶

func NewClient(url string) (*Client, error)

NewClient returns a new client with the specified base URL.

func (*Client) AllDockerContainers ¶

func (self *Client) AllDockerContainers(query *info.ContainerInfoRequest) (cinfo []info.ContainerInfo, err error)

Returns the JSON container information for all Docker containers.

func (*Client) ContainerInfo ¶

func (self *Client) ContainerInfo(name string, query *info.ContainerInfoRequest) (cinfo *info.ContainerInfo, err error)

ContainerInfo returns the JSON container information for the specified container and request.

func (*Client) DockerContainer ¶

func (self *Client) DockerContainer(name string, query *info.ContainerInfoRequest) (cinfo info.ContainerInfo, err error)

Returns the JSON container information for the specified Docker container and request.

func (*Client) EventStaticInfo ¶

func (self *Client) EventStaticInfo(name string) (einfo []*info.Event, err error)

Returns all past events that satisfy the request

func (*Client) EventStreamingInfo ¶

func (self *Client) EventStreamingInfo(name string, einfo chan *info.Event) (err error)

Streams all events that occur that satisfy the request into the channel that is passed

func (*Client) MachineInfo ¶

func (self *Client) MachineInfo() (minfo *info.MachineInfo, err error)

MachineInfo returns the JSON machine information for this client. A non-nil error result indicates a problem with obtaining the JSON machine information data.

func (*Client) SubcontainersInfo ¶

func (self *Client) SubcontainersInfo(name string, query *info.ContainerInfoRequest) ([]info.ContainerInfo, error)

Returns the information about all subcontainers (recursive) of the specified container (including itself).

Source Files ¶

client.go

Directories ¶