github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/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 struct {
    31  	pool pool.BytesPool
    32  	buf  []byte
    33  	pb   metricpb.AggregatedMetric
    34  }
    35  
    36  // NewAggregatedEncoder creates a new aggregated encoder.
    37  func NewAggregatedEncoder(p pool.BytesPool) *AggregatedEncoder {
    38  	return &AggregatedEncoder{
    39  		pool: p,
    40  	}
    41  }
    42  
    43  // Encode encodes a metric with an applicable storage policy.
    44  func (enc *AggregatedEncoder) Encode(
    45  	m aggregated.MetricWithStoragePolicy,
    46  ) error {
    47  	ReuseAggregatedMetricProto(&enc.pb)
    48  	if err := m.ToProto(&enc.pb.Metric); err != nil {
    49  		return err
    50  	}
    51  	// Always allocate a new byte slice to avoid modifying the existing one which may still being used.
    52  	enc.buf = allocate(enc.pool, enc.pb.Size())
    53  	n, err := enc.pb.MarshalTo(enc.buf)
    54  	enc.buf = enc.buf[:n]
    55  	return err
    56  }
    57  
    58  // Buffer returns the encoded buffer
    59  func (enc *AggregatedEncoder) Buffer() Buffer {
    60  	var fn PoolReleaseFn
    61  	if enc.pool != nil {
    62  		fn = enc.pool.Put
    63  	}
    64  	return NewBuffer(enc.buf, fn)
    65  }