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)


23
24
25
26
27
# File 'lib/opentelemetry/metrics/meter.rb', line 23

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_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)


51
52
53
54
55
# File 'lib/opentelemetry/metrics/meter.rb', line 51

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)


37
38
39
40
41
# File 'lib/opentelemetry/metrics/meter.rb', line 37

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_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)


65
66
67
68
69
# File 'lib/opentelemetry/metrics/meter.rb', line 65

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

  Instruments::IntegerMeasure.new
end

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



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

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