Class: OpenTelemetry::Metrics::Meter

Inherits:
Object
  • Object
show all
Defined in:
lib/opentelemetry/metrics/meter.rb

Overview

No-op implementation of Meter.

Instance Method Summary collapse

Instance Method Details

#create_float_counter(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: true) ⇒ FloatCounter

Create and return a floating point counter.

Parameters:

  • name (String) —

    Name of the metric. See OpenTelemetry::Metrics::Meter for required metric name syntax.

  • description (optional String) (defaults to: nil) —

    Descriptive text documenting the instrument.

  • unit (optional String) (defaults to: nil) —

    Unit specified according to unitsofmeasure.org/ucum.html.

  • recommended_label_keys (optional Enumerable<String>) (defaults to: nil) —

    Recommended grouping keys for this instrument.

  • monotonic (optional Boolean) (defaults to: true) —

    Whether the counter accepts only monotonic updates. Defaults to true.

Returns:

  • (FloatCounter)

Raises:

  • (ArgumentError) 


60
61
62
63
64
 
# File 'lib/opentelemetry/metrics/meter.rb', line 60

def create_float_counter(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: true)
  raise ArgumentError if name.nil?

  Instruments::FloatCounter.new
end

#create_float_gauge(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: false) ⇒ FloatGauge

Create and return a floating point gauge.

Parameters:

  • name (String) —

    Name of the metric. See OpenTelemetry::Metrics::Meter for required metric name syntax.

  • description (optional String) (defaults to: nil) —

    Descriptive text documenting the instrument.

  • unit (optional String) (defaults to: nil) —

    Unit specified according to unitsofmeasure.org/ucum.html.

  • recommended_label_keys (optional Enumerable<String>) (defaults to: nil) —

    Recommended grouping keys for this instrument.

  • monotonic (optional Boolean) (defaults to: false) —

    Whether the gauge accepts only monotonic updates. Defaults to false.

Returns:

  • (FloatGauge)

Raises:

  • (ArgumentError) 


32
33
34
35
36
 
# File 'lib/opentelemetry/metrics/meter.rb', line 32

def create_float_gauge(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: false)
  raise ArgumentError if name.nil?

  Instruments::FloatGauge.new
end

#create_float_measure(name, description: nil, unit: nil, recommended_label_keys: nil, absolute: true) ⇒ FloatMeasure

Create and return a floating point measure.

Parameters:

  • name (String) —

    Name of the metric. See OpenTelemetry::Metrics::Meter for required metric name syntax.

  • description (optional String) (defaults to: nil) —

    Descriptive text documenting the instrument.

  • unit (optional String) (defaults to: nil) —

    Unit specified according to unitsofmeasure.org/ucum.html.

  • recommended_label_keys (optional Enumerable<String>) (defaults to: nil) —

    Recommended grouping keys for this instrument.

  • absolute (optional Boolean) (defaults to: true) —

    Whether the measure accepts only non-negative updates. Defaults to true.

Returns:

  • (FloatMeasure)

Raises:

  • (ArgumentError) 


88
89
90
91
92
 
# File 'lib/opentelemetry/metrics/meter.rb', line 88

def create_float_measure(name, description: nil, unit: nil, recommended_label_keys: nil, absolute: true)
  raise ArgumentError if name.nil?

  Instruments::FloatMeasure.new
end

#create_integer_counter(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: true) ⇒ IntegerCounter

Create and return an integer counter.

Parameters:

  • name (String) —

    Name of the metric. See OpenTelemetry::Metrics::Meter for required metric name syntax.

  • description (optional String) (defaults to: nil) —

    Descriptive text documenting the instrument.

  • unit (optional String) (defaults to: nil) —

    Unit specified according to unitsofmeasure.org/ucum.html.

  • recommended_label_keys (optional Enumerable<String>) (defaults to: nil) —

    Recommended grouping keys for this instrument.

  • monotonic (optional Boolean) (defaults to: true) —

    Whether the counter accepts only monotonic updates. Defaults to true.

Returns:

  • (IntegerCounter)

Raises:

  • (ArgumentError) 


74
75
76
77
78
 
# File 'lib/opentelemetry/metrics/meter.rb', line 74

def create_integer_counter(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: true)
  raise ArgumentError if name.nil?

  Instruments::IntegerCounter.new
end

#create_integer_gauge(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: false) ⇒ IntegerGauge

Create and return an integer gauge.

Parameters:

  • name (String) —

    Name of the metric. See OpenTelemetry::Metrics::Meter for required metric name syntax.

  • description (optional String) (defaults to: nil) —

    Descriptive text documenting the instrument.

  • unit (optional String) (defaults to: nil) —

    Unit specified according to unitsofmeasure.org/ucum.html.

  • recommended_label_keys (optional Enumerable<String>) (defaults to: nil) —

    Recommended grouping keys for this instrument.

  • monotonic (optional Boolean) (defaults to: false) —

    Whether the gauge accepts only monotonic updates. Defaults to false.

Returns:

  • (IntegerGauge)

Raises:

  • (ArgumentError) 


46
47
48
49
50
 
# File 'lib/opentelemetry/metrics/meter.rb', line 46

def create_integer_gauge(name, description: nil, unit: nil, recommended_label_keys: nil, monotonic: false)
  raise ArgumentError if name.nil?

  Instruments::IntegerGauge.new
end

#create_integer_measure(name, description: nil, unit: nil, recommended_label_keys: nil, absolute: true) ⇒ IntegerMeasure

Create and return an integer measure.

Parameters:

  • name (String) —

    Name of the metric. See OpenTelemetry::Metrics::Meter for required metric name syntax.

  • description (optional String) (defaults to: nil) —

    Descriptive text documenting the instrument.

  • unit (optional String) (defaults to: nil) —

    Unit specified according to unitsofmeasure.org/ucum.html.

  • recommended_label_keys (optional Enumerable<String>) (defaults to: nil) —

    Recommended grouping keys for this instrument.

  • absolute (optional Boolean) (defaults to: true) —

    Whether the measure accepts only non-negative updates. Defaults to true.

Returns:

  • (IntegerMeasure)

Raises:

  • (ArgumentError) 


102
103
104
105
106
 
# File 'lib/opentelemetry/metrics/meter.rb', line 102

def create_integer_measure(name, description: nil, unit: nil, recommended_label_keys: nil, absolute: true)
  raise ArgumentError if name.nil?

  Instruments::IntegerMeasure.new
end

#labels(labels) ⇒ LabelSet

Canonicalizes labels, returning an opaque LabelSet object.

Parameters:

  • labels (Hash<String, String>)

Returns:

  • (LabelSet) 


20
21
22
 
# File 'lib/opentelemetry/metrics/meter.rb', line 20

def labels(labels)
  NOOP_LABEL_SET
end

#record_batch(*measurements, label_set: nil) ⇒ Object 



14
 
# File 'lib/opentelemetry/metrics/meter.rb', line 14

def record_batch(*measurements, label_set: nil); end