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

# Functions

NewClient creates a new client.
NewConnectionOptions create a new set of connection options.
NewM3MsgClient creates a new M3 Aggregator client that uses M3Msg.
NewM3MsgOptions returns a new set of M3Msg options.
NewMockAdminClient creates a new mock instance.
NewMockClient creates a new mock instance.
NewMockinstanceQueue creates a new mock instance.
NewMockinstanceWriter creates a new mock instance.
NewMockinstanceWriterManager creates a new mock instance.
NewOptions creates a new set of client options.
NewTCPClient returns new Protobuf over TCP M3 Aggregator client.

# Constants

DropCurrent signifies that the current metrics in the queue should be dropped.
DropOldest signifies that the oldest metrics in the queue should be dropped.
LegacyAggregatorClient is an alias for TCPAggregatorClient.
M3MsgAggregatorClient is the M3Msg aggregator client type that uses M3Msg to handle publishing to a M3Msg topic the aggregator consumes from.
TCPAggregatorClient is the TCP aggregator client type and uses it's own TCP negotiation, load balancing and data transmission protocol.

# Structs

Configuration contains client configuration.
ConnectionConfiguration contains the connection configuration.
EncoderConfiguration configures the encoder.
M3MsgClient sends metrics to M3 Aggregator over m3msg.
M3MsgConfiguration contains the M3Msg client configuration, required if using M3Msg client type.
MockAdminClient is a mock of AdminClient interface.
MockAdminClientMockRecorder is the mock recorder for MockAdminClient.
MockClient is a mock of Client interface.
MockClientMockRecorder is the mock recorder for MockClient.
MockinstanceQueue is a mock of instanceQueue interface.
MockinstanceQueueMockRecorder is the mock recorder for MockinstanceQueue.
MockinstanceWriter is a mock of instanceWriter interface.
MockinstanceWriterManager is a mock of instanceWriterManager interface.
MockinstanceWriterManagerMockRecorder is the mock recorder for MockinstanceWriterManager.
MockinstanceWriterMockRecorder is the mock recorder for MockinstanceWriter.
TCPClient sends metrics to M3 Aggregator via over custom TCP protocol.

# Interfaces

AdminClient is an administrative client capable of performing regular client operations as well as high-privilege operations such as internal communcations among aggregation servers that regular client is not permissioned to do.
Client is a client capable of writing different types of metrics to the aggregation clients.
ConnectionOptions provides a set of options for tcp connections.
M3MsgOptions is a set of M3Msg client options.
Options provide a set of client options.

# Type aliases

AggregatorClientType determines the aggregator client type.
DropType determines which metrics should be dropped when the queue is full.