ruby-grafana-reporter 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e06395c66d098c01d5248872f7aac2bc8dd36c4f9c6f02774ffe022fd0cafc9f
-  data.tar.gz: 6ad05dfac340497fb0be61b14b6420a348b05dbd71b14e17b55553573cfcf3b8
+  metadata.gz: 49639b5da410d46b0ad6cf16a187a3f30389fac610497de09d1e1466a66f22f5
+  data.tar.gz: 673791b6d38cd46e54292903f07e0fdd16070f5e0abf999565fecf04b930efbb
 SHA512:
-  metadata.gz: 769a0c9258678b32100b21e38782ca668467ad2e016e63e3bc293d96311bb06d74b0b2a71f4033a576c71c94185e072ad37ac55d8d4cdc13a516a92f6c359895
-  data.tar.gz: 53a645d2db1eac77ed0e6977932b2947eb41efccf33f49f77db6c7ea4254ebd2f0c299fb1211546356734b744ca6359f36f392ae3afcf4243c835da3c7671bfa
+  metadata.gz: d4bb03253d7681c580c96f11e5e86112e036087b927ff01e0e490bebeb4aeadd5f213f9de7202007523b8bf384ed36f6fcc040d5b81aa5aceef88c7cb191ab50
+  data.tar.gz: d3695d4d6ce451c01e7ad33a28a942f697d019215cca603827bda44af488e292c4befaf658d266e19b5ca3e84ab1a06cbc5f4f5e189d262b5c8bb415c4ae1013

data/README.md

@@ -20,7 +20,20 @@ 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! I provide you this software free of charge. I have already
+spend a lot of my private time in developing, maintaining and supporting it.
+
+If you enjoy my work, feel free to
+
+[![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
 
@@ -35,6 +48,10 @@ dashboards and to use it in your custom templates to finally create reports in P
 
 By default (an extended version of) Asciidoctor is enabled as template language.
 
+## Getting started
+
+![GettingStarted](./assets/GettingStartedAnimation.gif)
+
 ## Features
 
 * Supports creation of reports for multiple [grafana](https://github.com/grafana/grafana)
@@ -136,8 +153,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 +187,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 +373,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, 3].freeze
+GRAFANA_REPORTER_VERSION = [0, 7, 0].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2023-01-08'
+GRAFANA_REPORTER_RELEASE_DATE = '2024-05-19'

data/lib/grafana/grafana.rb

@@ -68,6 +68,23 @@ module Grafana
       'NON-Admin'
     end
 
+    # Returns the datasource, which has been queried by model entry in the panel model.
+    #
+    # @param model_entry [Object] model entry of the searched datasource (e.g. String or Hash)
+    # @return [Datasource] Datasource for the specified datasource model entry
+    def datasource_by_model_entry(model_entry)
+      datasource = nil
+      if model_entry.is_a?(String)
+        datasource = datasource_by_name(model_entry)
+      elsif model_entry.is_a?(Hash)
+        datasource = datasource_by_uid(model_entry['uid'])
+      end
+
+      raise DatasourceDoesNotExistError.new('model entry', model_entry) unless datasource
+
+      datasource
+    end
+
     # Returns the datasource, which has been queried by the datasource name.
     #
     # @param datasource_name [String] name of the searched datasource
@@ -86,6 +103,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)
+      raise DatasourceDoesNotExistError.new('uid', datasource_uid) unless datasource_uid
+
       clean_nil_datasources
       datasource = @datasources.select { |ds_name, ds| ds.uid == datasource_uid }.values.first
       raise DatasourceDoesNotExistError.new('uid', datasource_uid) unless datasource

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_query.rb

@@ -383,7 +383,7 @@ module GrafanaReporter
         delta_match = date_spec.match(/^(?<op>(?:-|\+))(?<count>\d+)?(?<unit>[smhdwMy])/)
         if delta_match
           date = delta_date(date, "#{delta_match[:op]}#{delta_match[:count] || 1}".to_i, delta_match[:unit])
-          date_spec = date_spec.gsub(/^#{delta_match[:op]}#{delta_match[:count]}#{delta_match[:unit]}/, '')
+          date_spec = date_spec.gsub(/^#{delta_match[:op] == '+' ? '\+' : '-'}#{delta_match[:count]}#{delta_match[:unit]}/, '')
         end
 
         raise TimeRangeUnknownError, orig_date unless fit_match || delta_match

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/asciidoctor/help.rb

@@ -229,6 +229,12 @@ end}
                 escaped by using `_,`. Execution of related functions is applied in the following order
                 `format`, `replace_values`, `filter_columns`, `transpose`.
 
+            select_value:
+              call: select_value="<select_value>"
+              description: >-
+                Allows the selection of a specific value from the result set.  Supported options are `min`, `max`, `avg`,
+                `sum`, `first`, `last`.
+
             transpose:
               call: transpose="true"
               description: >-
@@ -391,6 +397,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>"
@@ -453,6 +462,7 @@ end}
               from:
               instance:
               replace_values:
+              select_value:
               timeout:
               to:
               from_timezone:
@@ -502,6 +512,7 @@ end}
               from:
               instance:
               replace_values:
+              select_value:
               timeout:
               to:
               from_timezone:

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -80,7 +80,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'].include?('table')
 
         ref_id = nil
         panel.model['targets'].each do |item|

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -74,7 +74,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'] == 'singlestat'
 
         ref_id = nil
         panel.model['targets'].each do |item|

data/lib/grafana_reporter/asciidoctor/processor_mixin.rb

@@ -40,7 +40,7 @@ module GrafanaReporter
           k =~ /^(?:timeout|from|to)$/ ||
           k =~ /filter_columns|format|replace_values_.*|transpose|from_timezone|
                to_timezone|result_type|query|table_formatter|include_headline|
-               column_divider|row_divider|instant|interval|verbose_log/x
+               column_divider|row_divider|instant|interval|verbose_log|select_value/x
         end)
 
         result

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

@@ -74,7 +74,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'].include?('table')
 
         ref_id = nil
         panel.model['targets'].each do |item|
@@ -85,8 +84,8 @@ module GrafanaReporter
         end
         return nil unless ref_id
 
-        "|===\ninclude::grafana_sql_table:#{panel.dashboard.grafana.datasource_by_name(panel.model['datasource']).id}"\
-        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",filter_columns=\"time\","\
+        "|===\ninclude::grafana_sql_table:#{panel.dashboard.grafana.datasource_by_model_entry(panel.model['datasource']).id}"\
+        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\r\n", ' ').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",filter_columns=\"time\","\
         "dashboard=\"#{panel.dashboard.id}\",from=\"now-1h\",to=\"now\"]\n|==="
       end
     end

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -79,7 +79,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'] == 'singlestat'
 
         ref_id = nil
         panel.model['targets'].each do |item|
@@ -90,8 +89,8 @@ module GrafanaReporter
         end
         return nil unless ref_id
 
-        "grafana_sql_value:#{panel.dashboard.grafana.datasource_by_name(panel.model['datasource']).id}"\
-        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",from=\"now-1h\","\
+        "grafana_sql_value:#{panel.dashboard.grafana.datasource_by_model_entry(panel.model['datasource']).id}"\
+        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\r\n", ' ').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",from=\"now-1h\","\
         'to="now"]'
       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
 
@@ -79,6 +79,15 @@ module GrafanaReporter
     end
   end
 
+  # Thrown, if the value configuration in {QueryValueQuery#select_value} is
+  # invalid.
+  class UnsupportedSelectValueStatementError < GrafanaReporterError
+    def initialize(statement)
+      super("Unsupported 'select_value' specified in template file: '#{statement}'. Supported values are 'min', 'max', "\
+            "'avg', 'sum', 'first', 'last'.")
+    end
+  end
+
   # Thrown, if a configured parameter is malformed.
   class MalformedAttributeContentError < GrafanaReporterError
     def initialize(message, attribute, content)

data/lib/grafana_reporter/query_value_query.rb

@@ -33,7 +33,30 @@ module GrafanaReporter
 
       when /(?:panel_value|sql_value)/
         tmp = @result[:content] || []
-        @result = tmp.flatten.first
+        # use only first column of return values and replace null values with zero
+        tmp = tmp.map{ |item| item[0] || 0 }
+
+        # as default behaviour we fallback to the first_value, as this was the default in older releases
+        select_value = 'first'
+        select_value = @variables['select_value'].raw_value if @variables['select_value']
+        case select_value
+        when 'min'
+          result = tmp.min
+        when 'max'
+          result = tmp.max
+        when 'avg'
+          result = tmp.size > 0 ? tmp.sum / tmp.size : 0
+        when 'sum'
+          result = tmp.sum
+        when 'last'
+          result = tmp.last
+        when 'first'
+          result = tmp.first
+        else
+          raise UnsupportedSelectValueStatementError, @variables['select_value'].raw_value
+        end
+
+        @result = result
 
       else
         raise StandardError, "Unsupported 'result_type' received: '#{@variables['result_type'].raw_value}'"

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.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-08 00:00:00.000000000 Z
+date: 2024-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Reporter Service for Grafana