github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/rules/validator/namespace/kv/config.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 kv
    22  
    23  import (
    24  	"time"
    25  
    26  	"github.com/m3db/m3/src/cluster/client"
    27  	"github.com/m3db/m3/src/cluster/kv"
    28  	"github.com/m3db/m3/src/metrics/rules/validator/namespace"
    29  )
    30  
    31  // NamespaceValidatorConfiguration configures a KV-backed namespace validator.
    32  type NamespaceValidatorConfiguration struct {
    33  	KVConfig               kv.OverrideConfiguration `yaml:"kvConfig"`
    34  	InitWatchTimeout       *time.Duration           `yaml:"initWatchTimeout"`
    35  	ValidNamespacesKey     string                   `yaml:"validNamespacesKey" validate:"nonzero"`
    36  	DefaultValidNamespaces *[]string                `yaml:"defaultValidNamespaces"`
    37  }
    38  
    39  // NewNamespaceValidator creates a new namespace validator.
    40  func (c *NamespaceValidatorConfiguration) NewNamespaceValidator(
    41  	kvClient client.Client,
    42  ) (namespace.Validator, error) {
    43  	kvOpts, err := c.KVConfig.NewOverrideOptions()
    44  	if err != nil {
    45  		return nil, err
    46  	}
    47  	kvStore, err := kvClient.Store(kvOpts)
    48  	if err != nil {
    49  		return nil, err
    50  	}
    51  	opts := NewNamespaceValidatorOptions().
    52  		SetKVStore(kvStore).
    53  		SetValidNamespacesKey(c.ValidNamespacesKey)
    54  	if c.InitWatchTimeout != nil {
    55  		opts = opts.SetInitWatchTimeout(*c.InitWatchTimeout)
    56  	}
    57  	if c.DefaultValidNamespaces != nil {
    58  		opts = opts.SetDefaultValidNamespaces(*c.DefaultValidNamespaces)
    59  	}
    60  	return NewNamespaceValidator(opts)
    61  }