ruby-grafana-reporter 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6063d128d57f930e83b17253e34e4e20624ef796e7eb86df2e7d54bee7825c
-  data.tar.gz: a6a5f8b3bfcdcfc557ede19e7d89a25de8dca277806da0f662c4165d0a05b03c
+  metadata.gz: 8b50055253026b61f26a424e6016118db18c4b1998e1a26f8fa6f4c8c37f9d6d
+  data.tar.gz: 9ce58b615705b752f13260b4497b297aa1ad193f018a5699e0d4dca53fb1a743
 SHA512:
-  metadata.gz: c9338b1dbd16a81af0c28feb9e8f4efd576ffb3f879aae7dd5d31b00468b32cc18ee49e7a73f87e952e2781845cd1d54124512aef6112194379d3840322fbff8
-  data.tar.gz: 01bed067acfc6442e62ba17dbda3491e6147778a274c65ccacc7f838e57beda53809e8a8b827fad09266b4b506c2e29d7e8d3b0670c506eb0063eddd40d1aa26
+  metadata.gz: 3d96e06e01a4f5d861603528f64f57cfdbca4fe32a9790f8bc82982ea8581d6d07243aa5bfccd1fac018f1da1f1ad7a514fc31a9ff1f660aa2abf99ebfd5a2ab
+  data.tar.gz: 17b0f9e00461cea9c9fab69572d16b12a69494b06e52500c4f0ba01ced604116c57419726982a87cdd08f462465c4e4e9fe4a891211ff185be2ca52c67c5841d

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 5, 2].freeze
+GRAFANA_REPORTER_VERSION = [0, 5, 3].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2022-03-22'
+GRAFANA_REPORTER_RELEASE_DATE = '2022-03-24'

data/lib/grafana/abstract_datasource.rb

@@ -113,15 +113,14 @@ module Grafana
       raise NotImplementedError
     end
 
-    private
-
     # Replaces the grafana variables in the given string with their replacement value.
     #
     # @param string [String] string in which the variables shall be replaced
     # @param variables [Hash<String,Variable>] Hash containing the variables, which shall be replaced in the
     #  given string
+    # @param overwrite_default_format [String] {Variable#value_formatted} value, if a custom default format should be used, otherwise {#default_variable_format} is used as default, which may be overwritten
     # @return [String] string in which all variables are properly replaced
-    def replace_variables(string, variables = {})
+    def replace_variables(string, variables, overwrite_default_format = nil)
       res = string
       repeat = true
       repeat_count = 0
@@ -141,7 +140,8 @@ module Grafana
           next unless var_name =~ /^\w+$/
 
           res = res.gsub(/(?:\$\{#{var_name}(?::(?<format>\w+))?\}|\$#{var_name}(?!\w))/) do
-            format = default_variable_format
+            format = overwrite_default_format
+            format = default_variable_format if overwrite_default_format.nil?
             if $LAST_MATCH_INFO
               format = $LAST_MATCH_INFO[:format] if $LAST_MATCH_INFO[:format]
             end
@@ -153,5 +153,31 @@ module Grafana
 
       res
     end
+
+    private
+
+    # Provides a general method to handle the given query response as general Grafana Dataframe format.
+    #
+    # This method throws {UnsupportedQueryResponseReceivedError} if the given query response is not a
+    # properly formattes dataframe
+    #
+    # @param response_body [String] raw response body
+    def preformat_dataframe_response(response_body)
+      json = JSON.parse(response_body)
+      data = json['results'].values.first
+
+      # TODO: check how multiple frames have to be handled
+      data = data['frames']
+      headers = []
+      data.first['schema']['fields'].each do |headline|
+        header = headline['config']['displayNameFromDS'].nil? ? headline['name'] : headline['config']['displayNameFromDS']
+        headers << header
+      end
+      content = data.first['data']['values'][0].zip(data.first['data']['values'][1])
+      return { header: headers, content: content }
+
+    rescue
+      raise UnsupportedQueryResponseReceivedError, response_body
+    end
   end
 end

data/lib/grafana/graphite_datasource.rb

@@ -43,13 +43,14 @@ module Grafana
 
     private
 
-    # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
-      json = JSON.parse(response_body)
-
-      raise UnsupportedQueryResponseReceivedError, response_body if json.first['target'].nil?
-      raise UnsupportedQueryResponseReceivedError, response_body if json.first['datapoints'].nil?
+      begin
+        return preformat_dataframe_response(response_body)
+      rescue
+        # TODO: show an info, that the response if not a dataframe
+      end
 
+      json = JSON.parse(response_body)
       header = ['time']
       content = {}
 
@@ -69,7 +70,10 @@ module Grafana
         end
       end
 
-      { header: header, content: content.to_a.map(&:flatten).sort { |a, b| a[0] <=> b[0] } }
+      return { header: header, content: content.to_a.map(&:flatten).sort { |a, b| a[0] <=> b[0] } }
+
+    rescue
+      raise UnsupportedQueryResponseReceivedError, response_body
     end
   end
 end

data/lib/grafana/influxdb_datasource.rb

@@ -127,14 +127,15 @@ module Grafana
       "#{res} #{parts.join(', ')}"
     end
 
-    # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
+      begin
+        return preformat_dataframe_response(response_body)
+      rescue
+        # TODO: show an info, that the response if not a dataframe
+      end
+
       # TODO: how to handle multiple query results?
       json = JSON.parse(response_body)
-      raise UnsupportedQueryResponseReceivedError, response_body if json['results'].nil?
-      raise UnsupportedQueryResponseReceivedError, response_body if json['results'].first.nil?
-      raise UnsupportedQueryResponseReceivedError, response_body if json['results'].first['series'].nil?
-
       json = json['results'].first['series']
       return {} if json.nil?
 
@@ -157,7 +158,10 @@ module Grafana
         end
       end
 
-      { header: header, content: content.to_a.map(&:flatten).sort { |a, b| a[0] <=> b[0] } }
+      return { header: header, content: content.to_a.map(&:flatten).sort { |a, b| a[0] <=> b[0] } }
+
+    rescue
+      raise UnsupportedQueryResponseReceivedError, response_body
     end
   end
 end

data/lib/grafana/panel.rb

@@ -12,6 +12,11 @@ module Grafana
     def initialize(model, dashboard)
       @model = model
       @dashboard = dashboard
+
+      @datasource_uid_or_name = @model['datasource']
+      if @model['datasource'].is_a?(Hash)
+        @datasource_uid_or_name = @model['datasource']['uid']
+      end
     end
 
     # @return [String] content of the requested field or +''+ if not found
@@ -26,12 +31,21 @@ module Grafana
       @model['id']
     end
 
+    # This method should always be called before the +datasource+ method of a
+    # panel is invoked, to ensure that the variable names in the datasource
+    # field are resolved.
+    #
+    # @param variables [Hash] variables hash, which should be use to resolve variable datasource
+    def resolve_variable_datasource(variables)
+      @datasource_uid_or_name = AbstractDatasource.new(nil).replace_variables(@datasource_uid_or_name, variables, 'raw')
+    end
+
     # @return [Datasource] datasource object specified for the current panel
     def datasource
-      if @model['datasource'].is_a?(Hash)
-        dashboard.grafana.datasource_by_uid(@model['datasource']['uid'])
+      if datasource_kind_is_uid?
+        dashboard.grafana.datasource_by_uid(@datasource_uid_or_name)
       else
-        dashboard.grafana.datasource_by_name(@model['datasource'])
+        dashboard.grafana.datasource_by_name(@datasource_uid_or_name)
       end
     end
 
@@ -47,5 +61,14 @@ module Grafana
     def render_url
       "/render/d-solo/#{@dashboard.id}?panelId=#{@model['id']}"
     end
+
+    private
+
+    def datasource_kind_is_uid?
+      if @model['datasource'].is_a?(Hash)
+        return true
+      end
+      false
+    end
   end
 end

data/lib/grafana/prometheus_datasource.rb

@@ -55,47 +55,25 @@ module Grafana
 
     private
 
-    # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
-      json = {}
+      # TODO: show raw response body to debug case https://github.com/divinity666/ruby-grafana-reporter/issues/24
       begin
-        json = JSON.parse(response_body)
+        return preformat_dataframe_response(response_body)
       rescue
-        raise UnsupportedQueryResponseReceivedError, response_body
+        # TODO: show an info, that the response if not a dataframe
       end
 
+      json = JSON.parse(response_body)
+
       # handle response with error result
       unless json['error'].nil?
         return { header: ['error'], content: [[ json['error'] ]] }
       end
 
-      # handle dataframes
-      if json['results']
-        data = json['results'].values.first
-        raise UnsupportedQueryResponseReceivedError, response_body if data.nil?
-        raise UnsupportedQueryResponseReceivedError, response_body if data['frames'].nil?
-        # TODO: check how multiple frames have to be handled
-
-        data = data['frames']
-        headers = []
-        data.first['schema']['fields'].each do |headline|
-          header = headline['config']['displayNameFromDS'].nil? ? headline['name'] : headline['config']['displayNameFromDS']
-          headers << header
-        end
-        content = data.first['data']['values'][0].zip(data.first['data']['values'][1])
-        return { header: headers, content: content }
-      end
-
       # handle former result formats
-      raise UnsupportedQueryResponseReceivedError, response_body if json['data'].nil?
-      raise UnsupportedQueryResponseReceivedError, response_body if json['data']['resultType'].nil?
-      raise UnsupportedQueryResponseReceivedError, response_body if json['data']['result'].nil?
-
       result_type = json['data']['resultType']
       json = json['data']['result']
 
-      raise UnsupportedQueryResponseReceivedError, response_body if not result_type =~ /^(?:scalar|string|vector|matrix)$/
-
       headers = ['time']
       content = {}
 
@@ -130,7 +108,10 @@ module Grafana
         end
       end
 
-      { header: headers, content: content.to_a.map(&:flatten).sort { |a, b| a[0] <=> b[0] } }
+      return { header: headers, content: content.to_a.map(&:flatten).sort { |a, b| a[0] <=> b[0] } }
+
+    rescue
+      raise UnsupportedQueryResponseReceivedError, response_body
     end
   end
 end

data/lib/grafana/sql_datasource.rb

@@ -47,6 +47,12 @@ module Grafana
     private
 
     def preformat_response(response_body)
+      begin
+        return preformat_dataframe_response(response_body)
+      rescue
+        # TODO: show an info, that the response if not a dataframe
+      end
+
       results = {}
       results.default = []
       results[:header] = []
@@ -64,13 +70,13 @@ module Grafana
               results[:content] = table['rows']
             end
           end
-
-        else
-          raise UnsupportedQueryResponseReceivedError, response_body
         end
       end
 
-      results
+      return results
+
+    rescue
+      raise UnsupportedQueryResponseReceivedError, response_body
     end
   end
 end

data/lib/grafana_reporter/abstract_query.rb

@@ -13,6 +13,7 @@ module GrafanaReporter
     attr_reader :variables, :result, :panel, :dashboard
 
     def timeout
+      # TODO: PRIO check where value priorities should be evaluated
       return @variables['timeout'].raw_value if @variables['timeout']
       return @variables['grafana_default_timeout'].raw_value if @variables['grafana_default_timeout']
 
@@ -88,7 +89,7 @@ module GrafanaReporter
         # grafana errors will be directly passed through
         raise
       rescue StandardError => e
-        raise DatasourceRequestInternalError.new(@datasource, e.message)
+        raise DatasourceRequestInternalError.new(@datasource, "#{e.message}\n#{e.backtrace.join("\n")}")
       end
 
       raise DatasourceRequestInvalidReturnValueError.new(@datasource, @result) unless datasource_response_valid?

data/lib/grafana_reporter/query_value_query.rb

@@ -5,7 +5,10 @@ module GrafanaReporter
   class QueryValueQuery < AbstractQuery
     # @see Grafana::AbstractQuery#pre_process
     def pre_process
-      @datasource = @panel.datasource if @panel
+      if @panel
+        @panel.resolve_variable_datasource(@variables)
+        @datasource = @panel.datasource
+      end
 
       @variables['result_type'] ||= Variable.new('')
     end

data/lib/ruby_grafana_reporter.rb

@@ -18,17 +18,6 @@ require 'asciidoctor-pdf'
 require 'zip'
 require_relative 'VERSION'
 
-# TODO: add test for variable replacement for sql
-# TODO: check why value is All instead of $__all
-# TODO: check why single sql values are replaced including ticks, whereas grafana does not do so
-
-# TODO: add FAQ for fixing most common issues with the reporter
-# TODO: implement an easy function to document a whole dashboard at once with different presentations
-# TODO: add automated test against grafana playground before building a new release
-# TODO: allow registration of files to be defined in config file
-# TODO: append necessary variables on demo report creation for plain SQL queries, as they are lacking the grafana reference
-# TODO: make demo report more readable
-
 folders = [
   %w[grafana],
   %w[grafana_reporter logger],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor