Class: Temporalio::Runtime::PrometheusMetricsOptions

Inherits:

Object

• Object
• Temporalio::Runtime::PrometheusMetricsOptions

Defined in:

lib/temporalio/runtime.rb

Overview

Options for exporting metrics to Prometheus.

Instance Attribute Summary

• #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.

• #unit_suffix ⇒ Boolean

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

Instance Method Summary

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

  Create Prometheus options.

Constructor Details

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

Create Prometheus options.

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

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

Instance Attribute Details

#bind_address ⇒ String

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

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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false
  )
    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:
    )
  end
end

#counters_total_suffix ⇒ Boolean

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

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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false
  )
    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:
    )
  end
end

#durations_as_seconds ⇒ Boolean

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

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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false
  )
    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:
    )
  end
end

#unit_suffix ⇒ Boolean

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

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.
  def initialize(
    bind_address:,
    counters_total_suffix: false,
    unit_suffix: false,
    durations_as_seconds: false
  )
    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:
    )
  end
end