Module: TingYun::Configuration
- Defined in:
- lib/ting_yun/configuration.rb,
lib/ting_yun/configuration/manager.rb,
lib/ting_yun/configuration/dotted_hash.rb,
lib/ting_yun/configuration/yaml_source.rb,
lib/ting_yun/configuration/manual_source.rb,
lib/ting_yun/configuration/server_source.rb,
lib/ting_yun/configuration/default_source.rb,
lib/ting_yun/configuration/environment_source.rb
Defined Under Namespace
Classes: Boolean, DefaultSource, DottedHash, EnvironmentSource, Manager, ManualSource, ServerSource, YamlSource
Constant Summary collapse
- DEFAULTS =
{ :license_key => { :default => '', :public => true, :type => String, :allowed_from_server => false, :description => 'Your Ting Yun <a href="">license key</a>.' }, :enabled => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable the agent.' }, :'nbs.agent_enabled' => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable the agent.' }, :app_name => { :default => DefaultSource.app_name, :public => true, :type => String, :allowed_from_server => false, :description => 'Semicolon-delimited list of Naming your application.' }, :'nbs.auto_app_naming' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable to identify the application name' }, :'nbs.urls_captured' => { :default => '', :public => true, :type => String, :allowed_from_server => true, :description => '换行符分隔的URL正则表达式列表，缺省为采集全部URL。若指定此参数，则仅采集列表中的URL，忽略其它用户不关心URL ' }, :'nbs.ignored_params' => { :default => '', :public => true, :type => String, :allowed_from_server => true, :description => 'Enable or disable Specifies HTTP request parameters ' }, :"nbs.error_collector.enabled" => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable recording of traced errors and error count metrics.' }, :"nbs.error_collector.ignored_status_codes" => { :default => '', :public => true, :type => String, :allowed_from_server => true, :description => 'Enable or disable Specifies HTTP response code ' }, :"nbs.error_collector.ignored_errors" => { :default => '', :public => true, :type => String, :allowed_from_server => true, :description => 'Specify a comma-delimited list of error classes that the agent should ignore' }, :"nbs.error_collector.record_db_errors" => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => ' ' }, :'nbs.action_tracer.enabled' => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => '是否启用Web事务跟踪' }, :'nbs.action_tracer.action_threshold' => { :default => DefaultSource.action_tracer_action_threshold, :allow_nil => true, :public => true, :type => Fixnum, :allowed_from_server => true, :description => 'The agent will collect traces for action that exceed this time threshold (in millisecond). Specify a int value or <code><a href="">apdex_f</a></code>.' }, :'nbs.action_tracer.record_sql' => { :default => 'obfuscated', :public => true, :type => String, :allowed_from_server => true, :description => 'Obfuscation level for SQL queries reported in action trace nodes. Valid options are <code>obfuscated</code>, <code>raw</code>, <code>off</code>.' }, :'nbs.action_tracer.slow_sql' => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable collection of slow SQL queries.' }, :'nbs.action_tracer.slow_sql_threshold' => { :default => 500, :public => true, :type => Fixnum, :allowed_from_server => true, :description => 'The agent will collect traces for slow_sql that exceed this time threshold (in millisecond). Specify a int value or <code><a href="">apdex_f</a></code>.' }, :'nbs.action_tracer.explain_enabled' => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable the collection of explain plans in action traces. This setting will also apply to explain plans in Slow SQL traces if slow_sql.explain_enabled is not set separately.' }, :'nbs.action_tracer.explain_threshold' => { :default => 500, :public => true, :type => Fixnum, :allowed_from_server => true, :description => 'Threshold (in millisecond) above which the agent will collect explain plans. Relevant only when <code><a href="">explain_enabled</a></code> is true.' }, :'nbs.transaction_tracer.enabled' => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => '启用跨应用追踪' }, :'nbs.action_tracer.nbsua' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable to trace nbs web request' }, :'nbs.rum.enabled' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable page load timing (sometimes referred to as real user monitoring or RUM).' }, :'nbs.rum.script' => { :default => nil, :allow_nil => true, :public => true, :type => String, :allowed_from_server => true, :description => 'RUM Script URI' }, :'nbs.rum.mix_enabled' => { :default => false, :allow_nil => false, :public => true, :type => String, :allowed_from_server => true, :description => '混合嵌码' }, :'nbs.rum.sample_ratio' => { :default => 1, :public => true, :type => Fixnum, :allowed_from_server => true, :description => 'RUM per' }, :'nbs.action_tracer.obfuscated_sql_fields' => { :default => '', :allow_nil => true, :public => false, :type => String, :allowed_from_server => true, :description => 'obfuscate the special sql fields' }, :'nbs.action_tracer.stack_trace_threshold' => { :default => 500, :public => true, :type => Fixnum, :allowed_from_server => true, :description => 'Threshold (in millisecond) above which the agent will collect stack_trace.' }, :'nbs.external_url_params_captured' => { :default => '', :public => true, :type => String, :allowed_from_server => true, :description => 'Enable or disable Specifies External request parameters ' }, :agent_log_file_path => { :default => 'log/', :public => true, :type => String, :allowed_from_server => false, :description => 'Specifies a path to the audit log file ' }, :agent_log_file_name => { :default => 'tingyun_agent.log', :public => true, :type => String, :allowed_from_server => false, :description => 'log filename.' }, :agent_log_file_size => { :default => 500, :public => true, :type => Fixnum, :allowed_from_server => false, :description => "Create a new logfile once it reaches this value. and this value's unit is MB." }, :agent_log_file_number => { :default => 10, :public => true, :type => Fixnum, :allowed_from_server => false, :description => "The remaining number of log file, delete the earliest when more than this value." }, :agent_log_file_check_days => { :default => 7, :public => true, :type => Fixnum, :allowed_from_server => false, :description => "Check for create new logfile when reach days of this value." }, :config_search_paths => { :default => DefaultSource.config_search_paths, :public => false, :type => Array, :allowed_from_server => false, :description => "An array of candidate locations for the agent's configuration file." }, :dispatcher => { :default => DefaultSource.dispatcher, :public => false, :type => Symbol, :allowed_from_server => false, :description => 'Autodetected application component that reports metrics to Ting YUN.' }, :sync_startup => { :default => false, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'When set to true, forces a synchronous connection to the collector during application startup. For very short-lived processes, this helps ensure the has time to report.' }, :framework => { :default => DefaultSource.framework, :public => false, :type => Symbol, :allowed_from_server => false, :description => 'Autodetected application framework used to enable framework-specific functionality.' }, :'nbs.audit_mode' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'Enable or disable to log the transmission-date for developer' }, :agent_log_level => { :default => 'info', :public => true, :type => String, :allowed_from_server => false, :description => 'Log level for agent logging: fatal, error, warn, info, debug.' }, :proxy_host => { :default => nil, :allow_nil => true, :public => true, :type => String, :allowed_from_server => false, :description => 'Defines a host for communicating with Ting Yun via a proxy server.' }, :proxy_port => { :default => 8080, :allow_nil => true, :public => true, :type => Fixnum, :allowed_from_server => false, :description => 'Defines a port for communicating with Ting Yun via a proxy server.' }, :proxy_user => { :default => nil, :allow_nil => true, :public => true, :type => String, :allowed_from_server => false, :description => 'Defines a user for communicating with Ting Yun via a proxy server.' }, :proxy_password => { :default => nil, :allow_nil => true, :public => true, :type => String, :allowed_from_server => false, :exclude_from_reported_settings => true, :description => 'Defines a password for communicating with Ting Yun via a proxy server.' }, :host => { :default => 'redirect.networkbench.com', :public => false, :type => String, :allowed_from_server => false, :description => "URI for the Ting Yun data collection service." }, :port => { :default => DefaultSource.port, :allow_nil => true, :public => false, :type => Fixnum, :allowed_from_server => false, :description => 'Port for the Ting Yun data collection service.' }, :api_host => { :default => 'redirect.networkbench.com', :public => false, :type => String, :allowed_from_server => false, :description => 'API host for Ting Yun.' }, :api_port => { :default => value_of(:port), :public => false, :type => Fixnum, :allowed_from_server => false, :description => 'Port for the TingYun API host.' }, :disable_middleware_instrumentation => { :default => false, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'Defines whether the agent will wrap third-party middlewares in instrumentation (regardless of whether they are installed via Rack::Builder or Rails).' }, :disable_rack => { :default => false, :public => true, :type => Boolean, :dynamic_name => true, :allowed_from_server => false, :description => 'Defines whether the agent will hook into Rack::Builder\'s <code>to_app</code> method to find gems to instrument during application startup.' }, :disable_view_instrumentation => { :default => false, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'Enable or disable view instrumentation.' }, :keep_retrying => { :default => true, :public => false, :type => Boolean, :deprecated => true, :allowed_from_server => false, :description => 'Enable or disable retrying failed connections to the ting yun data collection service.' }, :force_reconnect => { :default => true, :public => false, :type => Boolean, :allowed_from_server => false, :description => 'Force a new connection to the server before running the worker loop. Creates a separate agent run and is recorded as a separate instance by the ting yun data collection service.' }, :aggressive_keepalive => { :default => true, :public => false, :type => Boolean, :allowed_from_server => false, :description => 'If true, attempt to keep the TCP connection to the collector alive between harvests.' }, :keep_alive_timeout => { :default => 60, :public => false, :type => Fixnum, :allowed_from_server => false, :description => 'Timeout for keep alive on TCP connection to collector if supported by Ruby version. Only used in conjunction when aggressive_keepalive is enabled.' }, :ca_bundle_path => { :default => nil, :allow_nil => true, :public => true, :type => String, :allowed_from_server => false, :description => "Manual override for the path to your local CA bundle. This CA bundle will be used to validate the SSL certificate presented by Ting Yun's data collection service." }, :ssl => { :default => true, :allow_nil => true, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'Enable or disable SSL for transmissions to the Ting Yun' }, :timeout => { :default => 2 * 60, # 2 minutes :public => true, :type => Fixnum, :allowed_from_server => false, :description => 'Maximum number of seconds to attempt to contact the collector.' }, :post_size_limit => { :default => 2 * 1024 * 1024, # 2MB :public => false, :type => Fixnum, :allowed_from_server => false, :description => 'Maximum number of bytes to send to the data collection service.' }, :data_report_period => { :default => 60, :public => false, :type => Fixnum, :allowed_from_server => false, :description => 'Number of seconds betwixt connections to the Ting Yun data collection service.' }, :'action_tracer.log_sql' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'Enable or disable(write into log file) collection of SQL queries.' }, :daemon_debug => { :default => false, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable(result-json contains key-id) debug mode' }, :urls_captured => { :default => '', :public => true, :type => String, :allowed_from_server => false, :description => 'Enable or disable Specifies url' }, :'nbs.auto_action_naming' => { :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable to use default name ' }, :'nbs.capture_params' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable the capture of HTTP request parameters to be attached to transaction traces and traced errors.' }, :config_path => { :default => DefaultSource.config_path, :public => true, :type => String, :allowed_from_server => false, :description => 'Path to <b>tingyun.yml</b>. When omitted the agent will check (in order) <b>config/tingyun.yml</b>, <b>tingyun.yml</b>, <b>$HOME/.tingyun/tingyun.yml</b> and <b>$HOME/tingyun.yml</b>.' }, :apdex_t => { :default => 500, :public => true, :type => Fixnum, :allowed_from_server => true, :deprecated => true, :description => 'millisecond' }, :'transaction_tracer.limit_segments' => { :default => 2000, :public => true, :type => Fixnum, :allowed_from_server => true, :description => 'Maximum number of transaction trace nodes to record in a single transaction trace.' }, :send_environment_info => { :default => true, :public => false, :type => Boolean, :allowed_from_server => false, :description => 'Enable or disable transmission of application environment information to the Ting Yun data collection service.' }, :normalize_json_string_encodings => { :default => DefaultSource.normalize_json_string_encodings, :public => false, :type => Boolean, :allowed_from_server => false, :description => 'Controls whether to normalize string encodings prior to serializing data for the collector to JSON.' }, :tingyunIdSecret => { :default => '', :public => true, :type => String, :allowed_from_server => true, :description => 'trace ID of crossing apps' }, :'naming.rules_enabled' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'Enable or disable of the naming.rules function' }, :'nbs.naming.rules' => { :default => "[]", :public => true, :type => String, :allowed_from_server => true, :description => 'defined name rule ' }, :disable_rake => { :default => true, :public => true, :type => Boolean, :allowed_from_server => false, :description => 'If true, disables Rake instrumentation.' }, :'rake.tasks' => { :default => [], :public => true, :type => Array, :allowed_from_server => false, :description => 'Specify an array of Rake tasks to automatically instrument.' }, :'rake.black.tasks' => { :default => [], :public => true, :type => Array, :allowed_from_server => false, :description => 'Specify an array of Rake tasks to automatically uninstrument.' }, :'nbs.transaction_tracer.thrift' =>{ :default => true, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable the thrift cross application feature' }, :restart_thread_in_children => { :default => true, :public => false, :type => Boolean, :allowed_from_server => false, :description => 'Controls whether to check on running a transaction whether to respawn the harvest thread.' }, :'nbs.quantile' => { :default => nil, :public => true, :type => String, :allowed_from_server => true, :description => 'Quantile' }, :'nbs.mq.enabled' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable the mq feature' }, :'nbs.exception.stack_enabled' => { :default => false, :public => true, :type => Boolean, :allowed_from_server => true, :description => 'Enable or disable the exception trace' } }.freeze
Class Method Summary collapse
- .get_name ⇒ Object
-
.value_of(key) ⇒ Object
Helper since default Procs are evaluated in the context of this module.