github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/matcher/namespace/resolver.go (about)

     1  // Copyright (c) 2021 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 namespace provides namespace functionality for the matcher.
    22  package namespace
    23  
    24  import (
    25  	"github.com/m3db/m3/src/metrics/metric/id"
    26  )
    27  
    28  var (
    29  	defaultNamespaceTag   = []byte("namespace")
    30  	defaultNamespaceValue = []byte("default")
    31  	// Default is the default Resolver.
    32  	Default = NewResolver(defaultNamespaceTag, defaultNamespaceValue)
    33  )
    34  
    35  // Resolver resolves a namespace value from an encoded metric id.
    36  type Resolver interface {
    37  	// Resolve the namespace value.
    38  	Resolve(id id.ID) []byte
    39  }
    40  
    41  // NewResolver creates a new Resolver.
    42  func NewResolver(namespaceTag, defaultNamespace []byte) Resolver {
    43  	if namespaceTag == nil {
    44  		namespaceTag = defaultNamespaceTag
    45  	}
    46  	if defaultNamespace == nil {
    47  		defaultNamespace = defaultNamespaceValue
    48  	}
    49  	return &resolver{
    50  		namespaceTag:     namespaceTag,
    51  		defaultNamespace: defaultNamespace,
    52  	}
    53  }
    54  
    55  type resolver struct {
    56  	namespaceTag     []byte
    57  	defaultNamespace []byte
    58  }
    59  
    60  func (r resolver) Resolve(id id.ID) []byte {
    61  	ns, found := id.TagValue(r.namespaceTag)
    62  	if !found {
    63  		ns = r.defaultNamespace
    64  	}
    65  	return ns
    66  }