Class: Temporalio::Runtime::PrometheusMetricsOptions

Inherits:

Object

Object
Temporalio::Runtime::PrometheusMetricsOptions

show all

Defined in:: lib/temporalio/runtime.rb

Overview

Options for exporting metrics to Prometheus.

Instance Attribute Summary collapse

#bind_address ⇒ String

Address to bind to for Prometheus endpoint.
#counters_total_suffix ⇒ Boolean

If ‘true`, all counters will include a `_total` suffix.
#durations_as_seconds ⇒ Boolean

Whether to use float seconds instead of integer milliseconds for durations.
#histogram_bucket_overrides ⇒ Hash<String, Array<Numeric>>^?

Override default histogram buckets.
#unit_suffix ⇒ Boolean

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

Instance Method Summary collapse

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

Create Prometheus options.

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.

# File 'lib/temporalio/runtime.rb', line 284

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.

# File 'lib/temporalio/runtime.rb', line 274

class PrometheusMetricsOptions
  # Create Prometheus options.
  #
  # @param bind_address [String] Address to bind to for Prometheus endpoint.
  # @param counters_total_suffix [Boolean] If `true`, all counters will include a `_total` suffix.
  # @param unit_suffix [Boolean] If `true`, all histograms will include the unit in their name as a suffix.
  # @param durations_as_seconds [Boolean] Whether to use float seconds instead of integer milliseconds for
  #   durations.
  # @param histogram_bucket_overrides [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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false,
    histogram_bucket_overrides: nil
  )
    super
  end

  # @!visibility private
  def _to_bridge
    # @type self: PrometheusMetricsOptions
    Internal::Bridge::Runtime::PrometheusMetricsOptions.new(
      bind_address:,
      counters_total_suffix:,
      unit_suffix:,
      durations_as_seconds:,
      histogram_bucket_overrides:
    )
  end
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.

# File 'lib/temporalio/runtime.rb', line 274

class PrometheusMetricsOptions
  # Create Prometheus options.
  #
  # @param bind_address [String] Address to bind to for Prometheus endpoint.
  # @param counters_total_suffix [Boolean] If `true`, all counters will include a `_total` suffix.
  # @param unit_suffix [Boolean] If `true`, all histograms will include the unit in their name as a suffix.
  # @param durations_as_seconds [Boolean] Whether to use float seconds instead of integer milliseconds for
  #   durations.
  # @param histogram_bucket_overrides [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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false,
    histogram_bucket_overrides: nil
  )
    super
  end

  # @!visibility private
  def _to_bridge
    # @type self: PrometheusMetricsOptions
    Internal::Bridge::Runtime::PrometheusMetricsOptions.new(
      bind_address:,
      counters_total_suffix:,
      unit_suffix:,
      durations_as_seconds:,
      histogram_bucket_overrides:
    )
  end
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.

# File 'lib/temporalio/runtime.rb', line 274

class PrometheusMetricsOptions
  # Create Prometheus options.
  #
  # @param bind_address [String] Address to bind to for Prometheus endpoint.
  # @param counters_total_suffix [Boolean] If `true`, all counters will include a `_total` suffix.
  # @param unit_suffix [Boolean] If `true`, all histograms will include the unit in their name as a suffix.
  # @param durations_as_seconds [Boolean] Whether to use float seconds instead of integer milliseconds for
  #   durations.
  # @param histogram_bucket_overrides [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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false,
    histogram_bucket_overrides: nil
  )
    super
  end

  # @!visibility private
  def _to_bridge
    # @type self: PrometheusMetricsOptions
    Internal::Bridge::Runtime::PrometheusMetricsOptions.new(
      bind_address:,
      counters_total_suffix:,
      unit_suffix:,
      durations_as_seconds:,
      histogram_bucket_overrides:
    )
  end
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.

# File 'lib/temporalio/runtime.rb', line 274

class PrometheusMetricsOptions
  # Create Prometheus options.
  #
  # @param bind_address [String] Address to bind to for Prometheus endpoint.
  # @param counters_total_suffix [Boolean] If `true`, all counters will include a `_total` suffix.
  # @param unit_suffix [Boolean] If `true`, all histograms will include the unit in their name as a suffix.
  # @param durations_as_seconds [Boolean] Whether to use float seconds instead of integer milliseconds for
  #   durations.
  # @param histogram_bucket_overrides [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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false,
    histogram_bucket_overrides: nil
  )
    super
  end

  # @!visibility private
  def _to_bridge
    # @type self: PrometheusMetricsOptions
    Internal::Bridge::Runtime::PrometheusMetricsOptions.new(
      bind_address:,
      counters_total_suffix:,
      unit_suffix:,
      durations_as_seconds:,
      histogram_bucket_overrides:
    )
  end
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.

# File 'lib/temporalio/runtime.rb', line 274

class PrometheusMetricsOptions
  # Create Prometheus options.
  #
  # @param bind_address [String] Address to bind to for Prometheus endpoint.
  # @param counters_total_suffix [Boolean] If `true`, all counters will include a `_total` suffix.
  # @param unit_suffix [Boolean] If `true`, all histograms will include the unit in their name as a suffix.
  # @param durations_as_seconds [Boolean] Whether to use float seconds instead of integer milliseconds for
  #   durations.
  # @param histogram_bucket_overrides [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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false,
    histogram_bucket_overrides: nil
  )
    super
  end

  # @!visibility private
  def _to_bridge
    # @type self: PrometheusMetricsOptions
    Internal::Bridge::Runtime::PrometheusMetricsOptions.new(
      bind_address:,
      counters_total_suffix:,
      unit_suffix:,
      durations_as_seconds:,
      histogram_bucket_overrides:
    )
  end
end

Class: Temporalio::Runtime::PrometheusMetricsOptions

Overview

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

Instance Attribute Details

#bind_address ⇒ String

#counters_total_suffix ⇒ Boolean

#durations_as_seconds ⇒ Boolean

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

#unit_suffix ⇒ Boolean

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

#bind_address ⇒ `String`

#counters_total_suffix ⇒ `Boolean`

#durations_as_seconds ⇒ `Boolean`

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

#unit_suffix ⇒ `Boolean`