Class: Appsignal::Config::ConfigDSL

Inherits:
Object
  • Object
show all
Defined in:
lib/appsignal/config.rb

Overview

Configuration DSL for use in configuration blocks.

This class provides a Domain Specific Language for configuring AppSignal within the ‘Appsignal.configure` block. It provides getter and setter methods for all configuration options.

Examples:

Using the configuration DSL

Appsignal.configure do |config|
  config.name = "My App"
  config.active = true
  config.push_api_key = "your-api-key"
  config.ignore_actions = ["StatusController#health"]
end

See Also:

  • Ruby gem configuration https://docs.appsignal.com/ruby/configuration.html

String Configuration Options collapse

Boolean Configuration Options collapse

Array Configuration Options collapse

Float Configuration Options collapse

Instance Method Summary collapse

Instance Attribute Details

#active ⇒ Boolean

Returns Activate AppSignal for the loaded environment.

Returns:

  • (Boolean) —

    Activate AppSignal for the loaded environment




# File 'lib/appsignal/config.rb', line 788

#activejob_report_errors ⇒ String

Returns Error reporting mode for ActiveJob (“all”, “discard” or “none”).

Returns:

  • (String) —

    Error reporting mode for ActiveJob (“all”, “discard” or “none”)




# File 'lib/appsignal/config.rb', line 737

#bind_address ⇒ String

Returns The host to the agent binds to for its HTTP server.

Returns:

  • (String) —

    The host to the agent binds to for its HTTP server




# File 'lib/appsignal/config.rb', line 737

#ca_file_path ⇒ String

Returns Path to the CA certificate file.

Returns:

  • (String) —

    Path to the CA certificate file




# File 'lib/appsignal/config.rb', line 737

#cpu_count ⇒ Float

Returns CPU count override for metrics collection.

Returns:

  • (Float) —

    CPU count override for metrics collection




# File 'lib/appsignal/config.rb', line 880

#dns_servers ⇒ Array<String>

Returns Custom DNS servers to use.

Returns:

  • (Array<String>) —

    Custom DNS servers to use




# File 'lib/appsignal/config.rb', line 848

#enable_active_support_event_log_reporter ⇒ Boolean

Returns Configure whether ActiveSupport::EventReporter integration is enabled.

Returns:

  • (Boolean) —

    Configure whether ActiveSupport::EventReporter integration is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_allocation_tracking ⇒ Boolean

Returns Configure whether allocation tracking is enabled.

Returns:

  • (Boolean) —

    Configure whether allocation tracking is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_at_exit_reporter ⇒ Boolean

Returns Configure whether the at_exit reporter is enabled.

Returns:

  • (Boolean) —

    Configure whether the at_exit reporter is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_gvl_global_timer ⇒ Boolean

Returns Configure whether the GVL global timer instrumentationis enabled.

Returns:

  • (Boolean) —

    Configure whether the GVL global timer instrumentationis enabled




# File 'lib/appsignal/config.rb', line 788

#enable_gvl_waiting_threads ⇒ Boolean

Returns Configure whether GVL waiting threads instrumentation is enabled.

Returns:

  • (Boolean) —

    Configure whether GVL waiting threads instrumentation is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_host_metrics ⇒ Boolean

Returns Configure whether host metrics collection is enabled.

Returns:

  • (Boolean) —

    Configure whether host metrics collection is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_minutely_probes ⇒ Boolean

Returns Configure whether minutely probes are enabled.

Returns:

  • (Boolean) —

    Configure whether minutely probes are enabled




# File 'lib/appsignal/config.rb', line 788

#enable_nginx_metrics ⇒ Boolean

Returns Configure whether the agent’s NGINX metrics endpoint is enabled.

Returns:

  • (Boolean) —

    Configure whether the agent’s NGINX metrics endpoint is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_rails_error_reporter ⇒ Boolean

Returns Configure whether Rails error reporter integration is enabled.

Returns:

  • (Boolean) —

    Configure whether Rails error reporter integration is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_rake_performance_instrumentation ⇒ Boolean

Returns Configure whether Rake performance instrumentation is enabled.

Returns:

  • (Boolean) —

    Configure whether Rake performance instrumentation is enabled




# File 'lib/appsignal/config.rb', line 788

#enable_statsd ⇒ Boolean

Returns Configure whether the StatsD metrics endpoint on the agent is enabled.

Returns:

  • (Boolean) —

    Configure whether the StatsD metrics endpoint on the agent is enabled




# File 'lib/appsignal/config.rb', line 788

#endpoint ⇒ String

Returns Push API endpoint URL.

Returns:

  • (String) —

    Push API endpoint URL




# File 'lib/appsignal/config.rb', line 737

#files_world_accessible ⇒ Boolean

Returns Configure whether files created by AppSignal should be world accessible.

Returns:

  • (Boolean) —

    Configure whether files created by AppSignal should be world accessible




# File 'lib/appsignal/config.rb', line 788

#filter_metadata ⇒ Array<String>

Returns Metadata keys to filter from trace data.

Returns:

  • (Array<String>) —

    Metadata keys to filter from trace data




# File 'lib/appsignal/config.rb', line 848

#filter_parameters ⇒ Array<String>

Returns Keys of parameter to filter.

Returns:

  • (Array<String>) —

    Keys of parameter to filter




# File 'lib/appsignal/config.rb', line 848

#filter_session_data ⇒ Array<String>

Returns Request session data keys to filter.

Returns:

  • (Array<String>) —

    Request session data keys to filter




# File 'lib/appsignal/config.rb', line 848

#host_role ⇒ String

Returns Role of the host for grouping in metrics.

Returns:

  • (String) —

    Role of the host for grouping in metrics




# File 'lib/appsignal/config.rb', line 737

#hostname ⇒ String

Returns Override for the detected hostname.

Returns:

  • (String) —

    Override for the detected hostname




# File 'lib/appsignal/config.rb', line 737

#http_proxy ⇒ String

Returns HTTP proxy URL.

Returns:

  • (String) —

    HTTP proxy URL




# File 'lib/appsignal/config.rb', line 737

#ignore_actions ⇒ Array<String>

Returns Ignore traces by action names.

Returns:

  • (Array<String>) —

    Ignore traces by action names




# File 'lib/appsignal/config.rb', line 848

#ignore_errors ⇒ Array<String>

Returns List of errors to not report.

Returns:

  • (Array<String>) —

    List of errors to not report




# File 'lib/appsignal/config.rb', line 848

#ignore_logs ⇒ Array<String>

Returns Ignore log messages by substrings.

Returns:

  • (Array<String>) —

    Ignore log messages by substrings




# File 'lib/appsignal/config.rb', line 848

#ignore_namespaces ⇒ Array<String>

Returns Ignore traces by namespaces.

Returns:

  • (Array<String>) —

    Ignore traces by namespaces




# File 'lib/appsignal/config.rb', line 848

#instrument_http_rb ⇒ Boolean

Returns Configure whether to instrument requests made with the http.rb gem.

Returns:

  • (Boolean) —

    Configure whether to instrument requests made with the http.rb gem




# File 'lib/appsignal/config.rb', line 788

#instrument_net_http ⇒ Boolean

Returns Configure whether to instrument requests made with Net::HTTP.

Returns:

  • (Boolean) —

    Configure whether to instrument requests made with Net::HTTP




# File 'lib/appsignal/config.rb', line 788

#instrument_ownership ⇒ Boolean

Returns Configure whether to instrument the Ownership gem.

Returns:

  • (Boolean) —

    Configure whether to instrument the Ownership gem




# File 'lib/appsignal/config.rb', line 788

#instrument_redis ⇒ Boolean

Returns Configure whether to instrument Redis queries.

Returns:

  • (Boolean) —

    Configure whether to instrument Redis queries




# File 'lib/appsignal/config.rb', line 788

#instrument_sequel ⇒ Boolean

Returns Configure whether to instrument Sequel queries.

Returns:

  • (Boolean) —

    Configure whether to instrument Sequel queries




# File 'lib/appsignal/config.rb', line 788

#log ⇒ String

Returns Log destination (“file” or “stdout”).

Returns:

  • (String) —

    Log destination (“file” or “stdout”)




# File 'lib/appsignal/config.rb', line 737

#log_level ⇒ String

Returns AppSignal internal logger log level (“error”, “warn”, “info”, “debug”, “trace”).

Returns:

  • (String) —

    AppSignal internal logger log level (“error”, “warn”, “info”, “debug”, “trace”)




# File 'lib/appsignal/config.rb', line 737

#log_path ⇒ String

Returns Path to the log directory.

Returns:

  • (String) —

    Path to the log directory




# File 'lib/appsignal/config.rb', line 737

#logging_endpoint ⇒ String

Returns Endpoint for log transmission.

Returns:

  • (String) —

    Endpoint for log transmission




# File 'lib/appsignal/config.rb', line 737

#name ⇒ String

Returns The application name.

Returns:

  • (String) —

    The application name




# File 'lib/appsignal/config.rb', line 737

#nginx_port ⇒ String

Returns Port for Nginx metrics collection.

Returns:

  • (String) —

    Port for Nginx metrics collection




# File 'lib/appsignal/config.rb', line 737

#ownership_set_namespace ⇒ Boolean

Returns Configure whether the Ownership gem instrumentation should set namespace.

Returns:

  • (Boolean) —

    Configure whether the Ownership gem instrumentation should set namespace




# File 'lib/appsignal/config.rb', line 788

#push_api_key ⇒ String

Returns AppSignal Push API key.

Returns:

  • (String) —

    AppSignal Push API key




# File 'lib/appsignal/config.rb', line 737

#request_headers ⇒ Array<String>

Returns HTTP request headers to include in error reports.

Returns:

  • (Array<String>) —

    HTTP request headers to include in error reports




# File 'lib/appsignal/config.rb', line 848

#revision ⇒ String

Returns Application revision identifier.

Returns:

  • (String) —

    Application revision identifier




# File 'lib/appsignal/config.rb', line 737

#running_in_container ⇒ Boolean

Returns Configure whether the application is running in a container.

Returns:

  • (Boolean) —

    Configure whether the application is running in a container




# File 'lib/appsignal/config.rb', line 788

#send_environment_metadata ⇒ Boolean

Returns Configure whether to send environment metadata.

Returns:

  • (Boolean) —

    Configure whether to send environment metadata




# File 'lib/appsignal/config.rb', line 788

#send_params ⇒ Boolean

Returns Configure whether to send request parameters.

Returns:

  • (Boolean) —

    Configure whether to send request parameters




# File 'lib/appsignal/config.rb', line 788

#send_session_data ⇒ Boolean

Returns Configure whether to send request session data.

Returns:

  • (Boolean) —

    Configure whether to send request session data




# File 'lib/appsignal/config.rb', line 788

#sidekiq_report_errors ⇒ String

Returns Error reporting mode for Sidekiq (“all”, “discard” or “none”).

Returns:

  • (String) —

    Error reporting mode for Sidekiq (“all”, “discard” or “none”)




# File 'lib/appsignal/config.rb', line 737

#statsd_port ⇒ String

Returns Port for StatsD metrics.

Returns:

  • (String) —

    Port for StatsD metrics




# File 'lib/appsignal/config.rb', line 737

#working_directory_path ⇒ String

Returns Override for the agent working directory.

Returns:

  • (String) —

    Override for the agent working directory




# File 'lib/appsignal/config.rb', line 737

Instance Method Details

#activate_if_environment(*envs) ⇒ Boolean

Activates AppSignal if the current environment matches any of the given environments.

Examples:

Activate for production and staging

config.activate_if_environment(:production, :staging)

Parameters:

  • envs (Array<String, Symbol>) —

    List of environment names to activate for

Returns:

  • (Boolean) —

    true if AppSignal was activated, false otherwise



731
732
733
 
# File 'lib/appsignal/config.rb', line 731

def activate_if_environment(*envs)
  self.active = envs.map(&:to_s).include?(env)
end

#app_path ⇒ String

Returns the application’s root path.

Returns:

  • (String) —

    The root path of the application



704
705
706
 
# File 'lib/appsignal/config.rb', line 704

def app_path
  @config.root_path
end

#env ⇒ String

Returns the current environment name.

Returns:

  • (String) —

    The environment name (e.g., “production”, “development”)



711
712
713
 
# File 'lib/appsignal/config.rb', line 711

def env
  @config.env
end

#env?(given_env) ⇒ TrueClass, FalseClass

Returns true if the given environment name matches the loaded environment name.

Parameters:

  • given_env (String, Symbol)

Returns:

  • (TrueClass, FalseClass) 


720
721
722
 
# File 'lib/appsignal/config.rb', line 720

def env?(given_env)
  env == given_env.to_s
end