ruby-grafana-reporter 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7dd2bc839c1b488d0c4e13d2837686a9c274845ec4f1a2ef46e95708aa4e96d
-  data.tar.gz: 353185c2bbe335ab78b0b2dca7e4edc561ccdfcc1fa72e12d139b8b93da57698
+  metadata.gz: de6063d128d57f930e83b17253e34e4e20624ef796e7eb86df2e7d54bee7825c
+  data.tar.gz: a6a5f8b3bfcdcfc557ede19e7d89a25de8dca277806da0f662c4165d0a05b03c
 SHA512:
-  metadata.gz: '079bfb28f6365ecd10612076212447015839c1c31bbb976c99c29dbfd4a5af9e9d45d7d542b6e30d019beee4c409c3a86f0ab84aa6ae5db02352b985d04d2841'
-  data.tar.gz: b4d008a5bd31f825a88ec428b3b9e3b117f60156bdfd1609fea3b06d64ff9037a177a7dcdbee5490d79c177e41abb51e7e345b5b82f056448d7509712dcc6d07
+  metadata.gz: c9338b1dbd16a81af0c28feb9e8f4efd576ffb3f879aae7dd5d31b00468b32cc18ee49e7a73f87e952e2781845cd1d54124512aef6112194379d3840322fbff8
+  data.tar.gz: 01bed067acfc6442e62ba17dbda3491e6147778a274c65ccacc7f838e57beda53809e8a8b827fad09266b4b506c2e29d7e8d3b0670c506eb0063eddd40d1aa26

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, 2].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2021-12-18'
+GRAFANA_REPORTER_RELEASE_DATE = '2022-03-22'

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

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

@@ -47,6 +47,9 @@ module Grafana
     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?
+
       header = ['time']
       content = {}
 

data/lib/grafana/influxdb_datasource.rb

@@ -130,7 +130,12 @@ module Grafana
     # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
       # TODO: how to handle multiple query results?
-      json = JSON.parse(response_body)['results'].first['series']
+      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?
 
       header = ['time']

data/lib/grafana/panel.rb

@@ -28,7 +28,11 @@ module Grafana
 
     # @return [Datasource] datasource object specified for the current panel
     def datasource
-      dashboard.grafana.datasource_by_name(@model['datasource'])
+      if @model['datasource'].is_a?(Hash)
+        dashboard.grafana.datasource_by_uid(@model['datasource']['uid'])
+      else
+        dashboard.grafana.datasource_by_name(@model['datasource'])
+      end
     end
 
     # @return [String] query string for the requested query letter

data/lib/grafana/prometheus_datasource.rb

@@ -57,16 +57,45 @@ module Grafana
 
     # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
-      json = JSON.parse(response_body)
+      json = {}
+      begin
+        json = JSON.parse(response_body)
+      rescue
+        raise UnsupportedQueryResponseReceivedError, response_body
+      end
 
       # 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 = {}
 

data/lib/grafana/sql_datasource.rb

@@ -57,12 +57,16 @@ 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
 
+        else
+          raise UnsupportedQueryResponseReceivedError, response_body
         end
       end
 

data/lib/grafana_reporter/abstract_query.rb

@@ -13,7 +13,6 @@ 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']
 

data/lib/ruby_grafana_reporter.rb

@@ -18,6 +18,17 @@ 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.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-18 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor