Module: NetworkResiliency

Extended by:
NetworkResiliency
Included in:
NetworkResiliency
Defined in:
lib/network_resiliency.rb,
lib/network_resiliency/stats.rb,
lib/network_resiliency/version.rb,
lib/network_resiliency/refinements.rb,
lib/network_resiliency/adapter/http.rb,
lib/network_resiliency/stats_engine.rb,
lib/network_resiliency/adapter/mysql.rb,
lib/network_resiliency/adapter/redis.rb,
lib/network_resiliency/adapter/faraday.rb,
lib/network_resiliency/adapter/postgres.rb

Defined Under Namespace

Modules: Adapter, Refinements, StatsEngine Classes: Stats

Constant Summary collapse

IP_ADDRESS_REGEX = 
Regexp.new(/\d{1,3}(\.\d{1,3}){3}/)
VERSION = 
"0.3.2"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#redis ⇒ Object

Returns the value of attribute redis.



19
20
21
 
# File 'lib/network_resiliency.rb', line 19

def redis
  @redis
end

#statsd ⇒ Object

Returns the value of attribute statsd.



19
20
21
 
# File 'lib/network_resiliency.rb', line 19

def statsd
  @statsd
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



21
22
23
24
25
 
# File 'lib/network_resiliency.rb', line 21

def configure
  yield self if block_given?

  start_syncing if redis
end

#disable! ⇒ Object 



76
77
78
79
80
81
82
83
 
# File 'lib/network_resiliency.rb', line 76

def disable!
  original = @enabled
  thread_state["enabled"] = false

  yield if block_given?
ensure
  thread_state.delete("enabled") if block_given?
end

#enable! ⇒ Object 



67
68
69
70
71
72
73
74
 
# File 'lib/network_resiliency.rb', line 67

def enable!
  original = @enabled
  thread_state["enabled"] = true

  yield if block_given?
ensure
  thread_state.delete("enabled") if block_given?
end

#enabled=(enabled) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'lib/network_resiliency.rb', line 59

def enabled=(enabled)
  unless [ true, false ].include?(enabled) || enabled.is_a?(Proc)
    raise ArgumentError
  end

  @enabled = enabled
end

#enabled?(adapter) ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/network_resiliency.rb', line 44

def enabled?(adapter)
  return thread_state["enabled"] if thread_state.key?("enabled")
  return true if @enabled.nil?

  if @enabled.is_a?(Proc)
    # prevent recursive calls
    enabled = @enabled
    disable! { !!enabled.call(adapter) }
  else
    @enabled
  end
rescue
  false
end

#ignore_destination?(adapter, action, destination) ⇒ Boolean

Returns:

  • (Boolean) 


155
156
157
158
 
# File 'lib/network_resiliency.rb', line 155

def ignore_destination?(adapter, action, destination)
  # filter raw IP addresses
  IP_ADDRESS_REGEX.match?(destination)
end

#patch(*adapters) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/network_resiliency.rb', line 27

def patch(*adapters)
  adapters.each do |adapter|
    case adapter
    when :http
      Adapter::HTTP.patch
    when :redis
      Adapter::Redis.patch
    when :mysql
      Adapter::Mysql.patch
    when :postgres
      Adapter::Postgres.patch
    else
      raise NotImplementedError
    end
  end
end

#record(adapter:, action:, destination:, duration:, error: nil) ⇒ Object

private



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/network_resiliency.rb', line 92

def record(adapter:, action:, destination:, duration:, error: nil)
  return if ignore_destination?(adapter, action, destination)

  NetworkResiliency.statsd&.distribution(
    "network_resiliency.#{action}",
    duration,
    tags: {
      adapter: adapter,
      destination: destination,
      error: error,
    }.compact,
  )

  NetworkResiliency.statsd&.distribution(
    "network_resiliency.#{action}.magnitude",
    duration.order_of_magnitude(ceil: true),
    tags: {
      adapter: adapter,
      destination: destination,
      error: error,
    }.compact,
  )

  key = [ adapter, action, destination ].join(":")
  StatsEngine.add(key, duration).tap do |stats|
    tags = {
      adapter: adapter,
      destination: destination,
      n: stats.n.order_of_magnitude,
    }

    NetworkResiliency.statsd&.distribution(
      "network_resiliency.#{action}.stats.n",
      stats.n,
      tags: tags,
    )

    NetworkResiliency.statsd&.distribution(
      "network_resiliency.#{action}.stats.avg",
      stats.avg,
      tags: tags,
    )

    NetworkResiliency.statsd&.distribution(
      "network_resiliency.#{action}.stats.stdev",
      stats.stdev,
      tags: tags,
    )
  end
rescue => e
  NetworkResiliency.statsd&.increment(
    "network_resiliency.error",
    tags: {
      method: __method__,
      type: e.class,
    },
  )

  warn "[ERROR] NetworkResiliency: #{e.class}: #{e.message}"
end

#reset ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/network_resiliency.rb', line 160

def reset
  @enabled = nil
  Thread.current["network_resiliency"] = nil
  StatsEngine.reset
  @sync_worker.kill if @sync_worker
end

#timestamp ⇒ Object 



85
86
87
88
 
# File 'lib/network_resiliency.rb', line 85

def timestamp
  # milliseconds
  Process.clock_gettime(Process::CLOCK_MONOTONIC) * 1_000
end