Class: Aeternitas::Configuration

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

Overview

Stores the global Aeternitas configuration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



75
76
77
78
79
80
81
82
 
# File 'lib/aeternitas.rb', line 75

def initialize
  @storage_adapter = Aeternitas::StorageAdapter::File
  @storage_adapter_config = {
    directory: defined?(Rails) ? Rails.root.join("storage", "aeternitas") : File.join(Dir.getwd, "aeternitas_data")
  }
  @metrics_enabled = false
  @metric_retention_period = 90.days
end

Instance Attribute Details

#metric_retention_period ⇒ Object

How long to keep metric data before it can be cleaned up. Default: 90.days



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aeternitas.rb', line 69

class Configuration
  attr_accessor :storage_adapter,
    :storage_adapter_config,
    :metrics_enabled,
    :metric_retention_period

  def initialize
    @storage_adapter = Aeternitas::StorageAdapter::File
    @storage_adapter_config = {
      directory: defined?(Rails) ? Rails.root.join("storage", "aeternitas") : File.join(Dir.getwd, "aeternitas_data")
    }
    @metrics_enabled = false
    @metric_retention_period = 90.days
  end

  # Creates a new StorageAdapter instance with the given options
  # @return [Aeternitas::StoragesAdapter] new storage adapter instance
  def get_storage_adapter
    @storage_adapter.new(storage_adapter_config)
  end
end

#metrics_enabled ⇒ Object

Whether to log metrics to the database. Default: false



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aeternitas.rb', line 69

class Configuration
  attr_accessor :storage_adapter,
    :storage_adapter_config,
    :metrics_enabled,
    :metric_retention_period

  def initialize
    @storage_adapter = Aeternitas::StorageAdapter::File
    @storage_adapter_config = {
      directory: defined?(Rails) ? Rails.root.join("storage", "aeternitas") : File.join(Dir.getwd, "aeternitas_data")
    }
    @metrics_enabled = false
    @metric_retention_period = 90.days
  end

  # Creates a new StorageAdapter instance with the given options
  # @return [Aeternitas::StoragesAdapter] new storage adapter instance
  def get_storage_adapter
    @storage_adapter.new(storage_adapter_config)
  end
end

#storage_adapter ⇒ Object

Storage adapter class. Default: StorageAdapter::File



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aeternitas.rb', line 69

class Configuration
  attr_accessor :storage_adapter,
    :storage_adapter_config,
    :metrics_enabled,
    :metric_retention_period

  def initialize
    @storage_adapter = Aeternitas::StorageAdapter::File
    @storage_adapter_config = {
      directory: defined?(Rails) ? Rails.root.join("storage", "aeternitas") : File.join(Dir.getwd, "aeternitas_data")
    }
    @metrics_enabled = false
    @metric_retention_period = 90.days
  end

  # Creates a new StorageAdapter instance with the given options
  # @return [Aeternitas::StoragesAdapter] new storage adapter instance
  def get_storage_adapter
    @storage_adapter.new(storage_adapter_config)
  end
end

#storage_adapter_config ⇒ Object

Storage adapter configuration, See StorageAdapter for configuration options



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/aeternitas.rb', line 69

class Configuration
  attr_accessor :storage_adapter,
    :storage_adapter_config,
    :metrics_enabled,
    :metric_retention_period

  def initialize
    @storage_adapter = Aeternitas::StorageAdapter::File
    @storage_adapter_config = {
      directory: defined?(Rails) ? Rails.root.join("storage", "aeternitas") : File.join(Dir.getwd, "aeternitas_data")
    }
    @metrics_enabled = false
    @metric_retention_period = 90.days
  end

  # Creates a new StorageAdapter instance with the given options
  # @return [Aeternitas::StoragesAdapter] new storage adapter instance
  def get_storage_adapter
    @storage_adapter.new(storage_adapter_config)
  end
end

Instance Method Details

#get_storage_adapter ⇒ Aeternitas::StoragesAdapter

Creates a new StorageAdapter instance with the given options

Returns:

  • (Aeternitas::StoragesAdapter) —

    new storage adapter instance



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

def get_storage_adapter
  @storage_adapter.new(storage_adapter_config)
end