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

     1  // Copyright (c) 2021 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 "github.com/uber-go/tally"
    24  
    25  // Metrics contains metrics for encoding.
    26  type Metrics struct {
    27  	TimestampEncoder TimestampEncoderMetrics
    28  }
    29  
    30  // NewMetrics returns new Metrics.
    31  func NewMetrics(scope tally.Scope) Metrics {
    32  	return Metrics{
    33  		TimestampEncoder: newTimestampEncoderMetrics(scope.SubScope("timestamp-encoder")),
    34  	}
    35  }
    36  
    37  // TimestampEncoderMetrics contains timestamp encoder metrics.
    38  type TimestampEncoderMetrics struct {
    39  	annotationRewritten tally.Counter
    40  }
    41  
    42  func newTimestampEncoderMetrics(scope tally.Scope) TimestampEncoderMetrics {
    43  	return TimestampEncoderMetrics{
    44  		annotationRewritten: scope.Counter("annotation-rewritten"),
    45  	}
    46  }
    47  
    48  // IncAnnotationRewritten increments annotation rewritten counter.
    49  func (m *TimestampEncoderMetrics) IncAnnotationRewritten() {
    50  	if m.annotationRewritten != nil {
    51  		m.annotationRewritten.Inc(1)
    52  	}
    53  }