Module: Railswatch

Extended by:
Interface
Defined in:
lib/railswatch.rb,
lib/railswatch/utils.rb,
lib/railswatch/engine.rb,
lib/railswatch/pruner.rb,
lib/railswatch/version.rb,
lib/railswatch/interface.rb,
lib/railswatch/data_source.rb,
lib/railswatch/widgets/base.rb,
lib/railswatch/widgets/card.rb,
lib/railswatch/events/record.rb,
lib/railswatch/gems/rake_ext.rb,
lib/railswatch/widgets/chart.rb,
lib/railswatch/widgets/table.rb,
lib/railswatch/gems/grape_ext.rb,
lib/railswatch/gems/custom_ext.rb,
lib/railswatch/extensions/trace.rb,
lib/railswatch/gems/sidekiq_ext.rb,
lib/railswatch/rails/middleware.rb,
lib/railswatch/models/collection.rb,
lib/railswatch/models/base_record.rb,
lib/railswatch/models/rake_record.rb,
lib/railswatch/extensions/trace_db.rb,
lib/railswatch/models/event_record.rb,
lib/railswatch/models/grape_record.rb,
lib/railswatch/models/trace_record.rb,
lib/railswatch/rails/query_builder.rb,
lib/railswatch/reports/base_report.rb,
lib/railswatch/gems/delayed_job_ext.rb,
lib/railswatch/models/custom_record.rb,
lib/railswatch/reports/crash_report.rb,
lib/railswatch/reports/trace_report.rb,
lib/railswatch/models/request_record.rb,
lib/railswatch/models/sidekiq_record.rb,
lib/railswatch/widgets/crashes_table.rb,
lib/railswatch/models/resource_record.rb,
lib/railswatch/thread/current_request.rb,
lib/railswatch/widgets/requests_table.rb,
lib/railswatch/widgets/resource_chart.rb,
lib/railswatch/reports/overview_report.rb,
lib/railswatch/reports/requests_report.rb,
lib/railswatch/widgets/percentile_card.rb,
lib/railswatch/reports/breakdown_report.rb,
lib/railswatch/reports/resources_report.rb,
lib/railswatch/widgets/rake_tasks_table.rb,
lib/railswatch/widgets/throughput_chart.rb,
app/helpers/railswatch/railswatch_helper.rb,
lib/railswatch/models/application_record.rb,
lib/railswatch/models/delayed_job_record.rb,
lib/railswatch/reports/percentile_report.rb,
lib/railswatch/reports/throughput_report.rb,
lib/railswatch/widgets/delayed_job_table.rb,
lib/railswatch/reports/annotations_report.rb,
lib/railswatch/widgets/sidekiq_jobs_table.rb,
app/controllers/railswatch/base_controller.rb,
lib/railswatch/widgets/custom_events_table.rb,
lib/railswatch/widgets/response_time_chart.rb,
lib/railswatch/widgets/slow_requests_table.rb,
lib/railswatch/instrument/metrics_collector.rb,
lib/railswatch/reports/response_time_report.rb,
lib/railswatch/reports/slow_requests_report.rb,
lib/railswatch/widgets/grape_requests_table.rb,
lib/railswatch/widgets/recent_requests_table.rb,
lib/railswatch/reports/recent_requests_report.rb,
lib/railswatch/system_monitor/resources_monitor.rb,
app/controllers/railswatch/railswatch_controller.rb,
app/controllers/railswatch/concerns/csv_exportable.rb,
lib/generators/railswatch/install/install_generator.rb

Defined Under Namespace

Modules: Concerns, Events, Extensions, Gems, Instrument, Interface, Models, Rails, RailswatchHelper, Reports, SystemMonitor, Widgets Classes: BaseController, CurrentRequest, DataSource, Engine, InstallGenerator, Pruner, RailswatchController, Utils

Constant Summary collapse

FORMAT = 
'%Y%m%dT%H%M'
VERSION = 
'1.0.0'
SCHEMA = 
'1.0.0'
EVENTS_SCHEMA = 
'1.0.0'

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Interface

create_event

Class Attribute Details

._resource_monitor ⇒ Object

Returns the value of attribute _resource_monitor.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def _resource_monitor
  @_resource_monitor
end

._resource_monitor_enabled ⇒ Object

Returns the value of attribute _resource_monitor_enabled.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def _resource_monitor_enabled
  @_resource_monitor_enabled
end

._running_mode ⇒ Object

Returns the value of attribute _running_mode.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def _running_mode
  @_running_mode
end

.current_user_proc ⇒ Object

Returns the value of attribute current_user_proc.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def current_user_proc
  @current_user_proc
end

.custom_data_proc ⇒ Object

Returns the value of attribute custom_data_proc.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def custom_data_proc
  @custom_data_proc
end

.dashboard_charts ⇒ Object

Returns the value of attribute dashboard_charts.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def dashboard_charts
  @dashboard_charts
end

.database_connection_name ⇒ Object

Returns the value of attribute database_connection_name.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def database_connection_name
  @database_connection_name
end

.debug ⇒ Object

Returns the value of attribute debug.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def debug
  @debug
end

.duration ⇒ Object

Returns the value of attribute duration.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def duration
  @duration
end

.enabled ⇒ Object

Returns the value of attribute enabled.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def enabled
  @enabled
end

.home_link ⇒ Object

Returns the value of attribute home_link.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def home_link
  @home_link
end

.http_basic_authentication_enabled ⇒ Object

Returns the value of attribute http_basic_authentication_enabled.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def http_basic_authentication_enabled
  @http_basic_authentication_enabled
end

.http_basic_authentication_password ⇒ Object

Returns the value of attribute http_basic_authentication_password.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def http_basic_authentication_password
  @http_basic_authentication_password
end

.http_basic_authentication_user_name ⇒ Object

Returns the value of attribute http_basic_authentication_user_name.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def http_basic_authentication_user_name
  @http_basic_authentication_user_name
end

.ignore_trace_headers ⇒ Object

Returns the value of attribute ignore_trace_headers.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def ignore_trace_headers
  @ignore_trace_headers
end

.ignored_endpoints ⇒ Object

Returns the value of attribute ignored_endpoints.



148
149
150
 
# File 'lib/railswatch.rb', line 148

def ignored_endpoints
  @ignored_endpoints
end

.ignored_paths ⇒ Object

Returns the value of attribute ignored_paths.



148
149
150
 
# File 'lib/railswatch.rb', line 148

def ignored_paths
  @ignored_paths
end

.include_custom_events ⇒ Object

Returns the value of attribute include_custom_events.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def include_custom_events
  @include_custom_events
end

.include_rake_tasks ⇒ Object

Returns the value of attribute include_rake_tasks.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def include_rake_tasks
  @include_rake_tasks
end

.mount_at ⇒ Object

Returns the value of attribute mount_at.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def mount_at
  @mount_at
end

.recent_requests_limit ⇒ Object

Returns the value of attribute recent_requests_limit.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def recent_requests_limit
  @recent_requests_limit
end

.recent_requests_time_window ⇒ Object

Returns the value of attribute recent_requests_time_window.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def recent_requests_time_window
  @recent_requests_time_window
end

.retention ⇒ Object

Returns the value of attribute retention.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def retention
  @retention
end

.skip ⇒ Object

Returns the value of attribute skip.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def skip
  @skip
end

.skipable_rake_tasks ⇒ Object

Returns the value of attribute skipable_rake_tasks.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def skipable_rake_tasks
  @skipable_rake_tasks
end

.slow_requests_limit ⇒ Object

Returns the value of attribute slow_requests_limit.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def slow_requests_limit
  @slow_requests_limit
end

.slow_requests_threshold ⇒ Object

Returns the value of attribute slow_requests_threshold.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def slow_requests_threshold
  @slow_requests_threshold
end

.slow_requests_time_window ⇒ Object

Returns the value of attribute slow_requests_time_window.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def slow_requests_time_window
  @slow_requests_time_window
end

.system_monitor_duration ⇒ Object

Returns the value of attribute system_monitor_duration.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def system_monitor_duration
  @system_monitor_duration
end

.system_monitors ⇒ Object

Returns the value of attribute system_monitors.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def system_monitors
  @system_monitors
end

.url_options ⇒ Object

Returns the value of attribute url_options.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def url_options
  @url_options
end

.verify_access_proc ⇒ Object

Returns the value of attribute verify_access_proc.



117
118
119
 
# File 'lib/railswatch.rb', line 117

def verify_access_proc
  @verify_access_proc
end

Class Method Details

.log(message) ⇒ Object 



171
172
173
174
175
176
177
178
179
 
# File 'lib/railswatch.rb', line 171

def self.log(message)
  return unless Railswatch.debug

  if ::Rails.logger
    ::Rails.logger.debug(message)
  else
    puts(message)
  end
end

.measure ⇒ Object 



167
168
169
 
# File 'lib/railswatch.rb', line 167

def self.measure(...)
  Railswatch::Gems::CustomExtension.measure(...)
end

.prune! ⇒ Object 



163
164
165
 
# File 'lib/railswatch.rb', line 163

def self.prune!
  Railswatch::Pruner.call
end

.setup {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:

  • _self (Railswatch) —

    the object that the method was called on



159
160
161
 
# File 'lib/railswatch.rb', line 159

def self.setup
  yield(self)
end