Module: AppProfiler

Includes:
ActiveSupport::Deprecation::DeprecatedConstantAccessor
Defined in:
lib/app_profiler/server.rb,
lib/app_profiler.rb,
lib/app_profiler/backend.rb,
lib/app_profiler/profile.rb,
lib/app_profiler/railtie.rb,
lib/app_profiler/sampler.rb,
lib/app_profiler/version.rb,
lib/app_profiler/middleware.rb,
lib/app_profiler/parameters.rb,
lib/app_profiler/yarn/command.rb,
lib/app_profiler/sampler/config.rb,
lib/app_profiler/profile/vernier.rb,
lib/app_profiler/profile/stackprof.rb,
lib/app_profiler/request_parameters.rb,
lib/app_profiler/viewer/base_viewer.rb,
lib/app_profiler/backend/base_backend.rb,
lib/app_profiler/storage/base_storage.rb,
lib/app_profiler/storage/file_storage.rb,
lib/app_profiler/yarn/with_speedscope.rb,
lib/app_profiler/middleware/base_action.rb,
lib/app_profiler/middleware/view_action.rb,
lib/app_profiler/sampler/vernier_config.rb,
lib/app_profiler/backend/vernier_backend.rb,
lib/app_profiler/middleware/upload_action.rb,
lib/app_profiler/sampler/stackprof_config.rb,
lib/app_profiler/viewer/speedscope_viewer.rb,
lib/app_profiler/backend/stackprof_backend.rb,
lib/app_profiler/storage/google_cloud_storage.rb,
lib/app_profiler/viewer/speedscope_remote_viewer.rb,
lib/app_profiler/viewer/speedscope_remote_viewer/middleware.rb,
lib/app_profiler/viewer/speedscope_remote_viewer/base_middleware.rb

Overview

This module provides a means to start a golang-inspired profile server it is implemented using stdlib and Rack to avoid additional dependencies

Defined Under Namespace

Modules: Backend, Sampler, Server, Storage, Viewer, Yarn Classes: BackendError, BaseProfile, ConfigurationError, Middleware, Parameters, Railtie, RequestParameters, StackprofProfile, VernierProfile

Constant Summary collapse

DefaultProfileFormatter = 
proc do |upload|
  "#{AppProfiler.speedscope_host}#profileURL=#{upload.url}"
end
DefaultProfilePrefix = 
proc do
  Time.zone.now.strftime("%Y%m%d-%H%M%S")
end
VERSION = 
"0.2.4"

Class Method Summary collapse

Class Method Details

.after_process_queue=(handler) ⇒ Object 



196
197
198
199
200
201
202
 
# File 'lib/app_profiler.rb', line 196

def after_process_queue=(handler)
  if handler && (!handler.is_a?(Proc) || (handler.lambda? && handler.arity != 2))
    raise ArgumentError, "after_process_queue must be a proc or a lambda that accepts two arguments"
  end

  @@after_process_queue = handler # rubocop:disable Style/ClassVars
end

.backend ⇒ Object 



153
154
155
156
 
# File 'lib/app_profiler.rb', line 153

def backend
  @profiler_backend ||= Backend::StackprofBackend
  @profiler_backend.name
end

.backend=(new_backend) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/app_profiler.rb', line 104

def backend=(new_backend)
  return if new_backend == backend

  new_profiler_backend = backend_for(new_backend)

  if running?
    raise BackendError,
      "cannot change backend to #{new_backend} while #{backend} backend is running"
  end

  return if @profiler_backend == new_profiler_backend

  clear
  @profiler_backend = new_profiler_backend
end

.backend_for(backend_name) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/app_profiler.rb', line 142

def backend_for(backend_name)
  if vernier_supported? &&
      backend_name == AppProfiler::Backend::VernierBackend.name
    AppProfiler::Backend::VernierBackend
  elsif backend_name == AppProfiler::Backend::StackprofBackend.name
    AppProfiler::Backend::StackprofBackend
  else
    raise BackendError, "unknown backend #{backend_name}"
  end
end

.profile_data_header ⇒ Object 



172
173
174
 
# File 'lib/app_profiler.rb', line 172

def profile_data_header
  @@profile_data_header ||= profile_header.dup << "-Data" # rubocop:disable Style/ClassVars
end

.profile_enqueue_failure=(handler) ⇒ Object 



188
189
190
191
192
193
194
 
# File 'lib/app_profiler.rb', line 188

def profile_enqueue_failure=(handler)
  if handler && (!handler.is_a?(Proc) || (handler.lambda? && handler.arity != 1))
    raise ArgumentError, "profile_enqueue_failure must be a proc or a lambda that accepts one argument"
  end

  @@profile_enqueue_failure = handler # rubocop:disable Style/ClassVars
end

.profile_enqueue_success=(handler) ⇒ Object 



180
181
182
183
184
185
186
 
# File 'lib/app_profiler.rb', line 180

def profile_enqueue_success=(handler)
  if handler && (!handler.is_a?(Proc) || (handler.lambda? && handler.arity != 0))
    raise ArgumentError, "profile_enqueue_success must be proc or a lambda that accepts no argument"
  end

  @@profile_enqueue_success = handler # rubocop:disable Style/ClassVars
end

.profile_header=(profile_header) ⇒ Object 



162
163
164
165
166
 
# File 'lib/app_profiler.rb', line 162

def profile_header=(profile_header)
  @@profile_header = profile_header # rubocop:disable Style/ClassVars
  @@request_profile_header = nil    # rubocop:disable Style/ClassVars
  @@profile_data_header = nil       # rubocop:disable Style/ClassVars
end

.profile_sampler_enabled ⇒ Object 



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/app_profiler.rb', line 131

def profile_sampler_enabled
  return false unless defined?(@profile_sampler_enabled)

  @profile_sampler_enabled.is_a?(Proc) ? @profile_sampler_enabled.call : @profile_sampler_enabled
rescue => e
  logger.error(
    "[AppProfiler.profile_sampler_enabled] exception: #{e}, message: #{e.message}",
  )
  false
end

.profile_sampler_enabled=(value) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/app_profiler.rb', line 120

def profile_sampler_enabled=(value)
  if value.is_a?(Proc)
    raise ArgumentError,
      "profile_sampler_enabled must be a proc or a lambda that accepts no argument" if value.arity != 0
  else
    raise ArgumentError, "Must be TrueClass or FalseClass" unless [TrueClass, FalseClass].include?(value.class)
  end

  @profile_sampler_enabled = value
end

.profile_url(upload) ⇒ Object 



204
205
206
207
208
 
# File 'lib/app_profiler.rb', line 204

def profile_url(upload)
  return unless AppProfiler.profile_url_formatter

  AppProfiler.profile_url_formatter.call(upload)
end

.profile_url_formatter=(block) ⇒ Object 



176
177
178
 
# File 'lib/app_profiler.rb', line 176

def profile_url_formatter=(block)
  @@profile_url_formatter = block # rubocop:disable Style/ClassVars
end

.profiler ⇒ Object 



99
100
101
102
 
# File 'lib/app_profiler.rb', line 99

def profiler
  backend
  @backend ||= @profiler_backend.new
end

.request_profile_header ⇒ Object 



168
169
170
 
# File 'lib/app_profiler.rb', line 168

def request_profile_header
  @@request_profile_header ||= profile_header.upcase.tr("-", "_").prepend("HTTP_") # rubocop:disable Style/ClassVars
end

.run(*args, backend: nil, **kwargs, &block) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/app_profiler.rb', line 71

def run(*args, backend: nil, **kwargs, &block)
  orig_backend = self.backend
  begin
    self.backend = backend if backend
    profiler.run(*args, **kwargs, &block)
  rescue BackendError => e
    logger.error(
      "[AppProfiler.run] exception #{e} configuring backend #{backend}: #{e.message}",
    )
    yield
  end
ensure
  AppProfiler.backend = orig_backend
end

.running? ⇒ Boolean

Returns:

  • (Boolean) 


95
96
97
 
# File 'lib/app_profiler.rb', line 95

def running?
  @backend&.running?
end

.start(*args) ⇒ Object 



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

def start(*args)
  profiler.start(*args)
end

.stop ⇒ Object 



90
91
92
93
 
# File 'lib/app_profiler.rb', line 90

def stop
  profiler.stop
  profiler.results
end

.vernier_supported? ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
 
# File 'lib/app_profiler.rb', line 158

def vernier_supported?
  defined?(AppProfiler::Backend::VernierBackend.name)
end