github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/ts/types.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 ts
    22  
    23  import (
    24  	"github.com/m3db/m3/src/x/ident"
    25  	xtime "github.com/m3db/m3/src/x/time"
    26  )
    27  
    28  // Series describes a series.
    29  type Series struct {
    30  	// UniqueIndex is the unique index assigned to this series (only valid
    31  	// on a per-process basis).
    32  	UniqueIndex uint64
    33  
    34  	// Namespace is the namespace the series belongs to.
    35  	Namespace ident.ID
    36  
    37  	// ID is the series identifier.
    38  	ID ident.ID
    39  
    40  	// EncodedTags are the series encoded tags, if set then call sites can
    41  	// avoid needing to encoded the tags from the series tags provided.
    42  	EncodedTags EncodedTags
    43  
    44  	// Shard is the shard the series belongs to.
    45  	Shard uint32
    46  }
    47  
    48  // A Datapoint is a single data value reported at a given time.
    49  type Datapoint struct {
    50  	TimestampNanos xtime.UnixNano
    51  	Value          float64
    52  }
    53  
    54  // Equal returns whether one Datapoint is equal to another
    55  func (d Datapoint) Equal(x Datapoint) bool {
    56  	return d.TimestampNanos == x.TimestampNanos && d.Value == x.Value
    57  }
    58  
    59  // EncodedTags represents the encoded tags for the series.
    60  type EncodedTags []byte
    61  
    62  // OptimizedAnnotationLen specifies the limit of length of annotations for which
    63  // we avoid allocations by using fixed backing memory where possible.
    64  const OptimizedAnnotationLen = 16
    65  
    66  // Annotation represents information used to annotate datapoints.
    67  type Annotation []byte