ruby-grafana-reporter 0.5.1 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7dd2bc839c1b488d0c4e13d2837686a9c274845ec4f1a2ef46e95708aa4e96d
-  data.tar.gz: 353185c2bbe335ab78b0b2dca7e4edc561ccdfcc1fa72e12d139b8b93da57698
+  metadata.gz: f39ad036bedee33e59c42d02f3fcd755508b09c5fbb90d732681ddb35fefea11
+  data.tar.gz: 5a837b1a1e3a755d34cfc398eae35c58ae1d908476162d3f2e595afd6f26cf5b
 SHA512:
-  metadata.gz: '079bfb28f6365ecd10612076212447015839c1c31bbb976c99c29dbfd4a5af9e9d45d7d542b6e30d019beee4c409c3a86f0ab84aa6ae5db02352b985d04d2841'
-  data.tar.gz: b4d008a5bd31f825a88ec428b3b9e3b117f60156bdfd1609fea3b06d64ff9037a177a7dcdbee5490d79c177e41abb51e7e345b5b82f056448d7509712dcc6d07
+  metadata.gz: 24148398cb3361619c0a1ae6464d7840fcecaa4812669757765bfe615de76cd65189ee44d4f4d18799f2e7792545e6dd4cefcec10e8d0836f3c45f5f318bbfb9
+  data.tar.gz: 0f66267327c1963ea5d18e3720f25ff41115a4a448d598cd313ab5130d1bc033a29905e96833da3401276176d1c7eebee1ae87ef91d670d052d5fcd683340838

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 5, 1].freeze
+GRAFANA_REPORTER_VERSION = [0, 5, 4].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2021-12-18'
+GRAFANA_REPORTER_RELEASE_DATE = '2022-03-25'

data/lib/grafana/abstract_datasource.rb

@@ -57,6 +57,11 @@ module Grafana
       @model['name']
     end
 
+    # @return [String] unique ID of the datasource
+    def uid
+      @model['uid']
+    end
+
     # @return [Integer] ID of the datasource
     def id
       @model['id'].to_i
@@ -108,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
@@ -136,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
@@ -148,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/errors.rb

@@ -71,4 +71,11 @@ module Grafana
       super("The datasource query provided, does not look like a grafana datasource target (received: #{query}).")
     end
   end
+
+  # Raised if a datasource query returned with an unsupported result
+  class UnsupportedQueryResponseReceivedError < GrafanaError
+    def initialize(response)
+      super("The datasource request returned with an unsupported response format (received: #{response}).")
+    end
+  end
 end

data/lib/grafana/grafana.rb

@@ -81,6 +81,17 @@ module Grafana
       @datasources[datasource_name]
     end
 
+    # Returns the datasource, which has been queried by the datasource uid.
+    #
+    # @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
+      raise DatasourceDoesNotExistError.new('uid', datasource_uid) unless datasource
+
+      datasource
+    end
+
     # Returns the datasource, which has been queried by the datasource id.
     #
     # @param datasource_id [Integer] id of the searched datasource

data/lib/grafana/graphite_datasource.rb

@@ -43,10 +43,14 @@ module Grafana
 
     private
 
-    # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
-      json = JSON.parse(response_body)
+      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 = {}
 
@@ -66,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,10 +127,16 @@ 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)['results'].first['series']
+      json = JSON.parse(response_body)
+      json = json['results'].first['series']
       return {} if json.nil?
 
       header = ['time']
@@ -152,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,9 +31,22 @@ 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
-      dashboard.grafana.datasource_by_name(@model['datasource'])
+      if datasource_kind_is_uid?
+        dashboard.grafana.datasource_by_uid(@datasource_uid_or_name)
+      else
+        dashboard.grafana.datasource_by_name(@datasource_uid_or_name)
+      end
     end
 
     # @return [String] query string for the requested query letter
@@ -43,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,8 +55,14 @@ module Grafana
 
     private
 
-    # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
+      # TODO: show raw response body to debug case https://github.com/divinity666/ruby-grafana-reporter/issues/24
+      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)
 
       # handle response with error result
@@ -64,6 +70,7 @@ module Grafana
         return { header: ['error'], content: [[ json['error'] ]] }
       end
 
+      # handle former result formats
       result_type = json['data']['resultType']
       json = json['data']['result']
 
@@ -101,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] = []
@@ -57,16 +63,20 @@ module Grafana
           results[:header] = results[:header] + ['SQL Error']
           results[:content] = [[query_result['error']]]
 
-        elsif query_result['tables']
-          query_result['tables'].each do |table|
-            results[:header] = results[:header] + table['columns'].map { |header| header['text'] }
-            results[:content] = table['rows']
+        elsif query_result.key?('tables')
+          if query_result['tables']
+            query_result['tables'].each do |table|
+              results[:header] = results[:header] + table['columns'].map { |header| header['text'] }
+              results[:content] = table['rows']
+            end
           end
-
         end
       end
 
-      results
+      return results
+
+    rescue
+      raise UnsupportedQueryResponseReceivedError, response_body
     end
   end
 end

data/lib/grafana_reporter/abstract_query.rb

@@ -89,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.4
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor