Class: QaServer::Configuration
- Inherits:
-
Object
- Object
- QaServer::Configuration
- Defined in:
- lib/qa_server/configuration.rb
Instance Attribute Summary collapse
-
#display_historical_datatable ⇒ Object
writeonly
Displays a datatable of historical test data when true.
-
#display_historical_graph ⇒ Object
writeonly
Displays a graph of historical test data when true.
-
#display_performance_datatable ⇒ Object
writeonly
Displays a datatable of performance test data when true.
-
#display_performance_graph ⇒ Object
writeonly
Displays a graph of performance test data when true.
- #max_performance_cache_size ⇒ Object
-
#navmenu_extra_leftitems ⇒ Object
Additional menu items to add to the main navigation menu’s set of left justified menu items.
- #performance_datatable_max_threshold ⇒ Object
- #performance_datatable_warning_threshold ⇒ Object
- #performance_graph_load_color ⇒ Object
- #performance_normalization_color ⇒ Object
- #performance_retrieve_color ⇒ Object
- #performance_y_axis_max ⇒ Object
- #preferred_time_zone_name ⇒ Object
-
#suppress_logging_performance_details ⇒ Object
(also: #suppress_logging_performance_datails=)
writeonly
Performance data is gathered on every incoming query.
-
#suppress_performance_gathering ⇒ Object
writeonly
Performance data is gathered on every incoming query.
Instance Method Summary collapse
-
#disable_monitor_status_logging ⇒ Object
Disable logging of performance cache.
-
#disable_performance_cache_logging ⇒ Object
Disable logging of performance cache.
- #display_historical_datatable? ⇒ Boolean
- #display_historical_graph? ⇒ Boolean
- #display_performance_datatable? ⇒ Boolean
- #display_performance_graph? ⇒ Boolean
-
#enable_monitor_status_logging ⇒ Object
Enable logging of monitoring process.
-
#enable_performance_cache_logging ⇒ Object
Enable logging of performance cache.
-
#historical_datatable_default_time_period ⇒ Symbol
Historical datatable default time period.
-
#historical_datatable_default_time_period=(time_period) ⇒ Object
Historical datatable default time period.
-
#hour_offset_to_expire_cache ⇒ Integer
(also: #hour_offset_to_run_monitoring_tests)
Preferred hour to expire caches related to slow running calculations (e.g. monitoring tests, performance data).
-
#hour_offset_to_expire_cache=(offset) ⇒ Object
Set preferred hour to expire caches related to slow running calculations (e.g. monitoring tests, performance data).
-
#hour_offset_to_run_monitoring_tests=(offset) ⇒ Object
deprecated
Deprecated.
Use #hour_offset_to_expire_cache= instead.
-
#monitor_logger ⇒ Object
For internal use only.
-
#navmenu_presenter ⇒ Object
Get the one and only instance of the navigation menu presenter used to construct the main navigation menu.
-
#performance_cache ⇒ Object
For internal use only.
-
#performance_cache_logger ⇒ Object
For internal use only.
-
#performance_datatable_default_time_period ⇒ Symbol
Performance datatable default time period for calculating stats.
-
#performance_datatable_default_time_period=(time_period) ⇒ Object
Performance datatable default time period for calculating stats.
-
#performance_graph_default_time_period ⇒ Symbol
Performance graph default time period for all graphs.
-
#performance_graph_default_time_period=(time_period) ⇒ Object
Performance graph default time period for all graphs.
- #performance_tracker ⇒ Object
- #suppress_logging_performance_details? ⇒ Boolean (also: #suppress_logging_performance_datails, #suppress_logging_performance_datails?)
- #suppress_performance_gathering? ⇒ Boolean (also: #suppress_performance_gathering)
Instance Attribute Details
#display_historical_datatable=(value) ⇒ Object (writeonly)
Displays a datatable of historical test data when true
56 57 58 |
# File 'lib/qa_server/configuration.rb', line 56 def display_historical_datatable=(value) @display_historical_datatable = value end |
#display_historical_graph=(value) ⇒ Object (writeonly)
Displays a graph of historical test data when true
48 49 50 |
# File 'lib/qa_server/configuration.rb', line 48 def display_historical_graph=(value) @display_historical_graph = value end |
#display_performance_datatable=(value) ⇒ Object (writeonly)
Displays a datatable of performance test data when true
130 131 132 |
# File 'lib/qa_server/configuration.rb', line 130 def display_performance_datatable=(value) @display_performance_datatable = value end |
#display_performance_graph=(value) ⇒ Object (writeonly)
Displays a graph of performance test data when true
78 79 80 |
# File 'lib/qa_server/configuration.rb', line 78 def display_performance_graph=(value) @display_performance_graph = value end |
#max_performance_cache_size ⇒ Object
217 218 219 |
# File 'lib/qa_server/configuration.rb', line 217 def max_performance_cache_size @max_performance_cache_size ||= convert_size_to_bytes(ENV['MAX_PERFORMANCE_CACHE_SIZE']) || 32.megabytes end |
#navmenu_extra_leftitems ⇒ Object
Additional menu items to add to the main navigation menu’s set of left justified menu items
171 172 173 |
# File 'lib/qa_server/configuration.rb', line 171 def @navmenu_extra_leftitems end |
#performance_datatable_max_threshold ⇒ Object
153 154 155 |
# File 'lib/qa_server/configuration.rb', line 153 def performance_datatable_max_threshold @performance_datatable_max_threshold ||= 1500 end |
#performance_datatable_warning_threshold ⇒ Object
160 161 162 |
# File 'lib/qa_server/configuration.rb', line 160 def performance_datatable_warning_threshold @performance_datatable_warning_threshold ||= 1000 end |
#performance_graph_load_color ⇒ Object
102 103 104 |
# File 'lib/qa_server/configuration.rb', line 102 def performance_graph_load_color @performance_graph_load_color ||= '#E8DCD3' end |
#performance_normalization_color ⇒ Object
110 111 112 |
# File 'lib/qa_server/configuration.rb', line 110 def performance_normalization_color @performance_normalization_color ||= '#CCBE9F' end |
#performance_retrieve_color ⇒ Object
94 95 96 |
# File 'lib/qa_server/configuration.rb', line 94 def performance_retrieve_color @performance_retrieve_color ||= '#ABC3C9' end |
#performance_y_axis_max ⇒ Object
86 87 88 |
# File 'lib/qa_server/configuration.rb', line 86 def performance_y_axis_max @performance_y_axis_max ||= 4000 end |
#preferred_time_zone_name ⇒ Object
8 9 10 |
# File 'lib/qa_server/configuration.rb', line 8 def preferred_time_zone_name @preferred_time_zone_name ||= 'Eastern Time (US & Canada)' end |
#suppress_logging_performance_details=(value) ⇒ Object (writeonly) Also known as: suppress_logging_performance_datails=
Performance data is gathered on every incoming query. Basic stats are logged from QA. Full stats are logged by QaServer and can eat up logging realestate. To suppress the logging of details, set this config to true.
202 203 204 |
# File 'lib/qa_server/configuration.rb', line 202 def suppress_logging_performance_details=(value) @suppress_logging_performance_details = value end |
#suppress_performance_gathering=(value) ⇒ Object (writeonly)
Performance data is gathered on every incoming query. If load is high, this can have a negative performance impact and may need to be suppressed. Performance stats will not be gathered when this config is true.
191 192 193 |
# File 'lib/qa_server/configuration.rb', line 191 def suppress_performance_gathering=(value) @suppress_performance_gathering = value end |
Instance Method Details
#disable_monitor_status_logging ⇒ Object
Disable logging of performance cache
247 248 249 |
# File 'lib/qa_server/configuration.rb', line 247 def disable_monitor_status_logging monitor_logger.level = Logger::INFO end |
#disable_performance_cache_logging ⇒ Object
Disable logging of performance cache
232 233 234 |
# File 'lib/qa_server/configuration.rb', line 232 def disable_performance_cache_logging performance_cache_logger.level = Logger::INFO end |
#display_historical_datatable? ⇒ Boolean
57 58 59 60 |
# File 'lib/qa_server/configuration.rb', line 57 def display_historical_datatable? return @display_historical_datatable unless @display_historical_datatable.nil? @display_historical_datatable = true end |
#display_historical_graph? ⇒ Boolean
49 50 51 52 |
# File 'lib/qa_server/configuration.rb', line 49 def display_historical_graph? return @display_historical_graph unless @display_historical_graph.nil? @display_historical_graph = false end |
#display_performance_datatable? ⇒ Boolean
131 132 133 134 |
# File 'lib/qa_server/configuration.rb', line 131 def display_performance_datatable? return @display_performance_datatable unless @display_performance_datatable.nil? @display_performance_datatable = true end |
#display_performance_graph? ⇒ Boolean
79 80 81 82 |
# File 'lib/qa_server/configuration.rb', line 79 def display_performance_graph? return @display_performance_graph unless @display_performance_graph.nil? @display_performance_graph = false end |
#enable_monitor_status_logging ⇒ Object
Enable logging of monitoring process
242 243 244 |
# File 'lib/qa_server/configuration.rb', line 242 def enable_monitor_status_logging monitor_logger.level = Logger::DEBUG end |
#enable_performance_cache_logging ⇒ Object
Enable logging of performance cache
227 228 229 |
# File 'lib/qa_server/configuration.rb', line 227 def enable_performance_cache_logging performance_cache_logger.level = Logger::DEBUG end |
#historical_datatable_default_time_period ⇒ Symbol
Historical datatable default time period.
72 73 74 |
# File 'lib/qa_server/configuration.rb', line 72 def historical_datatable_default_time_period @historical_datatable_default_time_period ||= :year end |
#historical_datatable_default_time_period=(time_period) ⇒ Object
Historical datatable default time period.
65 66 67 68 |
# File 'lib/qa_server/configuration.rb', line 65 def historical_datatable_default_time_period=(time_period) raise ArgumentError, 'time_period must be one of :month, :year, or :all' unless [:month, :year, :all].include? time_period @historical_datatable_default_time_period = time_period end |
#hour_offset_to_expire_cache ⇒ Integer Also known as: hour_offset_to_run_monitoring_tests
Preferred hour to expire caches related to slow running calculations (e.g. monitoring tests, performance data)
25 26 27 |
# File 'lib/qa_server/configuration.rb', line 25 def hour_offset_to_expire_cache @hour_offset_to_expire_cache ||= 3 end |
#hour_offset_to_expire_cache=(offset) ⇒ Object
Set preferred hour to expire caches related to slow running calculations (e.g. monitoring tests, performance data)
18 19 20 21 |
# File 'lib/qa_server/configuration.rb', line 18 def hour_offset_to_expire_cache=(offset) raise ArgumentError, 'offset must be between 0 and 23' unless (0..23).cover? offset @hour_offset_to_expire_cache = offset end |
#hour_offset_to_run_monitoring_tests=(offset) ⇒ Object
Use #hour_offset_to_expire_cache= instead.
Set preferred hour to run monitoring tests (deprecated)
35 36 37 38 |
# File 'lib/qa_server/configuration.rb', line 35 def hour_offset_to_run_monitoring_tests=(offset) Deprecation.warn(QaServer, "hour_offset_to_run_monitoring_tests= is deprecated and will be removed from a future release (use #hour_offset_to_expire_cache= instead)") @hour_offset_to_expire_cache = offset end |
#monitor_logger ⇒ Object
For internal use only
252 253 254 |
# File 'lib/qa_server/configuration.rb', line 252 def monitor_logger @monitor_logger ||= Logger.new(ENV['MONITOR_LOG_PATH'] || File.join("log", "monitor.log")) end |
#navmenu_presenter ⇒ Object
Get the one and only instance of the navigation menu presenter used to construct the main navigation menu. To extend, set additional navigation menu items using #navmenu_extra_leftitems
175 176 177 178 179 180 |
# File 'lib/qa_server/configuration.rb', line 175 def return @navmenu_presenter if @navmenu_presenter.present? @navmenu_presenter ||= QaServer::NavmenuPresenter.new @navmenu_presenter.() @navmenu_presenter end |
#performance_cache ⇒ Object
For internal use only
222 223 224 |
# File 'lib/qa_server/configuration.rb', line 222 def performance_cache @performance_cache ||= QaServer::PerformanceCache.new end |
#performance_cache_logger ⇒ Object
For internal use only
237 238 239 |
# File 'lib/qa_server/configuration.rb', line 237 def performance_cache_logger @performance_cache_logger ||= Logger.new(ENV['PERFORMANCE_CACHE_LOG_PATH'] || File.join("log", "performance_cache.log")) end |
#performance_datatable_default_time_period ⇒ Symbol
Performance datatable default time period for calculating stats.
146 147 148 |
# File 'lib/qa_server/configuration.rb', line 146 def performance_datatable_default_time_period @performance_datatable_default_time_period ||= :year end |
#performance_datatable_default_time_period=(time_period) ⇒ Object
Performance datatable default time period for calculating stats.
139 140 141 142 |
# File 'lib/qa_server/configuration.rb', line 139 def performance_datatable_default_time_period=(time_period) raise ArgumentError, 'time_period must be one of :day, :month, :year, or :all' unless [:day, :month, :year, :all].include? time_period @performance_datatable_default_time_period = time_period end |
#performance_graph_default_time_period ⇒ Symbol
Performance graph default time period for all graphs. All authorities will show the graph for this time period on page load.
124 125 126 |
# File 'lib/qa_server/configuration.rb', line 124 def performance_graph_default_time_period @performance_graph_default_time_period ||= :month end |
#performance_graph_default_time_period=(time_period) ⇒ Object
Performance graph default time period for all graphs. All authorities will show the graph for this time period on page load.
117 118 119 120 |
# File 'lib/qa_server/configuration.rb', line 117 def performance_graph_default_time_period=(time_period) raise ArgumentError, 'time_period must be one of :day, :month, or :year' unless [:day, :month, :year].include? time_period @performance_graph_default_time_period = time_period end |
#performance_tracker ⇒ Object
182 183 184 185 186 |
# File 'lib/qa_server/configuration.rb', line 182 def performance_tracker @performance_tracker ||= File.new('log/performance.csv', 'w').tap do |f| f.puts('action, http request, load graph, normalization, TOTAL, data size, authority') end end |
#suppress_logging_performance_details? ⇒ Boolean Also known as: suppress_logging_performance_datails, suppress_logging_performance_datails?
203 204 205 206 |
# File 'lib/qa_server/configuration.rb', line 203 def suppress_logging_performance_details? return @suppress_logging_performance_details unless @suppress_logging_performance_details.nil? @suppress_logging_performance_details ||= false end |
#suppress_performance_gathering? ⇒ Boolean Also known as: suppress_performance_gathering
192 193 194 195 |
# File 'lib/qa_server/configuration.rb', line 192 def suppress_performance_gathering? return @suppress_performance_gathering unless @suppress_performance_gathering.nil? @suppress_performance_gathering ||= false end |