common

type Context interface {
	context.Context
	Cancel()
	Channel() chan interface{}
	WG() *sync.WaitGroup
	Logger() Logger
	Meta() MetaClient
}

type GCEClient struct {
	*metadata.Client
	// contains filtered or unexported fields
}

type Logger interface {
	// basic logging functions
	Debugf(string, ...interface{})
	Infof(string, ...interface{})
	Warnf(string, ...interface{})
	Errorf(string, ...interface{})
	Fatalf(string, ...interface{})
	Debug(...interface{})
	Info(...interface{})
	Warn(...interface{})
	Error(...interface{})
	Fatal(...interface{})
	Panic(...interface{})
	// extended functions
	WithField(string, interface{}) Logger
	WithFields(map[string]interface{}) Logger
}

type MetaClient interface {
	// WhereAmI returns the name of CSP.
	WhereAmI() string
	// InstanceName returns the current VM's instance name string.
	InstanceName() string
	// ExternalIP returns the instance's primary external (public) IP address.
	ExternalIP() string
	// Zone returns the current VM's zone, such as "asia-northeast3-a".
	Zone() string
	// AttributeValues gets comma or space separated metadata values
	// It is a wrapper of AttributeValue(string)
	AttributeValues(key string) []string
	// AttributeValue gets bare string for the given metadata key. It will
	// check the metadata for the instance first and will return the value
	// if the metadata with the same key exists, otherwise it will check
	// the project's metadata with the same logic.
	AttributeValue(key string) string
	// AttributeSSV gets space separated values for the given metadata key
	// It is a wrapper of AttributeValue(string)
	AttributeSSV(key string) []string
	// AttributeCSV gets comma separated values for the given metadata key
	// It is a wrapper of AttributeValue(string)
	AttributeCSV(key string) []string
}

type Options struct {
	IsDebug  bool
	LogLevel string
	// Checkers constains selected checkers. All available checkers will be
	// selected if this field is empty.
	Checkers []string
	// Exporters contains selected exporters. All available exporters will be
	// selected if this field is empty.
	Exporters []string

	// Address is a listen address for embedded webserver
	Address string

	CheckerOptions  map[string]PluginOptions
	ExporterOptions map[string]PluginOptions
}

type Plugin interface {
	// Name returns the name of the plugin.
	Name() string
	// Run starts the plugin's runner in a goroutine and returns the status of
	// execution. The runner will run forever until the given context is
	// canceled.
	Run(Context, PluginOptions, chan interface{}) error
}

type PluginOptions map[string][]string

type Runner func(Context, PluginOptions, chan interface{}) error