Class: Temporalio::Runtime::PrometheusMetricsOptions

Inherits:
Object
  • Object
show all
Defined in:
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) ⇒ 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.



270
271
272
273
274
275
276
277
 
# File 'lib/temporalio/runtime.rb', line 270

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/temporalio/runtime.rb', line 262

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

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

Returns:

  • (Boolean) —

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/temporalio/runtime.rb', line 262

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

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.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/temporalio/runtime.rb', line 262

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

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.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/temporalio/runtime.rb', line 262

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