package
1.5.0
Repository: https://github.com/m3db/m3.git
Documentation: pkg.go.dev

# Functions

ConfigurePlacementsForAggregation sets up the correct placement information for coordinators and aggregators when aggregation is enabled.
GenerateAggregatorConfigsForCluster generates the unique configs for each aggregator instance.
GenerateClusterSpecification generates the per-instance configuration and options for the cluster set up based on the given input configuation and options.
GenerateDBNodeConfigsForCluster generates the unique configs and options for each DB node that will be instantiated.
NewAggregator creates a new in-process aggregator based on the configuration and options provided.
NewAggregatorFromYAML creates a new in-process aggregator based on the yaml configuration and options provided.
NewCluster creates a new M3 cluster based on the ClusterOptions provided.
NewClusterConfigsFromConfigFile creates a new ClusterConfigs object from the provided filepaths for dbnode and coordinator configuration.
NewClusterConfigsFromYAML creates a new ClusterConfigs object from YAML strings representing component configs.
NewClusterFromSpecification creates a new M3 cluster with the given ClusterSpecification.
NewCoordinator creates a new in-process coordinator based on the configuration and options provided.
NewCoordinatorFromConfigFile creates a new in-process coordinator based on the config file and options provided.
NewCoordinatorFromYAML creates a new in-process coordinator based on the YAML configuration string and options provided.
NewDBNode creates a new in-process DB node based on the configuration and options provided.
NewDBNodeFromConfigFile creates a new in-process DB node based on the config file and options provided.
NewDBNodeFromYAML creates a new in-process DB node based on the YAML configuration string and options provided.
NewEmbeddedCoordinator creates a coordinator from one embedded within an existing db node.
NewM3Resources returns an implementation of resources.M3Resources backed by in-process implementations of the M3 components.

# Structs

Aggregator is an in-process implementation of resources.Aggregator for use in integration tests.
AggregatorOptions are options of starting an in-process aggregator.
ClusterConfigs contain the input config to use for components within the cluster.
ClusterSpecification contain the per-instance configuration and options to use for starting each components within the cluster.
nolint:maligned Coordinator is an in-process implementation of resources.Coordinator for use in integration tests.
nolint:maligned CoordinatorOptions are options for starting a coordinator server.
DBNode is an in-process implementation of resources.Node.
nolint:maligned DBNodeOptions are options for starting a DB node server.
PerInstanceConfigs contain the per-instance configuration for all components.
PerInstanceOptions contain the per-instance options for setting up the cluster.
ResourceOptions are the options for creating new resources.M3Resources.

# Type aliases

AggregatorStartFn is a custom function that can be used to start an aggregator.
CoordinatorStartFn is a custom function that can be used to start a coordinator.
DBNodeStartFn is a custom function that can be used to start a DB node.