resources

type Admin interface {
	// GetNamespace gets namespaces.
	GetNamespace() (admin.NamespaceGetResponse, error)
	// WaitForNamespace blocks until the given namespace is enabled.
	// NB: if the name string is empty, this will instead
	// check for a successful response.
	WaitForNamespace(name string) error
	// AddNamespace adds a namespace.
	AddNamespace(admin.NamespaceAddRequest) (admin.NamespaceGetResponse, error)
	// UpdateNamespace updates the namespace.
	UpdateNamespace(admin.NamespaceUpdateRequest) (admin.NamespaceGetResponse, error)
	// DeleteNamespace removes the namespace.
	DeleteNamespace(namespaceID string) error
	// CreateDatabase creates a database.
	CreateDatabase(admin.DatabaseCreateRequest) (admin.DatabaseCreateResponse, error)
	// GetPlacement gets placements.
	GetPlacement(PlacementRequestOptions) (admin.PlacementGetResponse, error)
	// InitPlacement initializes placements.
	InitPlacement(PlacementRequestOptions, admin.PlacementInitRequest) (admin.PlacementGetResponse, error)
	// DeleteAllPlacements deletes all placements for the service specified
	// in the PlacementRequestOptions.
	DeleteAllPlacements(PlacementRequestOptions) error
	// WaitForInstances blocks until the given instance is available.
	WaitForInstances(ids []string) error
	// WaitForShardsReady waits until all shards gets ready.
	WaitForShardsReady() error
	// InitM3msgTopic initializes an m3msg topic.
	InitM3msgTopic(M3msgTopicOptions, admin.TopicInitRequest) (admin.TopicGetResponse, error)
	// GetM3msgTopic gets an m3msg topic.
	GetM3msgTopic(M3msgTopicOptions) (admin.TopicGetResponse, error)
	// AddM3msgTopicConsumer adds a consumer service to an m3msg topic.
	AddM3msgTopicConsumer(M3msgTopicOptions, admin.TopicAddRequest) (admin.TopicGetResponse, error)
	// WaitForClusterReady waits until the cluster is ready to receive reads and writes.
	WaitForClusterReady() error
	// Close closes the wrapper and releases any held resources, including
	// deleting docker containers.
	Close() error
}

type Aggregator interface {
	// Start starts the aggregator instance.
	Start()
	// HostDetails returns this aggregator instance's host details.
	HostDetails() (*InstanceInfo, error)
	// IsHealthy determines whether an instance is healthy.
	IsHealthy() error
	// Status returns the instance status.
	Status() (aggregator.RuntimeStatus, error)
	// Resign asks an aggregator instance to give up its current leader role if applicable.
	Resign() error
	// Close closes the wrapper and releases any held resources, including
	// deleting docker containers.
	Close() error
}

type AggregatorClusterOptions struct {
	// RF is the replication factor to use for aggregators.
	// It should be 1 for non-replicated mode and 2 for leader-follower mode.
	RF int32
	// NumShards is the number of shards to use for each RF.
	NumShards int32
	// NumInstances is the number of aggregator instances in total.
	NumInstances int32
	// NumIsolationGroups is the number of isolation groups to split
	// aggregators into.
	NumIsolationGroups int32
}

type Aggregators []Aggregator

type ClusterOptions struct {
	// DBNode contains cluster options for spinning up dbnodes.
	DBNode *DBNodeClusterOptions
	// Aggregator is the optional cluster options for spinning up aggregators.
	// If Aggregator is nil, the cluster contains only m3coordinator and dbnodes.
	Aggregator *AggregatorClusterOptions
	// Coordinator is the options for spinning up the coordinator
	Coordinator CoordinatorClusterOptions
}

type Coordinator interface {
	Admin

	// Start starts the coordinator instance.
	Start()
	// HostDetails returns this coordinator instance's host details.
	HostDetails() (*InstanceInfo, error)
	// ApplyKVUpdate applies a KV update.
	ApplyKVUpdate(update string) error
	// WriteCarbon writes a carbon metric datapoint at a given time.
	WriteCarbon(port int, metric string, v float64, t time.Time) error
	// WriteProm writes a prometheus metric. Takes tags/labels as a map for convenience.
	WriteProm(name string, tags map[string]string, samples []prompb.Sample, headers Headers) error
	// WritePromWithRequest executes a prometheus write request. Allows you to
	// provide the request directly which is useful for batch metric requests.
	WritePromWithRequest(writeRequest prompb.WriteRequest, headers Headers) error
	// RunQuery runs the given query with a given verification function.
	RunQuery(verifier ResponseVerifier, query string, headers Headers) error
	// InstantQuery runs an instant query with provided headers
	InstantQuery(req QueryRequest, headers Headers) (model.Vector, error)
	// InstantQueryWithEngine runs an instant query with provided headers and the specified
	// query engine.
	InstantQueryWithEngine(req QueryRequest, engine options.QueryEngine, headers Headers) (model.Vector, error)
	// RangeQuery runs a range query with provided headers
	RangeQuery(req RangeQueryRequest, headers Headers) (model.Matrix, error)
	// GraphiteQuery retrieves graphite raw data.
	GraphiteQuery(GraphiteQueryRequest) ([]Datapoint, error)
	// RangeQueryWithEngine runs a range query with provided headers and the specified
	// query engine.
	RangeQueryWithEngine(req RangeQueryRequest, engine options.QueryEngine, headers Headers) (model.Matrix, error)
	// LabelNames return matching label names based on the request.
	LabelNames(req LabelNamesRequest, headers Headers) (model.LabelNames, error)
	// LabelValues returns matching label values based on the request.
	LabelValues(req LabelValuesRequest, headers Headers) (model.LabelValues, error)
	// Series returns matching series based on the request.
	Series(req SeriesRequest, headers Headers) ([]model.Metric, error)
}

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

type CoordinatorClientOptions struct {
	Client    *http.Client
	HTTPPort  int
	Logger    *zap.Logger
	RetryFunc RetryFunc
}

type CoordinatorClusterOptions struct {
	// GeneratePortsi ndicates whether to update the coordinator config to use open ports.
	GeneratePorts bool
}

type DBNodeClusterOptions struct {
	// RF is the replication factor to use for the cluster.
	RF int32
	// NumShards is the number of shards to use for each RF.
	NumShards int32
	// NumInstances is the number of dbnode instances per RF.
	NumInstances int32
	// NumIsolationGroups is the number of isolation groups to split
	// nodes into.
	NumIsolationGroups int32
}

type Datapoint struct {
	// Value is the value of the datapoint.
	Value *float64
	// Timestamp is the timestamp (in seconds) of the datapoint.
	Timestamp int64
}

type ExternalResources interface {
	// Setup sets up the external resource so that it's ready
	// for use.
	Setup() error

	// Close stops and cleans up all the resources associated with
	// the external resource.
	Close() error
}

type GoalStateVerifier func(string, error) error

type GraphiteQueryRequest struct {
	// Target speicifies a path identifying one or several metrics.
	Target string
	// From is the beginning of the time period to query.
	From time.Time
	// Until is the end of the time period to query.
	Until time.Time
}

type Headers map[string][]string

type InstanceInfo struct {
	// ID is the name of the host. It can be hostname or UUID or any other string.
	ID string
	// Env specifies the zone the host resides in.
	Env string
	// Zone specifies the zone the host resides in.
	Zone string
	// Address can be IP address or hostname, this is used to connect to the host.
	Address string
	// M3msgAddress is the address of the m3msg server if there is one.
	M3msgAddress string
	// Port is the port number.
	Port uint32
	// Port is the port of the m3msg server if there is one.
	M3msgPort uint32
}

type LabelNamesRequest struct {
	MetadataRequest
}

type LabelValuesRequest struct {
	MetadataRequest

	// LabelName is the name of the label to retrieve values for.
	LabelName string
}

type M3Resources interface {
	// Start starts all the M3 components.
	Start()
	// Cleanup cleans up after each started component.
	Cleanup() error
	// Nodes returns all node resources.
	Nodes() Nodes
	// Coordinator returns the coordinator resource.
	Coordinator() Coordinator
	// Aggregators returns all aggregator resources.
	Aggregators() Aggregators
}

type M3msgTopicOptions struct {
	// Zone is the zone of the m3msg topic.
	Zone string
	// Env is the environment of the m3msg topic.
	Env string
	// TopicName is the topic name of the m3msg topic name.
	TopicName string
}

type MetadataRequest struct {
	// Start is the start timestamp of labels to include.
	Start time.Time
	// End is the end timestamp of labels to include.
	End time.Time
	// Match is the series selector that selects series to read label names from.
	Match string
}

type Node interface {
	// Start starts the dbnode instance.
	Start()
	// HostDetails returns this node's host details on the given port.
	HostDetails(port int) (*admin.Host, error)
	// Health gives this node's health.
	Health() (*rpc.NodeHealthResult_, error)
	// WaitForBootstrap blocks until the node has bootstrapped.
	WaitForBootstrap() error
	// WritePoint writes a datapoint to the node directly.
	WritePoint(req *rpc.WriteRequest) error
	// WriteTaggedPoint writes a datapoint with tags to the node directly.
	WriteTaggedPoint(req *rpc.WriteTaggedRequest) error
	// WriteTaggedBatchRaw writes a batch of writes to the node directly.
	WriteTaggedBatchRaw(req *rpc.WriteTaggedBatchRawRequest) error
	// AggregateTiles starts tiles aggregation, waits until it will complete
	// and returns the amount of aggregated tiles.
	AggregateTiles(req *rpc.AggregateTilesRequest) (int64, error)
	// Fetch fetches datapoints.
	Fetch(req *rpc.FetchRequest) (*rpc.FetchResult_, error)
	// FetchTagged fetches datapoints by tag.
	FetchTagged(req *rpc.FetchTaggedRequest) (*rpc.FetchTaggedResult_, error)
	// Exec executes the given commands on the node container, returning
	// stdout and stderr from the container.
	Exec(commands ...string) (string, error)
	// GoalStateExec executes the given commands on the node container, retrying
	// until applying the verifier returns no error or the default timeout.
	GoalStateExec(verifier GoalStateVerifier, commands ...string) error
	// Restart restarts this container.
	Restart() error
	// Close closes the wrapper and releases any held resources, including
	// deleting docker containers.
	Close() error
}

type Nodes []Node

type PlacementRequestOptions struct {
	// Service is the type of service for the placement request.
	Service ServiceType
	// Env is the environment of the placement.
	Env string
	// Zone is the zone of the placement.
	Zone string
}

type QueryRequest struct {
	// Query is the Prometheus expression query string.
	Query string
	// Time is the evaluation timestamp. It is optional.
	Time *time.Time
}

type RangeQueryRequest struct {
	// Query is the Prometheus expression query string.
	Query string
	// Start is the start timestamp of the query range. The default value is time.Now().
	Start time.Time
	// End is the end timestamp of the query range. The default value is time.Now().
	End time.Time
	// Step is the query resolution step width. It is default to 15 seconds.
	Step time.Duration
}

type ResponseVerifier func(int, map[string][]string, string, error) error

type RetryFunc func(op func() error) error

type SeriesRequest struct {
	MetadataRequest
}

type ServiceType int