go.temporal.io/server@v1.23.0/common/metrics/option.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package metrics
    26  
    27  // Option is used to configure a metric definition. Note that options are currently only supported when using the
    28  // Prometheus reporter with the OpenTelemetry framework.
    29  type Option interface {
    30  	apply(m *metricDefinition)
    31  }
    32  
    33  // WithDescription sets the description, or "help text", of a metric. See [ServiceRequests] for an example.
    34  type WithDescription string
    35  
    36  func (h WithDescription) apply(m *metricDefinition) {
    37  	m.description = string(h)
    38  }
    39  
    40  // WithUnit sets the unit of a metric. See NewBytesHistogramDef for an example.
    41  type WithUnit MetricUnit
    42  
    43  func (h WithUnit) apply(m *metricDefinition) {
    44  	m.unit = MetricUnit(h)
    45  }