Class: Stripe::APIRequestor::StripeRequestMetrics

Inherits:

Object

• Object
• Stripe::APIRequestor::StripeRequestMetrics

Defined in:

lib/stripe/api_requestor.rb

Overview

StripeRequestMetrics tracks metadata to be reported to stripe for metrics collection

Instance Attribute Summary

• #request_duration_ms ⇒ Object

  Request duration in milliseconds.

• #request_id ⇒ Object

  The Stripe request ID of the response.

• #usage ⇒ Object

  list of names of tracked behaviors associated with this request.

Instance Method Summary

• #initialize(request_id, request_duration_ms, usage: []) ⇒ StripeRequestMetrics constructor

  A new instance of StripeRequestMetrics.

• #payload ⇒ Object

Constructor Details

#initialize(request_id, request_duration_ms, usage: []) ⇒ StripeRequestMetrics

Returns a new instance of StripeRequestMetrics.

# File 'lib/stripe/api_requestor.rb', line 1187

def initialize(request_id, request_duration_ms, usage: [])
  self.request_id = request_id
  self.request_duration_ms = request_duration_ms
  self.usage = usage
end

Instance Attribute Details

#request_duration_ms ⇒ Object

Request duration in milliseconds

# File 'lib/stripe/api_requestor.rb', line 1182

def request_duration_ms
  @request_duration_ms
end

#request_id ⇒ Object

The Stripe request ID of the response.

# File 'lib/stripe/api_requestor.rb', line 1179

def request_id
  @request_id
end

#usage ⇒ Object

list of names of tracked behaviors associated with this request

# File 'lib/stripe/api_requestor.rb', line 1185

def usage
  @usage
end

Instance Method Details

#payload ⇒ Object

# File 'lib/stripe/api_requestor.rb', line 1193

def payload
  ret = { request_id: request_id, request_duration_ms: request_duration_ms }
  ret[:usage] = usage if !usage.nil? && !usage.empty?
  ret
end