Module: PgHero

Extended by:
Forwardable
Defined in:
lib/pghero.rb,
lib/pghero/stats.rb,
lib/pghero/engine.rb,
lib/pghero/version.rb,
lib/pghero/database.rb,
lib/pghero/connection.rb,
lib/pghero/query_stats.rb,
lib/pghero/space_stats.rb,
lib/pghero/methods/kill.rb,
lib/pghero/methods/basic.rb,
lib/pghero/methods/space.rb,
lib/pghero/methods/users.rb,
lib/pghero/methods/system.rb,
lib/pghero/methods/tables.rb,
lib/pghero/methods/explain.rb,
lib/pghero/methods/indexes.rb,
lib/pghero/methods/queries.rb,
lib/pghero/methods/settings.rb,
lib/pghero/methods/sequences.rb,
lib/pghero/methods/connections.rb,
lib/pghero/methods/constraints.rb,
lib/pghero/methods/maintenance.rb,
lib/pghero/methods/query_stats.rb,
lib/pghero/methods/replication.rb,
app/helpers/pg_hero/home_helper.rb,
lib/pghero/methods/suggested_indexes.rb,
app/controllers/pg_hero/home_controller.rb

Defined Under Namespace

Modules: HomeHelper, Methods Classes: Connection, Database, Engine, Error, HomeController, NotEnabled, QueryStats, SpaceStats, Stats

Constant Summary collapse

VERSION = 
"2.4.0"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.cache_hit_rate_threshold ⇒ Object

Returns the value of attribute cache_hit_rate_threshold.



39
40
41
 
# File 'lib/pghero.rb', line 39

def cache_hit_rate_threshold
  @cache_hit_rate_threshold
end

.config_path ⇒ Object

Returns the value of attribute config_path.



39
40
41
 
# File 'lib/pghero.rb', line 39

def config_path
  @config_path
end

.env ⇒ Object

Returns the value of attribute env.



39
40
41
 
# File 'lib/pghero.rb', line 39

def env
  @env
end

.explain_timeout_sec ⇒ Object

Returns the value of attribute explain_timeout_sec.



39
40
41
 
# File 'lib/pghero.rb', line 39

def explain_timeout_sec
  @explain_timeout_sec
end

.long_running_query_sec ⇒ Object

Returns the value of attribute long_running_query_sec.



39
40
41
 
# File 'lib/pghero.rb', line 39

def long_running_query_sec
  @long_running_query_sec
end

.show_migrations ⇒ Object

Returns the value of attribute show_migrations.



39
40
41
 
# File 'lib/pghero.rb', line 39

def show_migrations
  @show_migrations
end

.slow_query_calls ⇒ Object

Returns the value of attribute slow_query_calls.



39
40
41
 
# File 'lib/pghero.rb', line 39

def slow_query_calls
  @slow_query_calls
end

.slow_query_ms ⇒ Object

Returns the value of attribute slow_query_ms.



39
40
41
 
# File 'lib/pghero.rb', line 39

def slow_query_ms
  @slow_query_ms
end

.total_connections_threshold ⇒ Object

Returns the value of attribute total_connections_threshold.



39
40
41
 
# File 'lib/pghero.rb', line 39

def total_connections_threshold
  @total_connections_threshold
end

Class Method Details

.analyze_all(**options) ⇒ Object 



160
161
162
163
164
165
 
# File 'lib/pghero.rb', line 160

def analyze_all(**options)
  each_database do |database|
    next if database.replica?
    database.analyze_tables(**options)
  end
end

.autoindex_all(create: false, verbose: true) ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/pghero.rb', line 167

def autoindex_all(create: false, verbose: true)
  each_database do |database|
    puts "Autoindexing #{database.id}..." if verbose
    database.autoindex(create: create)
  end
end

.capture_query_stats(verbose: false) ⇒ Object 



145
146
147
148
149
150
151
 
# File 'lib/pghero.rb', line 145

def capture_query_stats(verbose: false)
  each_database do |database|
    next unless database.capture_query_stats?
    puts "Capturing query stats for #{database.id}..." if verbose
    database.capture_query_stats(raise_errors: true)
  end
end

.capture_space_stats(verbose: false) ⇒ Object 



153
154
155
156
157
158
 
# File 'lib/pghero.rb', line 153

def capture_space_stats(verbose: false)
  each_database do |database|
    puts "Capturing space stats for #{database.id}..." if verbose
    database.capture_space_stats
  end
end

.clean_query_stats ⇒ Object

delete previous stats go database by database to use an index stats for old databases are not cleaned up since we can’t use an index



181
182
183
184
185
 
# File 'lib/pghero.rb', line 181

def clean_query_stats
  each_database do |database|
    PgHero::QueryStats.where(database: database.id).where("captured_at < ?", 14.days.ago).delete_all
  end
end

.clean_space_stats ⇒ Object 



187
188
189
190
191
 
# File 'lib/pghero.rb', line 187

def clean_space_stats
  each_database do |database|
    PgHero::SpaceStats.where(database: database.id).where("captured_at < ?", 90.days.ago).delete_all
  end
end

.config ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/pghero.rb', line 90

def config
  @config ||= begin
    require "erb"
    require "yaml"

    path = config_path

    config_file_exists = File.exist?(path)

    config = YAML.load(ERB.new(File.read(path)).result) if config_file_exists
    config ||= {}

    if config[env]
      config[env]
    elsif config["databases"] # preferred format
      config
    elsif config_file_exists
      raise "Invalid config file"
    else
      databases = {}

      if !ENV["PGHERO_DATABASE_URL"] && spec_supported?
        ActiveRecord::Base.configurations.configs_for(env_name: env, include_replicas: true).each do |db|
          databases[db.spec_name] = {"spec" => db.spec_name}
        end
      end

      if databases.empty?
        databases["primary"] = {
          "url" => ENV["PGHERO_DATABASE_URL"] || ActiveRecord::Base.connection_config,
          "db_instance_identifier" => ENV["PGHERO_DB_INSTANCE_IDENTIFIER"]
        }
      end

      {
        "databases" => databases
      }
    end
  end
end

.databases ⇒ Object 



131
132
133
134
135
136
137
138
139
 
# File 'lib/pghero.rb', line 131

def databases
  @databases ||= begin
    Hash[
      config["databases"].map do |id, c|
        [id.to_sym, PgHero::Database.new(id, c)]
      end
    ]
  end
end

.password ⇒ Object

use method instead of attr_accessor to ensure this works if variable set after PgHero is loaded



82
83
84
 
# File 'lib/pghero.rb', line 82

def password
  @password ||= config["password"] || ENV["PGHERO_PASSWORD"]
end

.pretty_size(value) ⇒ Object 



174
175
176
 
# File 'lib/pghero.rb', line 174

def pretty_size(value)
  ActiveSupport::NumberHelper.number_to_human_size(value, precision: 3)
end

.primary_database ⇒ Object 



141
142
143
 
# File 'lib/pghero.rb', line 141

def primary_database
  databases.values.first
end

.spec_supported? ⇒ Boolean

private

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/pghero.rb', line 194

def spec_supported?
  ActiveRecord::VERSION::MAJOR >= 6
end

.stats_database_url ⇒ Object 



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

def stats_database_url
  @stats_database_url ||= config["stats_database_url"] || ENV["PGHERO_STATS_DATABASE_URL"]
end

.time_zone ⇒ Object 



70
71
72
 
# File 'lib/pghero.rb', line 70

def time_zone
  @time_zone || Time.zone
end

.time_zone=(time_zone) ⇒ Object 



66
67
68
 
# File 'lib/pghero.rb', line 66

def time_zone=(time_zone)
  @time_zone = time_zone.is_a?(ActiveSupport::TimeZone) ? time_zone : ActiveSupport::TimeZone[time_zone.to_s]
end

.username ⇒ Object

use method instead of attr_accessor to ensure this works if variable set after PgHero is loaded



76
77
78
 
# File 'lib/pghero.rb', line 76

def username
  @username ||= config["username"] || ENV["PGHERO_USERNAME"]
end