mackerelclient

Documentation

Index

• func LoadApibaseFromConfig(conffile string) string
• func LoadApibaseFromConfigWithFallback(conffile string) string
• func LoadApikeyFromConfig(conffile string) string
• func LoadApikeyFromEnvOrConfig(conffile string) string
• func LoadHostIDFromConfig(conffile string) string
• func NewFromContext(c *cli.Context) *mackerel.Client
• type Client
  • func New(conffile, apibase string) (Client, error)
• type MockClient
  • func NewMockClient(opts ...MockClientOption) *MockClient
  • func (c *MockClient) ApplyOption(opt MockClientOption)
  • func (c *MockClient) CreateHost(param *mackerel.CreateHostParam) (string, error)
  • func (c *MockClient) FindChannels() ([]*mackerel.Channel, error)
  • func (c *MockClient) FindHosts(param *mackerel.FindHostsParam) ([]*mackerel.Host, error)
  • func (c *MockClient) FindServices() ([]*mackerel.Service, error)
  • func (c *MockClient) GetOrg() (*mackerel.Org, error)
  • func (c *MockClient) UpdateHostStatus(hostID string, status string) error
• type MockClientOption
  • func MockCreateHost(callback func(*mackerel.CreateHostParam) (string, error)) MockClientOption
  • func MockFindChannels(callback func() ([]*mackerel.Channel, error)) MockClientOption
  • func MockFindHosts(callback func(param *mackerel.FindHostsParam) ([]*mackerel.Host, error)) MockClientOption
  • func MockFindServices(callback func() ([]*mackerel.Service, error)) MockClientOption
  • func MockGetOrg(callback func() (*mackerel.Org, error)) MockClientOption
  • func MockUpdateHostStatus(callback func(string, string) error) MockClientOption

Functions

func LoadApibaseFromConfig

func LoadApibaseFromConfig(conffile string) string

LoadApibaseFromConfig gets mackerel api Base URL (usually https://api.mackerelio.com/) from mackerel-agent.conf if it's installed mackerel-agent on localhost

func LoadApibaseFromConfigWithFallback

func LoadApibaseFromConfigWithFallback(conffile string) string

LoadApibaseFromConfigWithFallback get mackerel api Base URL from mackerel-agent.conf, and fallbacks to default (https://api.mackerelio.com/) if not specified.

func LoadApikeyFromConfig

func LoadApikeyFromConfig(conffile string) string

LoadApikeyFromConfig gets mackerel.io apikey from mackerel-agent.conf if it's installed mackerel-agent on localhost

func LoadApikeyFromEnvOrConfig

func LoadApikeyFromEnvOrConfig(conffile string) string

LoadApikeyFromEnvOrConfig is similar to LoadApikeyFromConfig. return MACKEREL_APIKEY environment value if defined MACKEREL_APIKEY

func LoadHostIDFromConfig

func LoadHostIDFromConfig(conffile string) string

LoadHostIDFromConfig gets localhost's hostID from conf.Root (ex. /var/lib/mackerel/id) if it's installed mackerel-agent on localhost

func NewFromContext

func NewFromContext(c *cli.Context) *mackerel.Client

NewFromContext returns mackerel client from cli.Context

Types

type Client

type Client interface {
	FindHosts(param *mackerel.FindHostsParam) ([]*mackerel.Host, error)
	FindServices() ([]*mackerel.Service, error)
	FindChannels() ([]*mackerel.Channel, error)
	GetOrg() (*mackerel.Org, error)
	CreateHost(param *mackerel.CreateHostParam) (string, error)
	UpdateHostStatus(hostID string, status string) error
}

Client represents a client of Mackerel API

func New

func New(conffile, apibase string) (Client, error)

New returns new mackerel client

type MockClient

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

MockClient represents a mock client of Mackerel API

func NewMockClient

func NewMockClient(opts ...MockClientOption) *MockClient

NewMockClient creates a new mock client of Mackerel API

func (*MockClient) ApplyOption

func (c *MockClient) ApplyOption(opt MockClientOption)

ApplyOption applies a mock client option

func (*MockClient) CreateHost

func (c *MockClient) CreateHost(param *mackerel.CreateHostParam) (string, error)

CreateHost ...

func (*MockClient) FindChannels

func (c *MockClient) FindChannels() ([]*mackerel.Channel, error)

FindChannels ...

func (*MockClient) FindHosts

func (c *MockClient) FindHosts(param *mackerel.FindHostsParam) ([]*mackerel.Host, error)

FindHosts ...

func (*MockClient) FindServices

func (c *MockClient) FindServices() ([]*mackerel.Service, error)

FindServices ...

func (*MockClient) GetOrg

func (c *MockClient) GetOrg() (*mackerel.Org, error)

GetOrg ...

func (*MockClient) UpdateHostStatus

func (c *MockClient) UpdateHostStatus(hostID string, status string) error

UpdateHostStatus ...

type MockClientOption

type MockClientOption func(*MockClient)

MockClientOption represents an option of mock client of Mackerel API

func MockCreateHost

func MockCreateHost(callback func(*mackerel.CreateHostParam) (string, error)) MockClientOption

MockCreateHost returns an option to set the callback of CreateHost

func MockFindChannels

func MockFindChannels(callback func() ([]*mackerel.Channel, error)) MockClientOption

MockFindChannels returns an option to set the callback of FindChannels

func MockFindHosts

func MockFindHosts(callback func(param *mackerel.FindHostsParam) ([]*mackerel.Host, error)) MockClientOption

MockFindHosts returns an option to set the callback of FindHosts

func MockFindServices

func MockFindServices(callback func() ([]*mackerel.Service, error)) MockClientOption

MockFindServices returns an option to set the callback of FindServices

func MockGetOrg

func MockGetOrg(callback func() (*mackerel.Org, error)) MockClientOption

MockGetOrg returns an option to set the callback of GetOrg

func MockUpdateHostStatus

func MockUpdateHostStatus(callback func(string, string) error) MockClientOption

MockUpdateHostStatus returns an option to set the callback of UpdateHostStatus