pghero 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 252b8c1bb7580d67b149ef865f97b99a89fbd9aecb640a92f5ebf8a532d7c10b
-  data.tar.gz: 87a9df921265875867cb9d9b0dcd92fa6d6855075818129a8b5bf47337277354
+  metadata.gz: e7334e516c44c91605f37b8fd22b57a46b147cfe4191796e48624e8a15b45ca0
+  data.tar.gz: 1235c0626b5a7f2061f2bcfce062d4716f3de7a5c198aeed489eaf9d0c7549c0
 SHA512:
-  metadata.gz: 9b1f75f5ef19ee10da7ee815aca9ee7933fa89ae78046e495417f7c863f383172fba28bfb00605ac8810a2bb5a9895ae478a3f182ba36204080151f84ad9e2a6
-  data.tar.gz: 6fc630bd5f46fbecb5b6194d58726397c8f28a812e7ceabe12784ed6892bd7f7609646cba22e57c34ab817be40b37e251384f5ba23a32e82199db7620f4dc009
+  metadata.gz: 52944fa0d91437a0fd42dc4e8705a4f833a3d60937748f1cbffd03aa9471af8ce2e30db7645c419590696dcbbe0e700941b838216ae3da7a5bc211f0067188a5
+  data.tar.gz: 8ff19581f7245ebc804ef49af131c9f6eca5ed8110b878ccb8e1b15cf94c2951d88e4329e1565145e03b21c63e3798be400dc74b2655c7489dca75ba9ca4aec5

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 2.6.0 (2020-07-09)
+
+- Added support for Postgres 13 beta 2
+- Added support for non-integer explain timeout
+
+## 2.5.1 (2020-06-23)
+
+- Added support for `google-cloud-monitoring` >= 1
+- Added support for `google-cloud-monitoring-v3`
+- Fixed system stats not showing up in Rails 6 with environment variables
+
 ## 2.5.0 (2020-05-24)
 
 - Added system stats for Google Cloud SQL and Azure Database

data/lib/generators/pghero/templates/config.yml.tt

@@ -32,14 +32,14 @@ databases:
 
 # Basic authentication
 # username: admin
-# password: secret
+# password: <%%= ENV["PGHERO_PASSWORD"] %>
 
 # Stats database URL (defaults to app database)
 # stats_database_url: <%%= ENV["PGHERO_STATS_DATABASE_URL"] %>
 
 # AWS configuration (defaults to app AWS config)
-# aws_access_key_id: ...
-# aws_secret_access_key: ...
+# aws_access_key_id: <%%= ENV["AWS_ACCESS_KEY_ID"] %>
+# aws_secret_access_key: <%%= ENV["AWS_SECRET_ACCESS_KEY"] %>
 # aws_region: us-east-1
 
 # Filter data from queries (experimental)

data/lib/pghero.rb

@@ -43,7 +43,7 @@ module PgHero
   self.long_running_query_sec = (ENV["PGHERO_LONG_RUNNING_QUERY_SEC"] || 60).to_i
   self.slow_query_ms = (ENV["PGHERO_SLOW_QUERY_MS"] || 20).to_i
   self.slow_query_calls = (ENV["PGHERO_SLOW_QUERY_CALLS"] || 100).to_i
-  self.explain_timeout_sec = (ENV["PGHERO_EXPLAIN_TIMEOUT_SEC"] || 10).to_i
+  self.explain_timeout_sec = (ENV["PGHERO_EXPLAIN_TIMEOUT_SEC"] || 10).to_f
   self.total_connections_threshold = (ENV["PGHERO_TOTAL_CONNECTIONS_THRESHOLD"] || 500).to_i
   self.cache_hit_rate_threshold = 99
   self.env = ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
@@ -119,11 +119,16 @@ module PgHero
 
           if databases.empty?
             databases["primary"] = {
-              "url" => ENV["PGHERO_DATABASE_URL"] || ActiveRecord::Base.connection_config,
+              "url" => ENV["PGHERO_DATABASE_URL"] || ActiveRecord::Base.connection_config
+            }
+          end
+
+          if databases.size == 1
+            databases.values.first.merge!(
               "db_instance_identifier" => ENV["PGHERO_DB_INSTANCE_IDENTIFIER"],
               "gcp_database_id" => ENV["PGHERO_GCP_DATABASE_ID"],
               "azure_resource_id" => ENV["PGHERO_AZURE_RESOURCE_ID"]
-            }
+            )
           end
 
           {

data/lib/pghero/database.rb

@@ -55,15 +55,16 @@ module PgHero
     end
 
     def explain_timeout_sec
-      (config["explain_timeout_sec"] || PgHero.config["explain_timeout_sec"] || PgHero.explain_timeout_sec).to_i
+      (config["explain_timeout_sec"] || PgHero.config["explain_timeout_sec"] || PgHero.explain_timeout_sec).to_f
     end
 
     def long_running_query_sec
       (config["long_running_query_sec"] || PgHero.config["long_running_query_sec"] || PgHero.long_running_query_sec).to_i
     end
 
+    # defaults to 100 megabytes
     def index_bloat_bytes
-      (config["index_bloat_bytes"] || PgHero.config["index_bloat_bytes"] || 100.megabytes).to_i
+      (config["index_bloat_bytes"] || PgHero.config["index_bloat_bytes"] || 104857600).to_i
     end
 
     def aws_access_key_id

data/lib/pghero/methods/explain.rb

@@ -6,7 +6,7 @@ module PgHero
         explanation = nil
 
         # use transaction for safety
-        with_transaction(statement_timeout: (explain_timeout_sec * 1000), rollback: true) do
+        with_transaction(statement_timeout: (explain_timeout_sec * 1000).round, rollback: true) do
           if (sql.sub(/;\z/, "").include?(";") || sql.upcase.include?("COMMIT")) && !explain_safe?
             raise ActiveRecord::StatementInvalid, "Unsafe statement"
           end

data/lib/pghero/methods/query_stats.rb

@@ -166,14 +166,15 @@ module PgHero
         if query_stats_enabled?
           limit ||= 100
           sort ||= "total_minutes"
+          total_time = server_version_num >= 130000 ? "(total_plan_time + total_exec_time)" : "total_time"
           query = <<-SQL
             WITH query_stats AS (
               SELECT
                 LEFT(query, 10000) AS query,
                 #{supports_query_hash? ? "queryid" : "md5(query)"} AS query_hash,
                 rolname AS user,
-                (total_time / 1000 / 60) AS total_minutes,
-                (total_time / calls) AS average_time,
+                (#{total_time} / 1000 / 60) AS total_minutes,
+                (#{total_time} / calls) AS average_time,
                 calls
               FROM
                 pg_stat_statements
@@ -182,6 +183,7 @@ module PgHero
               INNER JOIN
                 pg_roles ON pg_roles.oid = pg_stat_statements.userid
               WHERE
+                calls > 0 AND
                 pg_database.datname = #{database ? quote(database) : "current_database()"}
                 #{query_hash ? "AND queryid = #{quote(query_hash)}" : nil}
             )

data/lib/pghero/methods/system.rb

@@ -5,7 +5,7 @@ module PgHero
         !system_stats_provider.nil?
       end
 
-      # TODO require AWS 2+ automatically
+      # TODO remove defined checks in 3.0
       def system_stats_provider
         if aws_db_instance_identifier && (defined?(Aws) || defined?(AWS))
           :aws
@@ -133,7 +133,7 @@ module PgHero
       private
 
       def gcp_stats(metric_name, duration: nil, period: nil, offset: nil, series: false)
-        require "google/cloud/monitoring"
+        require "google/cloud/monitoring/v3"
 
         # TODO DRY with RDS stats
         duration = (duration || 1.hour).to_i
@@ -142,30 +142,63 @@ module PgHero
         end_time = Time.at(((Time.now - offset).to_f / period).ceil * period)
         start_time = end_time - duration
 
-        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
-
         # 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
 
-        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
-        )
+        # 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

data/lib/pghero/methods/users.rb

@@ -1,6 +1,8 @@
 module PgHero
   module Methods
     module Users
+      # documented as unsafe to pass user input
+      # TODO quote in 3.0, but still not officially supported
       def create_user(user, password: nil, schema: "public", database: nil, readonly: false, tables: nil)
         password ||= random_password
         database ||= connection_model.connection_config[:database]
@@ -39,6 +41,8 @@ module PgHero
         {password: password}
       end
 
+      # documented as unsafe to pass user input
+      # TODO quote in 3.0, but still not officially supported
       def drop_user(user, schema: "public", database: nil)
         database ||= connection_model.connection_config[:database]
 

data/lib/pghero/version.rb

@@ -1,3 +1,3 @@
 module PgHero
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pghero
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-24 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord