ruby-grafana-reporter 0.6.2 → 0.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e3324f4e9d6fa3a47963a73ae4371122f603039284d0b453ac2f62881c5b93
-  data.tar.gz: 535a8f6f2763a5689472a423090504bbd5eed6b5610a557c7d9452999694f52c
+  metadata.gz: a5e48d471e3c09009d65b08924a8d8ff1f4a2259fde86a2525f56554ee96f23a
+  data.tar.gz: 0e095029e10bd6bef2ae80ad866b243c13d3c1ebd5555c9b75d651d6da5ce15c
 SHA512:
-  metadata.gz: e77dd83050e40196334058503c902ac6fc9285bf13a4ac8398ec9ffcf724160b30091ac6994cbff48326b4512499ccc7f0358f291e9af417a3903b8cfb2ac32d
-  data.tar.gz: 2c46bc4ccdd59cd49588e292e1882662b40cde32a50898e14e33eb1f50fffdd5334c86c837bb3e249155002cd80c78af51bfd9897e176654eeece1ebd2d92084
+  metadata.gz: f6bc6604e3fed7fba3fe3057d42432098363f056c03afdf6c8f961d80abc0b0ad4505a01f895d44421774b5bb1a9227bb9bdef747cea7fe15669ebdf149b7611
+  data.tar.gz: fa8ec80a80e51d214c50d54e9d1dbf6d196c11e5320f749ac2f3d2c9b5ed5979ae3a71924ce5d47d43489e4e18c381b5d8d05ad47a3805122a5ba93d9947950f

data/README.md

@@ -20,7 +20,22 @@ Reporting Service for Grafana
   * [Using webhooks](#using-webhooks)
   * [Developing your own plugin](#developing-your-own-plugin)
 * [Roadmap](#roadmap)
-* [Donations](#donations)
+* [Contributing](#contributing)
+* [Licensing](#licensing)
+* [Acknowledgements](#acknowledgements)
+
+## Your support is appreciated!
+
+Hey there! Let me spend some personal words here:
+
+I provide you this software free of charge - and I'm happy, that I can do so. I have already
+spend a lot of my private time in developing, maintaining and supporting it.
+
+If you enjoy my work, I would feel greatly honoured, if you buy me a coffee:
+
+[![buymeacoffee](https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0)](https://ko-fi.com/divinity666)
+
+Thanks for your support and keeping this project alive!
 
 ## About the project
 
@@ -136,8 +151,10 @@ asciidoctor:
 
 ### Grafana integration
 
-For using the reporter directly from grafana, you need to simply add a link to your
-grafana dashboard:
+For using the reporter directly from grafana, the reporter has to run as webservice, i.e. it has to be
+called without the `-t` parameter.
+
+If this is the case, you simply simply need add a link to your grafana dashboard:
 
 * Open the dashboard configuration
 * Select `Links`
@@ -168,7 +185,32 @@ a variable and forward it to the reporter.
 
 ## Advanced information
 
-### Webservice
+### Use grafana variables in templates
+It is common practice to use dashboard variables in grafana, to allow users to show
+the dashboard for a specific set of data only. This is where grafana variables are
+used.
+
+Those variables are then also used in panel queries, to react on selecting or entering
+those variables.
+
+You may provide those variables during report generation to the reporter. Therefore
+you have to specify them in the individual calls.
+
+Let's say, you have a variable called `serverid` in the dashboard. You may now want
+to set this variable for a panel image rendering. This cann be done with the following
+calls:
+
+````
+grafana_panel_image:1[var-serverid=main-server]
+grafana_panel_image:1[var-serverid=replica-server]
+````
+
+This will render two images: one for `main-server` and one for `replica-server`.
+
+So, to forward grafana variables to the reporter calls, you simply have to use the
+form `var-<<your-variable-name>>` and specify those in your reporter template.
+
+### Webservice endpoints
 
 Running the reporter as a webservice provides the following URLs
 
@@ -329,9 +371,3 @@ The code in this project is licensed under MIT license.
 * [grafana](https://github.com/grafana/grafana)
 
 Inspired by [Izak Marai's grafana reporter](https://github.com/IzakMarais/reporter)
-
-## Donations
-
-If you like this project and you would like to support my work, feel free to donate. :)
-
-[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/donate?hosted_button_id=35LH6JNLPHPHQ)

data/bin/ruby-grafana-reporter

@@ -2,4 +2,4 @@
 # frozen_string_literal: true
 
 require_relative '../lib/ruby_grafana_reporter'
-GrafanaReporter::Application::Application.new.configure_and_run(ARGV) unless defined?(Ocra)
+GrafanaReporter::Application::Application.new.configure_and_run(ARGV) unless defined?(Ocran)

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 6, 2].freeze
+GRAFANA_REPORTER_VERSION = [0, 6, 6].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2022-09-14'
+GRAFANA_REPORTER_RELEASE_DATE = '2024-02-22'

data/lib/grafana/grafana.rb

@@ -86,15 +86,8 @@ 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 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
+      clean_nil_datasources
+      datasource = @datasources.select { |ds_name, ds| ds.uid == datasource_uid }.values.first
       raise DatasourceDoesNotExistError.new('uid', datasource_uid) unless datasource
 
       datasource
@@ -105,7 +98,8 @@ module Grafana
     # @param datasource_id [Integer] id of the searched datasource
     # @return [Datasource] Datasource for the specified datasource id
     def datasource_by_id(datasource_id)
-      datasource = @datasources.select { |_name, ds| ds.id == datasource_id.to_i }.values.first
+      clean_nil_datasources
+      datasource = @datasources.select { |name, ds| ds.id == datasource_id.to_i }.values.first
       raise DatasourceDoesNotExistError.new('id', datasource_id) unless datasource
 
       datasource
@@ -171,7 +165,18 @@ module Grafana
           @datasources.delete(ds_name)
         end
       end
-      @datasources['default'] = @datasources[json['defaultDatasource']]
+
+      @datasources['default'] = @datasources[json['defaultDatasource']] if not @datasources[json['defaultDatasource']].nil?
+    end
+
+    def clean_nil_datasources
+      @datasources.delete_if do |name, ds|
+        if ds.nil?
+          # print debug info for https://github.com/divinity666/ruby-grafana-reporter/issues/29
+          @logger.warn("Datasource with name #{name} is nil, which should never happen. Check logs for details.")
+        end
+        ds.nil?
+      end
     end
   end
 end

data/lib/grafana/image_rendering_datasource.rb

@@ -16,7 +16,7 @@ module Grafana
       webrequest.relative_url = panel.render_url + url_params(query_description)
       webrequest.options.merge!({ accept: 'image/png' })
 
-      result = webrequest.execute
+      result = webrequest.execute(query_description[:timeout])
 
       raise ImageCouldNotBeRenderedError, panel if result.body.include?('<html')
 
@@ -26,7 +26,7 @@ module Grafana
     private
 
     def url_params(query_desc)
-      url_vars = query_desc[:variables].select { |k, _v| k =~ /^(?:timeout|height|width|theme|fullscreen|var-.+)$/ }
+      url_vars = query_desc[:variables].select { |k, _v| k =~ /^(?:timeout|scale|height|width|theme|fullscreen|var-.+)$/ }
       url_vars = default_vars.merge(url_vars)
       url_vars['from'] = Variable.new(query_desc[:from])
       url_vars['to'] = Variable.new(query_desc[:to])

data/lib/grafana/influxdb_datasource.rb

@@ -31,11 +31,36 @@ module Grafana
       query = query.gsub(/\$(?:__)?interval(?=\W|$)/, "#{interval.is_a?(String) ? interval : "#{(interval / 1000).to_i}s"}")
       query = query.gsub(/\$(?:__)?interval_ms(?=\W|$)/, "#{interval}")
 
-      url = "/api/datasources/proxy/#{id}/query?db=#{@model['database']}&q=#{ERB::Util.url_encode(query)}&epoch=ms"
-
       webrequest = query_description[:prepared_request]
-      webrequest.relative_url = url
-      webrequest.options.merge!({ request: Net::HTTP::Get })
+      request = {}
+
+      ver = query_description[:grafana_version].split('.').map{|x| x.to_i}
+      if ver[0] >= 8
+        webrequest.relative_url = "/api/ds/query?ds_type=influxdb"
+
+        request = {
+          request: Net::HTTP::Post,
+          body: {
+            from: query_description[:from],
+            to: query_description[:to],
+            queries: [
+              {
+                datasource: {type: "influxdb"},
+                datasourceId: id,
+                intervalMs: interval,
+                query: query
+              }
+          ]}.to_json
+        }
+      else
+        webrequest.relative_url = "/api/datasources/proxy/#{id}/query?db=#{@model['database']}&q=#{ERB::Util.url_encode(query)}&epoch=ms"
+        request = {
+          request: Net::HTTP::Get
+        }
+      end
+
+      webrequest.options.merge!(request)
+
 
       result = webrequest.execute(query_description[:timeout])
       preformat_response(result.body)
@@ -43,7 +68,7 @@ module Grafana
 
     # @see AbstractDatasource#raw_query_from_panel_model
     def raw_query_from_panel_model(panel_query_target)
-      return panel_query_target['query'] if panel_query_target['rawQuery']
+      return panel_query_target['query'] if panel_query_target['query'] or panel_query_target['rawQuery']
 
       # build composed queries
       build_select(panel_query_target['select']) + build_from(panel_query_target) + build_where(panel_query_target['tags']) + build_group_by(panel_query_target['groupBy'])

data/lib/grafana_reporter/abstract_report.rb

@@ -138,7 +138,7 @@ module GrafanaReporter
 
       # automatically add extension, if a file with default template extension exists
       @template = "#{@template}.#{self.class.default_template_extension}" if File.file?("#{@template}.#{self.class.default_template_extension}") && !File.file?(@template.to_s)
-      raise MissingTemplateError, @template.to_s unless File.file?(@template.to_s)
+      raise MissingTemplateError, "#{@template}.#{self.class.default_template_extension}" unless File.file?(@template.to_s)
 
       notify(:on_before_create)
       @start_time = Time.new

data/lib/grafana_reporter/application/application.rb

@@ -34,8 +34,8 @@ module GrafanaReporter
         action_wizard = false
 
         parser = OptionParser.new do |opts|
-          opts.banner = if ENV['OCRA_EXECUTABLE']
-                          "Usage: #{ENV['OCRA_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '')} [options]"
+          opts.banner = if ENV['OCRAN_EXECUTABLE']
+                          "Usage: #{ENV['OCRAN_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '')} [options]"
                         else
                           "Usage: #{Gem.ruby} #{$PROGRAM_NAME} [options]"
                         end

data/lib/grafana_reporter/application/webservice.rb

@@ -91,8 +91,8 @@ module GrafanaReporter
             @logger.error(e.message)
             socket.write http_response(400, 'Bad Request', e.message)
           rescue StandardError => e
-            @logger.fatal(e.message)
-            socket.write http_response(400, 'Bad Request', e.message)
+            @logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+            socket.write http_response(400, 'Bad Request', "#{e.message}\n#{e.backtrace.join("\n")}")
           ensure
             socket.close
           end

data/lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb

@@ -76,8 +76,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          reader.unshift_line "|#{e.message}"
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          reader.unshift_line "|#{e.message}\n#{e.backtrace.join("\n")}"
         end
 
         reader

data/lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb

@@ -75,8 +75,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          reader.unshift_line "|#{e.message}"
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          reader.unshift_line "|#{e.message}\n#{e.backtrace.join("\n")}"
         end
 
         reader

data/lib/grafana_reporter/asciidoctor/help.rb

@@ -391,6 +391,9 @@ end}
               render-width:
                 description: can be used to override default `width` in which the panel shall be rendered
                 call: render-width="<width>"
+              render-scale:
+                description: can be used to override default scale in which the panel shall be rendered
+                call: render-scale="<scale>"
               render-theme:
                 description: can be used to override default `theme` in which the panel shall be rendered (light by default)
                 call: render-theme="<theme>"

data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb

@@ -56,8 +56,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           return create_paragraph(parent, e.message, attrs)
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          return create_paragraph(parent, e.message, attrs)
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          return create_paragraph(parent, "#{e.message}\n#{e.backtrace.join("\n")}", attrs)
         end
 
         attrs['target'] = image_path

data/lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb

@@ -58,8 +58,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           return create_inline(parent, :quoted, e.message)
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          return create_inline(parent, :quoted, e.message)
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          return create_inline(parent, :quoted, "#{e.message}\n#{e.backtrace.join("\n")}")
         end
 
         create_inline(parent, :image, nil, { target: image_path, attributes: attrs })

data/lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb

@@ -50,8 +50,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           return create_inline(parent, :quoted, e.message)
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          return create_inline(parent, :quoted, e.message)
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          return create_inline(parent, :quoted, "#{e.message}\n#{e.backtrace.join("\n")}")
         end
 
         # translate linebreaks to asciidoctor syntax

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -70,8 +70,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          reader.unshift_line "|#{e.message}"
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          reader.unshift_line "|#{e.message}\n#{e.backtrace.join("\n")}"
         end
 
         reader

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -66,8 +66,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           create_inline(parent, :quoted, e.message)
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          create_inline(parent, :quoted, e.message)
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          create_inline(parent, :quoted, "#{e.message}\n#{e.backtrace.join("\n")}")
         end
       end
 

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

@@ -64,8 +64,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          reader.unshift_line "|#{e.message}"
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          reader.unshift_line "|#{e.message}\n#{e.backtrace.join("\n")}"
         end
 
         reader

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -71,8 +71,8 @@ module GrafanaReporter
           @report.logger.error(e.message)
           create_inline(parent, :quoted, e.message)
         rescue StandardError => e
-          @report.logger.fatal(e.message)
-          create_inline(parent, :quoted, e.message)
+          @report.logger.fatal("#{e.message}\n#{e.backtrace.join("\n")}")
+          create_inline(parent, :quoted, "#{e.message}\n#{e.backtrace.join("\n")}")
         end
       end
 

data/lib/grafana_reporter/console_configuration_wizard.rb

@@ -32,7 +32,7 @@ module GrafanaReporter
       demo_report ||= '<<your_report_name>>'
       config_param = config_file == Configuration::DEFAULT_CONFIG_FILE_NAME ? '' : " -c #{config_file}"
       program_call = "#{Gem.ruby} #{$PROGRAM_NAME}"
-      program_call = ENV['OCRA_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '') if ENV['OCRA_EXECUTABLE']
+      program_call = ENV['OCRAN_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '') if ENV['OCRAN_EXECUTABLE']
 
       puts
       puts 'Now everything is setup properly. Create your reports as required in the templates '\

data/lib/grafana_reporter/errors.rb

@@ -50,7 +50,7 @@ module GrafanaReporter
   # Thrown if a non existing template has been specified.
   class MissingTemplateError < ConfigurationError
     def initialize(template)
-      super("Given report template '#{template}' is not a valid template.")
+      super("Accessing report template file '#{template}' is not possible. Check if file exists and is accessible.")
     end
   end
 

data/lib/ruby_grafana_reporter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rubygems'
+require 'rubygems/ext'
 require 'net/http'
 require 'fileutils'
 require 'yaml'

metadata

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