server

Documentation

Index

• func Run(runOpts RunOptions)
• type CustomTSDBOptionsFn
• type RunOptions

Functions

func Run

func Run(runOpts RunOptions)

Run runs the server programmatically given a filename for the configuration file.

Types

type CustomTSDBOptionsFn

type CustomTSDBOptionsFn func(tsdb.Options) tsdb.Options

CustomTSDBOptionsFn is a transformation function for TSDB Options.

type RunOptions

type RunOptions struct {
	// Config is an alternate way to provide configuration and will be used
	// instead of parsing ConfigFile if ConfigFile is not specified.
	Config config.Configuration

	// DBConfig is the local M3DB config when running embedded.
	DBConfig *dbconfig.DBConfiguration

	// DBClient is the local M3DB client when running embedded.
	DBClient <-chan client.Client

	// ClusterClient is the local M3DB cluster client when running embedded.
	ClusterClient <-chan clusterclient.Client

	// InterruptCh is a programmatic interrupt channel to supply to
	// interrupt and shutdown the server.
	InterruptCh <-chan error

	// ListenerCh is a programmatic channel to receive the server listener
	// on once it has opened.
	ListenerCh chan<- net.Listener

	// M3MsgListenerCh is a programmatic channel to receive the M3Msg server
	// listener on once it has opened.
	M3MsgListenerCh chan<- net.Listener

	// DownsamplerReadyCh is a programmatic channel to receive the downsampler
	// ready signal once it is open.
	DownsamplerReadyCh chan<- struct{}

	// CustomHandlerOptions contains custom handler options.
	CustomHandlerOptions options.CustomHandlerOptions

	// CustomPromQLParseFunction is a custom PromQL parsing function.
	CustomPromQLParseFunction promql.ParseFn

	// ApplyCustomTSDBOptions is a transform that allows for custom tsdb options.
	ApplyCustomTSDBOptions CustomTSDBOptionsFn
}

RunOptions provides options for running the server with backwards compatibility if only solely adding fields.