ruby-grafana-reporter 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f39ad036bedee33e59c42d02f3fcd755508b09c5fbb90d732681ddb35fefea11
-  data.tar.gz: 5a837b1a1e3a755d34cfc398eae35c58ae1d908476162d3f2e595afd6f26cf5b
+  metadata.gz: e198f995d87598512fbe2a4578edf8be48630bab415d14c5348cf23a57e47df7
+  data.tar.gz: c1f5a3c85ba1081fbfc0b526b1c4e15412d146a8f88af897a0620fd762687482
 SHA512:
-  metadata.gz: 24148398cb3361619c0a1ae6464d7840fcecaa4812669757765bfe615de76cd65189ee44d4f4d18799f2e7792545e6dd4cefcec10e8d0836f3c45f5f318bbfb9
-  data.tar.gz: 0f66267327c1963ea5d18e3720f25ff41115a4a448d598cd313ab5130d1bc033a29905e96833da3401276176d1c7eebee1ae87ef91d670d052d5fcd683340838
+  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, 4].freeze
+GRAFANA_REPORTER_VERSION = [0, 6, 0].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2022-03-25'
+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

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/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,13 +48,67 @@ 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
 
     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
+        # TODO: show an info, that the response is not a dataframe
       end
 
       json = JSON.parse(response_body)

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

@@ -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']
 
@@ -81,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Christian Kohlmeyer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-25 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: []