github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/encoding/types.go (about)

     1  // Copyright (c) 2018 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 encoding
    22  
    23  import (
    24  	"io"
    25  
    26  	"github.com/m3db/m3/src/metrics/metric/aggregated"
    27  	"github.com/m3db/m3/src/metrics/metric/unaggregated"
    28  )
    29  
    30  // UnaggregatedMessageType is the unaggregated message type.
    31  type UnaggregatedMessageType int
    32  
    33  // A list of supported unaggregated message type.
    34  const (
    35  	UnknownMessageType UnaggregatedMessageType = iota
    36  	CounterWithMetadatasType
    37  	BatchTimerWithMetadatasType
    38  	GaugeWithMetadatasType
    39  	ForwardedMetricWithMetadataType
    40  	TimedMetricWithMetadataType
    41  	TimedMetricWithMetadatasType
    42  	PassthroughMetricWithMetadataType
    43  )
    44  
    45  // UnaggregatedMessageUnion is a union of different types of unaggregated messages.
    46  // A message union may contain at most one type of message that is determined
    47  // by the `Type` field of the union, which in turn determines which one
    48  // of the field in the union contains the corresponding message data.
    49  type UnaggregatedMessageUnion struct {
    50  	Type                          UnaggregatedMessageType
    51  	CounterWithMetadatas          unaggregated.CounterWithMetadatas
    52  	BatchTimerWithMetadatas       unaggregated.BatchTimerWithMetadatas
    53  	GaugeWithMetadatas            unaggregated.GaugeWithMetadatas
    54  	ForwardedMetricWithMetadata   aggregated.ForwardedMetricWithMetadata
    55  	TimedMetricWithMetadata       aggregated.TimedMetricWithMetadata
    56  	TimedMetricWithMetadatas      aggregated.TimedMetricWithMetadatas
    57  	PassthroughMetricWithMetadata aggregated.PassthroughMetricWithMetadata
    58  }
    59  
    60  // ByteReadScanner is capable of reading and scanning bytes.
    61  type ByteReadScanner interface {
    62  	io.Reader
    63  	io.ByteScanner
    64  }