ruby-grafana-reporter 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de6063d128d57f930e83b17253e34e4e20624ef796e7eb86df2e7d54bee7825c
-  data.tar.gz: a6a5f8b3bfcdcfc557ede19e7d89a25de8dca277806da0f662c4165d0a05b03c
+  metadata.gz: e198f995d87598512fbe2a4578edf8be48630bab415d14c5348cf23a57e47df7
+  data.tar.gz: c1f5a3c85ba1081fbfc0b526b1c4e15412d146a8f88af897a0620fd762687482
 SHA512:
-  metadata.gz: c9338b1dbd16a81af0c28feb9e8f4efd576ffb3f879aae7dd5d31b00468b32cc18ee49e7a73f87e952e2781845cd1d54124512aef6112194379d3840322fbff8
-  data.tar.gz: 01bed067acfc6442e62ba17dbda3491e6147778a274c65ccacc7f838e57beda53809e8a8b827fad09266b4b506c2e29d7e8d3b0670c506eb0063eddd40d1aa26
+  metadata.gz: 9e5af10cd799f63a8ac662db422cebe1a8f7d1484c5e29e54ec73280c966efc7a57059c5fbe2bef2717b27fe6c2fa1c22c819fce3c851d98d568fd556291d933
+  data.tar.gz: 97c1477d8e97a6afa096d7dc4557d4ae15e9aee87ca541af165f898f3cfd1a20d002e2b06c68c98dd4f0c436299129e766e0023f34b6f1a2639d4fcabcfde73d

data/README.md

@@ -310,6 +310,7 @@ webservice or a rendering process starts.
 This is just a collection of things, I am heading for in future, without a schedule.
 
 * Support grafana internal datasources
+* Support additional templating variable types
 * Solve code TODOs
 * Become [rubocop](https://rubocop.org/) ready
 

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, 6, 0].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2022-03-22'
+GRAFANA_REPORTER_RELEASE_DATE = '2022-08-01'

data/lib/grafana/abstract_datasource.rb

@@ -82,6 +82,7 @@ module Grafana
     #   }
     #
     # @param query_description [Hash] query description, which will requested:
+    # @option query_description [String] :grafana_version grafana version, for which the request is to be prepared
     # @option query_description [String] :from +from+ timestamp
     # @option query_description [String] :to +to+ timestamp
     # @option query_description [Integer] :timeout expected timeout for the request
@@ -113,15 +114,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 +141,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 +154,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/dashboard.rb

@@ -58,7 +58,14 @@ module Grafana
       list = @model['templating']['list']
       return unless list.is_a? Array
 
-      list.each { |item| @variables << Variable.new(item, self) }
+      list.each do |item|
+        begin
+          @variables << Variable.new(item, self)
+        rescue => e
+          # TODO: show this message as a warning - needs test cleanup
+          @grafana.logger.debug(e.message)
+        end
+      end
     end
 
     # read panels

data/lib/grafana/grafana.rb

@@ -86,7 +86,15 @@ module Grafana
     # @param datasource_uid [String] unique id of the searched datasource
     # @return [Datasource] Datasource for the specified datasource unique id
     def datasource_by_uid(datasource_uid)
-      datasource = @datasources.select { |_name, ds| ds.uid == datasource_uid }.values.first
+      datasource = @datasources.select do |ds_name, ds|
+        if (ds.nil?)
+          # print debug info for https://github.com/divinity666/ruby-grafana-reporter/issues/29
+          @logger.warn("Datasource with name #{ds_name} is nil, which should never happen. Check logs for details.")
+          false
+        else
+          ds.uid == datasource_uid
+        end
+      end.values.first
       raise DatasourceDoesNotExistError.new('uid', datasource_uid) unless datasource
 
       datasource
@@ -156,6 +164,12 @@ module Grafana
       json = JSON.parse(settings.body)
       json['datasources'].select { |_k, v| v['id'].to_i.positive? }.each do |ds_name, ds_value|
         @datasources[ds_name] = AbstractDatasource.build_instance(ds_value)
+
+        # print debug info for https://github.com/divinity666/ruby-grafana-reporter/issues/29
+        if @datasources[ds_name].nil?
+          @logger.error("Datasource with name '#{ds_name}' and configuration: '#{ds_value}' could not be initialized.")
+          @datasources.delete(ds_name)
+        end
       end
       @datasources['default'] = @datasources[json['defaultDatasource']]
     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') if @datasource_uid_or_name.is_a?(String)
+    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

@@ -24,21 +24,15 @@ module Grafana
       interval = interval.raw_value if interval.is_a?(Variable)
       query = query_hash[:query] || query_description[:raw_query]
 
-      url = if instant
-        "/api/datasources/proxy/#{id}/api/v1/query?time=#{query_description[:to]}&query="\
-        "#{CGI.escape(replace_variables(query, query_description[:variables]))}"
+      ver = query_description[:grafana_version].split('.').map{|x| x.to_i}
+      request = nil
+      if (ver[0] == 7 and ver[1] < 5) or ver[0] < 7
+        request = prepare_get_request({query_description: query_description, instant: instant, interval: interval, query: query})
       else
-        "/api/datasources/proxy/#{id}/api/v1/query_range?start=#{query_description[:from]}"\
-        "&end=#{query_description[:to]}"\
-        "&query=#{CGI.escape(replace_variables(query, query_description[:variables]))}"\
-        "&step=#{interval}"
+        request = prepare_post_request({query_description: query_description, instant: instant, interval: interval, query: query})
       end
 
-      webrequest = query_description[:prepared_request]
-      webrequest.relative_url = url
-      webrequest.options.merge!({ request: Net::HTTP::Get })
-
-      result = webrequest.execute(query_description[:timeout])
+      result = request.execute(query_description[:timeout])
       preformat_response(result.body)
     end
 
@@ -54,48 +48,80 @@ module Grafana
     end
 
     private
+    def prepare_get_request(hash)
+      url = if hash[:instant]
+        "/api/datasources/proxy/#{id}/api/v1/query?time=#{hash[:query_description][:to]}&query="\
+        "#{CGI.escape(replace_variables(hash[:query], hash[:query_description][:variables]))}"
+      else
+        "/api/datasources/proxy/#{id}/api/v1/query_range?start=#{hash[:query_description][:from]}"\
+        "&end=#{hash[:query_description][:to]}"\
+        "&query=#{CGI.escape(replace_variables(hash[:query], hash[:query_description][:variables]))}"\
+        "&step=#{hash[:interval]}"
+      end
+
+      webrequest = hash[:query_description][:prepared_request]
+      webrequest.relative_url = url
+      webrequest.options.merge!({ request: Net::HTTP::Get })
+
+      webrequest
+    end
+
+    def prepare_post_request(hash)
+      webrequest = hash[:query_description][:prepared_request]
+      webrequest.relative_url = '/api/ds/query'
+
+      params = {
+        from: hash[:query_description][:from],
+        to: hash[:query_description][:to],
+        queries: [{
+          datasource: { type: type, uid: uid },
+          datasourceId: id,
+          exemplar: false,
+          expr: hash[:query],
+          format: 'time_series',
+          interval: '',
+          # intervalFactor: ### 2,
+          # intervalMs: ### 15000,
+          # legendFormat: '', ### {{job}}
+          # maxDataPoints: 999,
+          metric: '',
+          queryType: 'timeSeriesQuery',
+          refId: 'A',
+          # requestId: '14A',
+          # utcOffsetSec: 7200,
+          step: hash[:interval]
+        }],
+        range: {
+          #from: ### "2022-07-31T16:19:26.198Z",
+          #to: ### "2022-07-31T16:19:26.198Z",
+          raw: { from: hash[:query_description][:variables]['from'].raw_value, to: hash[:query_description][:variables]['to'].raw_value }
+        }
+      }
+
+      webrequest.options.merge!({ request: Net::HTTP::Post, body: params.to_json })
+
+      webrequest
+    end
 
-    # @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 is 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 +156,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/variable.rb

@@ -240,7 +240,7 @@ module Grafana
         if !@config['current'].nil?
           self.raw_value = @config['current']['value']
         else
-          raise GrafanaError.new("Grafana variable with type '#{@config['type']}' and name '#{@config['name']}' could not be handled properly. Please raise a ticket.")
+          raise GrafanaError.new("Grafana variable with type '#{@config['type']}' and name '#{@config['name']}' cannot be handled properly by the reporter. Check your results and raise a ticket on github.")
         end
       end
     end

data/lib/grafana_reporter/abstract_query.rb

@@ -80,7 +80,8 @@ module GrafanaReporter
 
       begin
         @result = @datasource.request(from: from, to: to, raw_query: raw_query, variables: @variables,
-                                      prepared_request: @grafana.prepare_request, timeout: timeout)
+                                      prepared_request: @grafana.prepare_request, timeout: timeout,
+                                      grafana_version: @grafana.version)
       rescue ::Grafana::GrafanaError
         # grafana errors will be directly passed through
         raise
@@ -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.6.0
 platform: ruby
 authors:
 - Christian Kohlmeyer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -178,7 +178,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/divinity666/ruby-grafana-reporter
   bug_tracker_uri: https://github.com/divinity666/ruby-grafana-reporter/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -186,7 +186,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.5
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Reporter Service for Grafana
 test_files: []