Class: Temporalio::Runtime::PrometheusMetricsOptions

Inherits:
Data
  • Object
show all
Defined in:
lib/temporalio/runtime.rb,
lib/temporalio/runtime.rb

Overview

Options for exporting metrics to Prometheus.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_address:, counters_total_suffix: false, unit_suffix: false, durations_as_seconds: false, histogram_bucket_overrides: nil) ⇒ PrometheusMetricsOptions

Create Prometheus options.

Parameters:

  • bind_address (String) —

    Address to bind to for Prometheus endpoint.

  • counters_total_suffix (Boolean) (defaults to: false) —

    If ‘true`, all counters will include a `_total` suffix.

  • unit_suffix (Boolean) (defaults to: false) —

    If ‘true`, all histograms will include the unit in their name as a suffix.

  • durations_as_seconds (Boolean) (defaults to: false) —

    Whether to use float seconds instead of integer milliseconds for durations.

  • histogram_bucket_overrides (Hash<String, Array<Numeric>>, nil) (defaults to: nil) —

    Override default histogram buckets. Key of the hash it the metric name, value is an array of floats for the set of buckets.



285
286
287
288
289
290
291
292
293
 
# File 'lib/temporalio/runtime.rb', line 285

def initialize(
  bind_address:,
  counters_total_suffix: false,
  unit_suffix: false,
  durations_as_seconds: false,
  histogram_bucket_overrides: nil
)
  super
end

Instance Attribute Details

#bind_address ⇒ String

Returns Address to bind to for Prometheus endpoint.

Returns:

  • (String) —

    Address to bind to for Prometheus endpoint.



275
276
277
 
# File 'lib/temporalio/runtime.rb', line 275

def bind_address
  @bind_address
end

#counters_total_suffix ⇒ Boolean

Returns If ‘true`, all counters will include a `_total` suffix.

Returns:

  • (Boolean) —

    If ‘true`, all counters will include a `_total` suffix.



275
276
277
 
# File 'lib/temporalio/runtime.rb', line 275

def counters_total_suffix
  @counters_total_suffix
end

#durations_as_seconds ⇒ Boolean

Returns Whether to use float seconds instead of integer milliseconds for durations.

Returns:

  • (Boolean) —

    Whether to use float seconds instead of integer milliseconds for durations.



275
276
277
 
# File 'lib/temporalio/runtime.rb', line 275

def durations_as_seconds
  @durations_as_seconds
end

#histogram_bucket_overrides ⇒ Hash<String, Array<Numeric>>?

Returns Override default histogram buckets. Key of the hash it the metric name, value is an array of floats for the set of buckets.

Returns:

  • (Hash<String, Array<Numeric>>, nil) —

    Override default histogram buckets. Key of the hash it the metric name, value is an array of floats for the set of buckets.



275
276
277
 
# File 'lib/temporalio/runtime.rb', line 275

def histogram_bucket_overrides
  @histogram_bucket_overrides
end

#unit_suffix ⇒ Boolean

Returns If ‘true`, all histograms will include the unit in their name as a suffix.

Returns:

  • (Boolean) —

    If ‘true`, all histograms will include the unit in their name as a suffix.



275
276
277
 
# File 'lib/temporalio/runtime.rb', line 275

def unit_suffix
  @unit_suffix
end