m3db

Documentation

Index

• type Node
  • func New(svcNode node.ServiceNode, opts Options) (Node, error)
• type NodeHealth
• type Options
  • func NewOptions(iopts instrument.Options) Options

Types

type Node

type Node interface {
	node.ServiceNode

	// Health returns the health for this node
	Health() (NodeHealth, error)

	// Bootstrapped returns whether the node is bootstrapped
	Bootstrapped() bool
}

Node represents a ServiceNode pointing to an M3DB process

func New

func New(svcNode node.ServiceNode, opts Options) (Node, error)

New constructs a new m3emNode

type NodeHealth

type NodeHealth struct {
	Status       string
	Bootstrapped bool
	OK           bool
}

NodeHealth provides Health information for a M3DB node

type Options

type Options interface {
	// Validate validates the Options
	Validate() error

	// SetInstrumentOptions sets the instrumentation options
	SetInstrumentOptions(instrument.Options) Options

	// InstrumentOptions returns the instrumentation options
	InstrumentOptions() instrument.Options

	// SetNodeOptions sets the node options
	SetNodeOptions(node.Options) Options

	// NodeOptions returns the node options
	NodeOptions() node.Options
}

Options represent the knobs to control m3db.Node behavior

func NewOptions

func NewOptions(
	iopts instrument.Options,
) Options

NewOptions returns a new Options construct.