pghero 2.3.0 → 2.5.1

data/lib/pghero/database.rb

@@ -2,6 +2,7 @@ module PgHero
   class Database
     include Methods::Basic
     include Methods::Connections
+    include Methods::Constraints
     include Methods::Explain
     include Methods::Indexes
     include Methods::Kill
@@ -22,16 +23,17 @@ module PgHero
     def initialize(id, config)
       @id = id
       @config = config || {}
+
+      # preload model to ensure only one connection pool
+      # this doesn't actually start any connections
+      @adapter_checked = false
+      @connection_model = build_connection_model
     end
 
     def name
       @name ||= @config["name"] || id.titleize
     end
 
-    def db_instance_identifier
-      @db_instance_identifier ||= @config["db_instance_identifier"]
-    end
-
     def capture_query_stats?
       config["capture_query_stats"] != false
     end
@@ -64,24 +66,106 @@ module PgHero
       (config["index_bloat_bytes"] || PgHero.config["index_bloat_bytes"] || 100.megabytes).to_i
     end
 
-    private
+    def aws_access_key_id
+      config["aws_access_key_id"] || PgHero.config["aws_access_key_id"] || ENV["PGHERO_ACCESS_KEY_ID"] || ENV["AWS_ACCESS_KEY_ID"]
+    end
 
-    def connection_model
-      @connection_model ||= begin
-        url = config["url"]
-        Class.new(PgHero::Connection) do
-          def self.name
-            "PgHero::Connection::Database#{object_id}"
+    def aws_secret_access_key
+      config["aws_secret_access_key"] || PgHero.config["aws_secret_access_key"] || ENV["PGHERO_SECRET_ACCESS_KEY"] || ENV["AWS_SECRET_ACCESS_KEY"]
+    end
+
+    def aws_region
+      config["aws_region"] || PgHero.config["aws_region"] || ENV["PGHERO_REGION"] || ENV["AWS_REGION"] || (defined?(Aws) && Aws.config[:region]) || "us-east-1"
+    end
+
+    # environment variable is only used if no config file
+    def aws_db_instance_identifier
+      @aws_db_instance_identifier ||= config["aws_db_instance_identifier"] || config["db_instance_identifier"]
+    end
+
+    # environment variable is only used if no config file
+    def gcp_database_id
+      @gcp_database_id ||= config["gcp_database_id"]
+    end
+
+    # environment variable is only used if no config file
+    def azure_resource_id
+      @azure_resource_id ||= config["azure_resource_id"]
+    end
+
+    # must check keys for booleans
+    def filter_data
+      unless defined?(@filter_data)
+        @filter_data =
+          if config.key?("filter_data")
+            config["filter_data"]
+          elsif PgHero.config.key?("filter_data")
+            PgHero.config.key?("filter_data")
+          else
+            PgHero.filter_data
           end
-          case url
-          when String
-            url = "#{url}#{url.include?("?") ? "&" : "?"}connect_timeout=5" unless url.include?("connect_timeout=")
-          when Hash
-            url[:connect_timeout] ||= 5
+
+        if @filter_data
+          begin
+            require "pg_query"
+          rescue LoadError
+            raise Error, "pg_query required for filter_data"
           end
-          establish_connection url if url
         end
       end
+
+      @filter_data
+    end
+
+    # TODO remove in next major version
+    alias_method :access_key_id, :aws_access_key_id
+    alias_method :secret_access_key, :aws_secret_access_key
+    alias_method :region, :aws_region
+    alias_method :db_instance_identifier, :aws_db_instance_identifier
+
+    private
+
+    # check adapter lazily
+    def connection_model
+      unless @adapter_checked
+        # rough check for Postgres adapter
+        # keep this message generic so it's useful
+        # when empty url set in Docker image pghero.yml
+        unless @connection_model.connection.adapter_name =~ /postg/i
+          raise Error, "Invalid connection URL"
+        end
+        @adapter_checked = true
+      end
+
+      @connection_model
+    end
+
+    # just return the model
+    # do not start a connection
+    def build_connection_model
+      url = config["url"]
+
+      # resolve spec
+      if !url && config["spec"]
+        raise Error, "Spec requires Rails 6+" unless PgHero.spec_supported?
+        resolved = ActiveRecord::Base.configurations.configs_for(env_name: PgHero.env, spec_name: config["spec"], include_replicas: true)
+        raise Error, "Spec not found: #{config["spec"]}" unless resolved
+        url = resolved.config
+      end
+
+      Class.new(PgHero::Connection) do
+        def self.name
+          "PgHero::Connection::Database#{object_id}"
+        end
+
+        case url
+        when String
+          url = "#{url}#{url.include?("?") ? "&" : "?"}connect_timeout=5" unless url.include?("connect_timeout=")
+        when Hash
+          url[:connect_timeout] ||= 5
+        end
+        establish_connection url if url
+      end
     end
   end
 end

data/lib/pghero/methods/basic.rb

@@ -32,13 +32,34 @@ module PgHero
 
       private
 
-      def select_all(sql, conn = nil)
+      def select_all(sql, conn: nil, query_columns: [])
         conn ||= connection
         # squish for logs
         retries = 0
         begin
           result = conn.select_all(add_source(squish(sql)))
-          result.map { |row| Hash[row.map { |col, val| [col.to_sym, result.column_types[col].send(:cast_value, val)] }] }
+          result = result.map { |row| Hash[row.map { |col, val| [col.to_sym, result.column_types[col].send(:cast_value, val)] }] }
+          if filter_data
+            query_columns.each do |column|
+              result.each do |row|
+                begin
+                  row[column] = PgQuery.normalize(row[column])
+                rescue PgQuery::ParseError
+                  # try replacing "interval $1" with "$1::interval"
+                  # see https://github.com/lfittl/pg_query/issues/169 for more info
+                  # this is not ideal since it changes the query slightly
+                  # we could skip normalization
+                  # but this has a very small chance of data leakage
+                  begin
+                    row[column] = PgQuery.normalize(row[column].gsub(/\binterval\s+(\$\d+)\b/i, "\\1::interval"))
+                  rescue PgQuery::ParseError
+                    row[column] = "<unable to filter data>"
+                  end
+                end
+              end
+            end
+          end
+          result
         rescue ActiveRecord::StatementInvalid => e
           # fix for random internal errors
           if e.message.include?("PG::InternalError") && retries < 2
@@ -51,8 +72,8 @@ module PgHero
         end
       end
 
-      def select_all_stats(sql)
-        select_all(sql, stats_connection)
+      def select_all_stats(sql, **options)
+        select_all(sql, **options, conn: stats_connection)
       end
 
       def select_all_size(sql)
@@ -63,12 +84,12 @@ module PgHero
         result
       end
 
-      def select_one(sql, conn = nil)
-        select_all(sql, conn).first.values.first
+      def select_one(sql, conn: nil)
+        select_all(sql, conn: conn).first.values.first
       end
 
       def select_one_stats(sql)
-        select_one(sql, stats_connection)
+        select_one(sql, conn: stats_connection)
       end
 
       def execute(sql)

data/lib/pghero/methods/connections.rb

@@ -1,6 +1,41 @@
 module PgHero
   module Methods
     module Connections
+      def connections
+        if server_version_num >= 90500
+          select_all <<-SQL
+            SELECT
+              pg_stat_activity.pid,
+              datname AS database,
+              usename AS user,
+              application_name AS source,
+              client_addr AS ip,
+              state,
+              ssl
+            FROM
+              pg_stat_activity
+            LEFT JOIN
+              pg_stat_ssl ON pg_stat_activity.pid = pg_stat_ssl.pid
+            ORDER BY
+              pg_stat_activity.pid
+          SQL
+        else
+          select_all <<-SQL
+            SELECT
+              pid,
+              datname AS database,
+              usename AS user,
+              application_name AS source,
+              client_addr AS ip,
+              state
+            FROM
+              pg_stat_activity
+            ORDER BY
+              pid
+          SQL
+        end
+      end
+
       def total_connections
         select_one("SELECT COUNT(*) FROM pg_stat_activity")
       end

data/lib/pghero/methods/constraints.rb

@@ -0,0 +1,30 @@
+module PgHero
+  module Methods
+    module Constraints
+      # referenced fields can be nil
+      # as not all constraints are foreign keys
+      def invalid_constraints
+        select_all <<-SQL
+          SELECT
+            nsp.nspname AS schema,
+            rel.relname AS table,
+            con.conname AS name,
+            fnsp.nspname AS referenced_schema,
+            frel.relname AS referenced_table
+          FROM
+            pg_catalog.pg_constraint con
+          INNER JOIN
+            pg_catalog.pg_class rel ON rel.oid = con.conrelid
+          LEFT JOIN
+            pg_catalog.pg_class frel ON frel.oid = con.confrelid
+          LEFT JOIN
+            pg_catalog.pg_namespace nsp ON nsp.oid = con.connamespace
+          LEFT JOIN
+            pg_catalog.pg_namespace fnsp ON fnsp.oid = frel.relnamespace
+          WHERE
+            con.convalidated = 'f'
+        SQL
+      end
+    end
+  end
+end

data/lib/pghero/methods/indexes.rb

@@ -195,7 +195,7 @@ module PgHero
             FROM
               pg_index
             JOIN
-              pg_class ON pg_class.oid=pg_index.indexrelid
+              pg_class ON pg_class.oid = pg_index.indexrelid
             JOIN
               pg_namespace ON pg_namespace.oid = pg_class.relnamespace
             JOIN

data/lib/pghero/methods/maintenance.rb

@@ -57,7 +57,9 @@ module PgHero
             last_vacuum,
             last_autovacuum,
             last_analyze,
-            last_autoanalyze
+            last_autoanalyze,
+            n_dead_tup AS dead_rows,
+            n_live_tup AS live_rows
           FROM
             pg_stat_user_tables
           ORDER BY

data/lib/pghero/methods/queries.rb

@@ -2,7 +2,7 @@ module PgHero
   module Methods
     module Queries
       def running_queries(min_duration: nil, all: false)
-        select_all <<-SQL
+        query = <<-SQL
           SELECT
             pid,
             state,
@@ -24,6 +24,8 @@ module PgHero
           ORDER BY
             COALESCE(query_start, xact_start) DESC
         SQL
+
+        select_all(query, query_columns: [:query])
       end
 
       def long_running_queries
@@ -33,7 +35,7 @@ module PgHero
       # from https://wiki.postgresql.org/wiki/Lock_Monitoring
       # and https://big-elephants.com/2013-09/exploring-query-locks-in-postgres/
       def blocked_queries
-        select_all <<-SQL
+        query = <<-SQL
           SELECT
             COALESCE(blockingl.relation::regclass::text,blockingl.locktype) as locked_item,
             blockeda.pid AS blocked_pid,
@@ -65,6 +67,8 @@ module PgHero
           ORDER BY
             blocked_duration DESC
         SQL
+
+        select_all(query, query_columns: [:blocked_query, :current_or_recent_query_in_blocking_process])
       end
     end
   end

data/lib/pghero/methods/query_stats.rb

@@ -2,7 +2,7 @@ module PgHero
   module Methods
     module QueryStats
       def query_stats(historical: false, start_at: nil, end_at: nil, min_average_time: nil, min_calls: nil, **options)
-        current_query_stats = historical && end_at && end_at < Time.now ? [] : current_query_stats(options)
+        current_query_stats = historical && end_at && end_at < Time.now ? [] : current_query_stats(**options)
         historical_query_stats = historical && historical_query_stats_enabled? ? historical_query_stats(start_at: start_at, end_at: end_at, **options) : []
 
         query_stats = combine_query_stats((current_query_stats + historical_query_stats).group_by { |q| [q[:query_hash], q[:user]] })
@@ -166,7 +166,7 @@ module PgHero
         if query_stats_enabled?
           limit ||= 100
           sort ||= "total_minutes"
-          select_all <<-SQL
+          query = <<-SQL
             WITH query_stats AS (
               SELECT
                 LEFT(query, 10000) AS query,
@@ -200,6 +200,11 @@ module PgHero
               #{quote_table_name(sort)} DESC
             LIMIT #{limit.to_i}
           SQL
+
+          # we may be able to skip query_columns
+          # in more recent versions of Postgres
+          # as pg_stat_statements should be already normalized
+          select_all(query, query_columns: [:query])
         else
           raise NotEnabled, "Query stats not enabled"
         end
@@ -208,7 +213,7 @@ module PgHero
       def historical_query_stats(sort: nil, start_at: nil, end_at: nil, query_hash: nil)
         if historical_query_stats_enabled?
           sort ||= "total_minutes"
-          select_all_stats <<-SQL
+          query = <<-SQL
             WITH query_stats AS (
               SELECT
                 #{supports_query_hash? ? "query_hash" : "md5(query)"} AS query_hash,
@@ -244,6 +249,10 @@ module PgHero
               #{quote_table_name(sort)} DESC
             LIMIT 100
           SQL
+
+          # we can skip query_columns if all stored data is normalized
+          # for now, assume it's not
+          select_all_stats(query, query_columns: [:query, :explainable_query])
         else
           raise NotEnabled, "Historical query stats not enabled"
         end

data/lib/pghero/methods/suggested_indexes.rb

@@ -48,7 +48,7 @@ module PgHero
       def suggested_indexes(suggested_indexes_by_query: nil, **options)
         indexes = []
 
-        (suggested_indexes_by_query || self.suggested_indexes_by_query(options)).select { |_s, i| i[:found] && !i[:covering_index] }.group_by { |_s, i| i[:index] }.each do |index, group|
+        (suggested_indexes_by_query || self.suggested_indexes_by_query(**options)).select { |_s, i| i[:found] && !i[:covering_index] }.group_by { |_s, i| i[:index] }.each do |index, group|
           details = {}
           group.map(&:second).each do |g|
             details = details.except(:index).deep_merge(g)

data/lib/pghero/methods/system.rb

@@ -1,31 +1,46 @@
 module PgHero
   module Methods
     module System
+      def system_stats_enabled?
+        !system_stats_provider.nil?
+      end
+
+      # TODO remove defined checks in 3.0
+      def system_stats_provider
+        if aws_db_instance_identifier && (defined?(Aws) || defined?(AWS))
+          :aws
+        elsif gcp_database_id
+          :gcp
+        elsif azure_resource_id
+          :azure
+        end
+      end
+
       def cpu_usage(**options)
-        rds_stats("CPUUtilization", options)
+        system_stats(:cpu, **options)
       end
 
       def connection_stats(**options)
-        rds_stats("DatabaseConnections", options)
+        system_stats(:connections, **options)
       end
 
       def replication_lag_stats(**options)
-        rds_stats("ReplicaLag", options)
+        system_stats(:replication_lag, **options)
       end
 
       def read_iops_stats(**options)
-        rds_stats("ReadIOPS", options)
+        system_stats(:read_iops, **options)
       end
 
       def write_iops_stats(**options)
-        rds_stats("WriteIOPS", options)
+        system_stats(:write_iops, **options)
       end
 
       def free_space_stats(**options)
-        rds_stats("FreeStorageSpace", options)
+        system_stats(:free_space, **options)
       end
 
-      def rds_stats(metric_name, duration: nil, period: nil, offset: nil)
+      def rds_stats(metric_name, duration: nil, period: nil, offset: nil, series: false)
         if system_stats_enabled?
           aws_options = {region: region}
           if access_key_id
@@ -43,16 +58,14 @@ module PgHero
           duration = (duration || 1.hour).to_i
           period = (period || 1.minute).to_i
           offset = (offset || 0).to_i
-
-          end_time = (Time.now - offset)
-          # ceil period
-          end_time = Time.at((end_time.to_f / period).ceil * period)
+          end_time = Time.at(((Time.now - offset).to_f / period).ceil * period)
+          start_time = end_time - duration
 
           resp = client.get_metric_statistics(
             namespace: "AWS/RDS",
             metric_name: metric_name,
-            dimensions: [{name: "DBInstanceIdentifier", value: db_instance_identifier}],
-            start_time: (end_time - duration).iso8601,
+            dimensions: [{name: "DBInstanceIdentifier", value: aws_db_instance_identifier}],
+            start_time: start_time.iso8601,
             end_time: end_time.iso8601,
             period: period,
             statistics: ["Average"]
@@ -61,30 +74,213 @@ module PgHero
           resp[:datapoints].sort_by { |d| d[:timestamp] }.each do |d|
             data[d[:timestamp]] = d[:average]
           end
+
+          add_missing_data(data, start_time, end_time, period) if series
+
           data
         else
           raise NotEnabled, "System stats not enabled"
         end
       end
 
-      def system_stats_enabled?
-        !!((defined?(Aws) || defined?(AWS)) && db_instance_identifier)
+      def azure_stats(metric_name, duration: nil, period: nil, offset: nil, series: false)
+        # TODO DRY with RDS stats
+        duration = (duration || 1.hour).to_i
+        period = (period || 1.minute).to_i
+        offset = (offset || 0).to_i
+        end_time = Time.at(((Time.now - offset).to_f / period).ceil * period)
+        start_time = end_time - duration
+
+        interval =
+          case period
+          when 60
+            "PT1M"
+          when 300
+            "PT5M"
+          when 900
+            "PT15M"
+          when 1800
+            "PT30M"
+          when 3600
+            "PT1H"
+          else
+            raise Error, "Unsupported period"
+          end
+
+        client = Azure::Monitor::Profiles::Latest::Mgmt::Client.new
+        timespan = "#{start_time.iso8601}/#{end_time.iso8601}"
+        results = client.metrics.list(
+          azure_resource_id,
+          metricnames: metric_name,
+          aggregation: "Average",
+          timespan: timespan,
+          interval: interval
+        )
+
+        data = {}
+        result = results.value.first
+        if result
+          result.timeseries.first.data.each do |point|
+            data[point.time_stamp.to_time] = point.average
+          end
+        end
+
+        add_missing_data(data, start_time, end_time, period) if series
+
+        data
       end
 
-      def access_key_id
-        ENV["PGHERO_ACCESS_KEY_ID"] || ENV["AWS_ACCESS_KEY_ID"]
+      private
+
+      def gcp_stats(metric_name, duration: nil, period: nil, offset: nil, series: false)
+        require "google/cloud/monitoring/v3"
+
+        # TODO DRY with RDS stats
+        duration = (duration || 1.hour).to_i
+        period = (period || 1.minute).to_i
+        offset = (offset || 0).to_i
+        end_time = Time.at(((Time.now - offset).to_f / period).ceil * period)
+        start_time = end_time - duration
+
+        # validate input since we need to interpolate below
+        raise Error, "Invalid metric name" unless metric_name =~ /\A[a-z\/_]+\z/i
+        raise Error, "Invalid database id" unless gcp_database_id =~ /\A[a-z\-:]+\z/i
+
+        # we handle three situations:
+        # 1. google-cloud-monitoring-v3
+        # 2. google-cloud-monitoring >= 1
+        # 3. google-cloud-monitoring < 1
+
+        # for situations 1 and 2
+        # Google::Cloud::Monitoring.metric_service is documented
+        # but doesn't work for situation 1
+        if defined?(Google::Cloud::Monitoring::V3::MetricService::Client)
+          client = Google::Cloud::Monitoring::V3::MetricService::Client.new
+
+          interval = Google::Cloud::Monitoring::V3::TimeInterval.new
+          interval.end_time = Google::Protobuf::Timestamp.new(seconds: end_time.to_i)
+          # subtract period to make sure we get first data point
+          interval.start_time = Google::Protobuf::Timestamp.new(seconds: (start_time - period).to_i)
+
+          aggregation = Google::Cloud::Monitoring::V3::Aggregation.new
+          # may be better to use ALIGN_NEXT_OLDER for space stats to show most recent data point
+          # stick with average for now to match AWS
+          aggregation.per_series_aligner = Google::Cloud::Monitoring::V3::Aggregation::Aligner::ALIGN_MEAN
+          aggregation.alignment_period = period
+
+          results = client.list_time_series({
+            name: "projects/#{gcp_database_id.split(":").first}",
+            filter: "metric.type = \"cloudsql.googleapis.com/database/#{metric_name}\" AND resource.label.database_id = \"#{gcp_database_id}\"",
+            interval: interval,
+            view: Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView::FULL,
+            aggregation: aggregation
+          })
+        else
+          require "google/cloud/monitoring"
+
+          client = Google::Cloud::Monitoring::Metric.new
+
+          interval = Google::Monitoring::V3::TimeInterval.new
+          interval.end_time = Google::Protobuf::Timestamp.new(seconds: end_time.to_i)
+          # subtract period to make sure we get first data point
+          interval.start_time = Google::Protobuf::Timestamp.new(seconds: (start_time - period).to_i)
+
+          aggregation = Google::Monitoring::V3::Aggregation.new
+          # may be better to use ALIGN_NEXT_OLDER for space stats to show most recent data point
+          # stick with average for now to match AWS
+          aggregation.per_series_aligner = Google::Monitoring::V3::Aggregation::Aligner::ALIGN_MEAN
+          aggregation.alignment_period = period
+
+          results = client.list_time_series(
+            "projects/#{gcp_database_id.split(":").first}",
+            "metric.type = \"cloudsql.googleapis.com/database/#{metric_name}\" AND resource.label.database_id = \"#{gcp_database_id}\"",
+            interval,
+            Google::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView::FULL,
+            aggregation: aggregation
+          )
+        end
+
+        data = {}
+        result = results.first
+        if result
+          result.points.each do |point|
+            time = Time.at(point.interval.start_time.seconds)
+            value = point.value.double_value
+            value *= 100 if metric_name == "cpu/utilization"
+            data[time] = value
+          end
+        end
+
+        add_missing_data(data, start_time, end_time, period) if series
+
+        data
       end
 
-      def secret_access_key
-        ENV["PGHERO_SECRET_ACCESS_KEY"] || ENV["AWS_SECRET_ACCESS_KEY"]
+      def system_stats(metric_key, **options)
+        case system_stats_provider
+        when :aws
+          metrics = {
+            cpu: "CPUUtilization",
+            connections: "DatabaseConnections",
+            replication_lag: "ReplicaLag",
+            read_iops: "ReadIOPS",
+            write_iops: "WriteIOPS",
+            free_space: "FreeStorageSpace"
+          }
+          rds_stats(metrics[metric_key], **options)
+        when :gcp
+          if metric_key == :free_space
+            quota = gcp_stats("disk/quota", **options)
+            used = gcp_stats("disk/bytes_used", **options)
+            free_space(quota, used)
+          else
+            metrics = {
+              cpu: "cpu/utilization",
+              connections: "postgresql/num_backends",
+              replication_lag: "replication/replica_lag",
+              read_iops: "disk/read_ops_count",
+              write_iops: "disk/write_ops_count"
+            }
+            gcp_stats(metrics[metric_key], **options)
+          end
+        when :azure
+          if metric_key == :free_space
+            quota = azure_stats("storage_limit", **options)
+            used = azure_stats("storage_used", **options)
+            free_space(quota, used)
+          else
+            # no read_iops, write_iops
+            # could add io_consumption_percent
+            metrics = {
+              cpu: "cpu_percent",
+              connections: "active_connections",
+              replication_lag: "pg_replica_log_delay_in_seconds"
+            }
+            raise Error, "Metric not supported" unless metrics[metric_key]
+            azure_stats(metrics[metric_key], **options)
+          end
+        else
+          raise NotEnabled, "System stats not enabled"
+        end
       end
 
-      def region
-        ENV["PGHERO_REGION"] || ENV["AWS_REGION"] || (defined?(Aws) && Aws.config[:region]) || "us-east-1"
+      # only use data points included in both series
+      # this also eliminates need to align Time.now
+      def free_space(quota, used)
+        data = {}
+        quota.each do |k, v|
+          data[k] = v - used[k] if v && used[k]
+        end
+        data
       end
 
-      def db_instance_identifier
-        databases[current_database].db_instance_identifier
+      def add_missing_data(data, start_time, end_time, period)
+        time = start_time
+        end_time = end_time
+        while time < end_time
+          data[time] ||= nil
+          time += period
+        end
       end
     end
   end