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

# Packages

Package docker contains resources needed to setup docker containers for M3 tests.
Package inprocess contains code for spinning up M3 resources in-process for the sake of integration testing.
Package net contains network-related helpers for integration testing.

# Functions

NewAggregatorClusterOptions creates AggregatorClusterOptions with sane defaults.
NewCoordinatorClient creates a new CoordinatorClient.
NewDBNodeClusterOptions creates DBNodeClusteOptions with sane defaults.
NewLogger creates a new development zap logger without stacktraces to cut down on verbosity.
Retry is a function for retrying an operation in integration tests.
RetryWithMaxTime is a function for retrying an operation in integration tests.
SetupCluster setups m3 cluster on provided docker containers.
SetupM3MsgTopics sets up the m3msg topics for the provided coordinator and aggregator.
SetupPlacement configures the placement for the provided coordinators and aggregators.
ZapMethod appends the method as a log field.

# Constants

AggName is the name of the aggregated namespace.
AggregatorInputTopic is the m3msg topic name for coordinator->aggregator traffic.
AggregatorOutputTopic is the m3msg topic name for aggregator->coordinator traffic.
ColdWriteNsName is the name for cold write namespace.
ServiceTypeM3Aggregator represents M3aggregator service.
ServiceTypeM3Coordinator represents M3coordinator service.
ServiceTypeM3DB represents M3DB service.
ServiceTypeUnknown is an unknown service type.
UnaggName is the name of the unaggregated namespace.

# Structs

AggregatorClusterOptions contains the cluster options for spinning up aggregators.
ClusterOptions contains options for spinning up a new M3 cluster composed of in-process components.
CoordinatorClient is a client use to invoke API calls on a coordinator.
CoordinatorClientOptions are the options for the CoordinatorClient.
CoordinatorClusterOptions contains the cluster options for spinning up the coordinator.
Datapoint is a data point returned by the graphite render query.
DBNodeClusterOptions contains the cluster options for spinning up dbnodes.
GraphiteQueryRequest represents a graphite render query request.
InstanceInfo represents the host information for an instance.
LabelNamesRequest contains the parameters for making label names API calls.
LabelValuesRequest contains the parameters for making label values API calls.
M3msgTopicOptions represents a set of options for an m3msg topic.
MetadataRequest contains the parameters for making API requests related to metadata.
PlacementRequestOptions represents a set of options for placement-related requests.
QueryRequest represents an instant query request.
RangeQueryRequest represents a range query request.
SeriesRequest contains the parameters for making series API calls.

# Interfaces

Admin is a wrapper for admin functions.
Aggregator is an aggregator instance.
Coordinator is a wrapper for a coordinator.
ExternalResources represents an external (i.e.
M3Resources represents a set of test M3 components.
Node is a wrapper for a db node.

# Type aliases

Aggregators is a slice of aggregators.
GoalStateVerifier verifies that the given results are valid.
Headers represents http headers.
Nodes is a slice of nodes.
ResponseVerifier is a function that checks if the query response is valid.
RetryFunc is a function that retries the provided operation until successful.
ServiceType represents the type of an m3 service.