github.com/m3db/m3@v1.5.0/src/metrics/metric/id/id.go (about)

     1  // Copyright (c) 2016 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 id
    22  
    23  import "fmt"
    24  
    25  // ID is a metric id.
    26  type ID interface {
    27  	// Bytes returns the raw bytes for this id.
    28  	Bytes() []byte
    29  
    30  	// TagValue looks up the tag value for a tag name.
    31  	TagValue(tagName []byte) ([]byte, bool)
    32  }
    33  
    34  // NameAndTagsFn returns the name and the tag pairs given an id.
    35  type NameAndTagsFn func(id []byte) (name []byte, tags []byte, err error)
    36  
    37  // NewIDFn creates a new metric ID based on the metric name and metric tag pairs.
    38  type NewIDFn func(name []byte, tags []TagPair) []byte
    39  
    40  // MatchIDFn determines whether an id is considered "matched" based on certain criteria.
    41  type MatchIDFn func(name []byte, tags []byte) bool
    42  
    43  // RawID is the raw metric id.
    44  type RawID []byte
    45  
    46  // String is the string representation of a raw id.
    47  func (rid RawID) String() string { return string(rid) }
    48  
    49  // ChunkedID is a three-part id.
    50  type ChunkedID struct {
    51  	Prefix []byte
    52  	Data   []byte
    53  	Suffix []byte
    54  }
    55  
    56  // String is the string representation of the chunked id.
    57  func (cid ChunkedID) String() string {
    58  	return fmt.Sprintf("%s%s%s", cid.Prefix, cid.Data, cid.Suffix)
    59  }