github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/cmd/services/m3aggregator/config/kv.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package config
    22  
    23  import (
    24  	"github.com/m3db/m3/src/cluster/client"
    25  	etcdclient "github.com/m3db/m3/src/cluster/client/etcd"
    26  	"github.com/m3db/m3/src/x/instrument"
    27  )
    28  
    29  // KVClientConfiguration configures the client for the key-value store.
    30  // TODO(xichen): add configuration for in-memory client with pre-populated data
    31  // for different namespaces so we can start up m3aggregator without a real etcd cluster.
    32  type KVClientConfiguration struct {
    33  	Etcd *etcdclient.Configuration `yaml:"etcd"`
    34  }
    35  
    36  // NewKVClient creates a new KV client.
    37  func (c *KVClientConfiguration) NewKVClient(
    38  	instrumentOpts instrument.Options,
    39  ) (client.Client, error) {
    40  	if c.Etcd == nil {
    41  		return nil, errNoKVClientConfiguration
    42  	}
    43  	return c.Etcd.NewClient(instrumentOpts)
    44  }