github.com/m3db/m3@v1.5.0/src/metrics/encoding/protobuf/aggregated_encoder.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 protobuf
    22  
    23  import (
    24  	"github.com/m3db/m3/src/metrics/generated/proto/metricpb"
    25  	"github.com/m3db/m3/src/metrics/metric/aggregated"
    26  	"github.com/m3db/m3/src/x/pool"
    27  )
    28  
    29  // AggregatedEncoder is an encoder for encoding aggregated metrics.
    30  type AggregatedEncoder interface {
    31  	// Encode encodes a metric with an applicable storage policy,
    32  	// alongside the time at which encoding happens.
    33  	Encode(m aggregated.MetricWithStoragePolicy, encodedAtNanos int64) error
    34  
    35  	// Buffer returns the encoded buffer.
    36  	Buffer() Buffer
    37  }
    38  
    39  type aggregatedEncoder struct {
    40  	pool pool.BytesPool
    41  	buf  []byte
    42  	pb   metricpb.AggregatedMetric
    43  }
    44  
    45  // NewAggregatedEncoder creates a new aggregated encoder.
    46  func NewAggregatedEncoder(p pool.BytesPool) AggregatedEncoder {
    47  	e := &aggregatedEncoder{
    48  		pool: p,
    49  	}
    50  	return e
    51  }
    52  
    53  func (enc *aggregatedEncoder) Encode(
    54  	m aggregated.MetricWithStoragePolicy,
    55  	encodedAtNanos int64,
    56  ) error {
    57  	ReuseAggregatedMetricProto(&enc.pb)
    58  	if err := m.ToProto(&enc.pb.Metric); err != nil {
    59  		return err
    60  	}
    61  	enc.pb.EncodeNanos = encodedAtNanos
    62  	// Always allocate a new byte slice to avoid modifying the existing one which may still being used.
    63  	enc.buf = allocate(enc.pool, enc.pb.Size())
    64  	n, err := enc.pb.MarshalTo(enc.buf)
    65  	enc.buf = enc.buf[:n]
    66  	return err
    67  }
    68  
    69  func (enc *aggregatedEncoder) Buffer() Buffer {
    70  	var fn PoolReleaseFn
    71  	if enc.pool != nil {
    72  		fn = enc.pool.Put
    73  	}
    74  	return NewBuffer(enc.buf, fn)
    75  }