Class: OpenTelemetry::SDK::Metrics::Export::ConsoleMetricPullExporter

Inherits:
MetricReader
  • Object
show all
Defined in:
lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb

Overview

Outputs MetricData to the console

Potentially useful for exploratory purposes.

Instance Attribute Summary

Attributes inherited from MetricReader

#metric_store

Instance Method Summary collapse

Methods inherited from MetricReader

#collect, #register_meter_provider

Constructor Details

#initialize(aggregation_cardinality_limit: nil) ⇒ ConsoleMetricPullExporter

Returns a new instance of ConsoleMetricPullExporter.



15
16
17
18
 
# File 'lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb', line 15

def initialize(aggregation_cardinality_limit: nil)
  super
  @stopped = false
end

Instance Method Details

#export(metrics, timeout: nil) ⇒ Object

Prints each collected metric to stdout.



26
27
28
29
30
31
32
 
# File 'lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb', line 26

def export(metrics, timeout: nil)
  return FAILURE if @stopped

  Array(metrics).each { |metric| pp metric }

  SUCCESS
end

#force_flush(timeout: nil) ⇒ Object

No-op: there is nothing to flush for this exporter.



35
36
37
 
# File 'lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb', line 35

def force_flush(timeout: nil)
  SUCCESS
end

#pull ⇒ Object

Collects and exports the current metrics to the console.



21
22
23
 
# File 'lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb', line 21

def pull
  export(collect)
end

#shutdown(timeout: nil) ⇒ Object

Marks this exporter as stopped so subsequent exports fail.



40
41
42
43
 
# File 'lib/opentelemetry/sdk/metrics/export/console_metric_pull_exporter.rb', line 40

def shutdown(timeout: nil)
  @stopped = true
  SUCCESS
end