ruby-grafana-reporter 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49639b5da410d46b0ad6cf16a187a3f30389fac610497de09d1e1466a66f22f5
-  data.tar.gz: 673791b6d38cd46e54292903f07e0fdd16070f5e0abf999565fecf04b930efbb
+  metadata.gz: b3d762755e84f775f00d04fe0333389ae011fbf0ed1b13942cd006599e60e0e2
+  data.tar.gz: 29c72d42855e2de7ecd43cbced9d6339c36312deebe05fc5210b80928e0d7894
 SHA512:
-  metadata.gz: d4bb03253d7681c580c96f11e5e86112e036087b927ff01e0e490bebeb4aeadd5f213f9de7202007523b8bf384ed36f6fcc040d5b81aa5aceef88c7cb191ab50
-  data.tar.gz: d3695d4d6ce451c01e7ad33a28a942f697d019215cca603827bda44af488e292c4befaf658d266e19b5ca3e84ab1a06cbc5f4f5e189d262b5c8bb415c4ae1013
+  metadata.gz: 2efa68036513d9d7c73ad13296e369bd0c945bf97dd5101f288b3c646443bbc95af0d96f876ab1c23d1424d2f450c1618d24e58705ecbfd406b31adfdd1c7871
+  data.tar.gz: b37f3d569f59a2ae22bea51894cde019ca395c253a4c62d83cbbfd9cd692010e327996c98fb1f0711f8f4ba396cd1eda35b203ebec7c92d95a855218aeb09fdd

data/README.md

@@ -9,10 +9,12 @@ Reporting Service for Grafana
 ## Table of Contents
 
 * [About the project](#about-the-project)
-* [Features](#features)
-* [Supported datasources](#supported-datasources)
-* [Quick Start](#quick-start)
-  * [Setup](#setup)
+* [Getting started](#getting-started)
+  * [Use cases](#use-cases)
+  * [Features](#features)
+  * [Supported datasources](#supported-datasources)
+* [Setup](#setup)
+  * [Installation](#installation)
   * [Grafana integration](#grafana-integration)
 * [Advanced information](#advanced-information)
   * [Webservice](#webservice)
@@ -50,9 +52,15 @@ By default (an extended version of) Asciidoctor is enabled as template language.
 
 ## Getting started
 
-![GettingStarted](./assets/GettingStartedAnimation.gif)
+![GettingStarted](https://github.com/divinity666/ruby-grafana-reporter/blob/master/.assets/GettingStartedAnimation.gif)
 
-## Features
+### Use cases
+
+* Create an automated PDF report about your server infrastructure health for your management
+* Allow users to build an on-demand CSV file containing data shown on your dashboard, for further use in Excel
+* Export your home meter data as a static web-page, that you can publish to the web
+
+### Features
 
 * Supports creation of reports for multiple [grafana](https://github.com/grafana/grafana)
 dashboards (and also multiple grafana installations!) in one resulting report
@@ -69,12 +77,13 @@ database queries
   * webservice to be called directly from grafana
   * standalone command line tool, e.g. to be automated with `cron` or `bash` scrips
   * microservice from standard asciidoctor docker container without any dependencies
-* Supports webhook callbacks on before, on cancel and on finishing a report (see
-configuration file)
-* Solid as a rock, also in case of template errors and whatever else may happen
+* Use webhook callbacks on before, on cancel and on finishing a report (see
+configuration file) to combine them with your services
+* Solid as a rock - no matter if you do mistakes in your configuration or grafana does no
+longer match templates: the ruby-grafana-reporter webservice will always return properly.
 * Full [API documentation](https://rubydoc.info/gems/ruby-grafana-reporter) available
 
-## Supported datasources
+### Supported datasources
 
 Functionalities are provided as shown here:
 
@@ -93,10 +102,10 @@ Composed queries are all kinds of query, where the grafana UI feature (aka visua
 mode) for query specifications are used. In this case grafana is translating the UI query
 specification to a raw query, which then in fact is sent to the database.
 
-## Quick Start
+## Setup
 
 
-### Setup
+### Installation
 
 You don't have a grafana setup runnning already? No worries, just configure
 `https://play.grafana.org` in the configuration wizard and see the magic
@@ -199,7 +208,7 @@ You may provide those variables during report generation to the reporter. Theref
 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
+to set this variable for a panel image rendering. This can be done with the following
 calls:
 
 ````

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 7, 0].freeze
+GRAFANA_REPORTER_VERSION = [0, 8, 0].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2024-05-19'
+GRAFANA_REPORTER_RELEASE_DATE = '2024-06-08'

data/lib/grafana/abstract_datasource.rb

@@ -39,7 +39,7 @@ module Grafana
     end
 
     def initialize(model)
-      @model = model
+      @model = model || {}
     end
 
     # @return [String] category of the datasource, e.g. +tsdb+ or +sql+

data/lib/grafana/grafana.rb

@@ -15,25 +15,27 @@ module Grafana
     #   trailing slash, e.g. +https://localhost:3000+.
     # @param key [String] API key for the grafana instance, if required
     # @param opts [Hash] additional options.
-    #   Currently supporting +:logger+.
+    #   Currently supporting +:logger+ and +:ssl_disable_verify+.
     def initialize(base_uri, key = nil, opts = {})
       @base_uri = base_uri
       @key = key
       @dashboards = {}
+      @organization = {}
       @logger = opts[:logger] || ::Logger.new(nil)
+      @ssl_disable_verify = opts[:ssl_disable_verify] || false
+      @ssl_cert = opts[:ssl_cert]
 
       initialize_datasources unless @base_uri.empty?
     end
 
     # @return [Hash] Information about the current organization
     def organization
-      return @organization if @organization
+      return @organization unless @organization.empty?
 
       response = prepare_request({ relative_url: '/api/org/' }).execute
-      if response.is_a?(Net::HTTPOK)
-        @organization = JSON.parse(response.body)
-      end
+      return @organization unless response.is_a?(Net::HTTPOK)
 
+      @organization = JSON.parse(response.body)
       @organization
     end
 
@@ -42,10 +44,9 @@ module Grafana
       return @version if @version
 
       response = prepare_request({ relative_url: '/api/health' }).execute
-      if response.is_a?(Net::HTTPOK)
-        @version = JSON.parse(response.body)['version']
-      end
+      return @version unless response.is_a?(Net::HTTPOK)
 
+      @version = JSON.parse(response.body)['version']
       @version
     end
 
@@ -54,15 +55,24 @@ module Grafana
     # Running this function also determines, if the API configured here has Admin or NON-Admin privileges,
     # or even fails on connecting to grafana.
     #
-    # @return [String] +Admin+, +NON-Admin+ or +Failed+ is returned, depending on the test results
+    # @return [String] +Admin+, +NON-Admin+, +SSLError+ or +Failed+ is returned, depending on the test results
     def test_connection
+      @logger.warn('Reporter disabled the SSL verification for grafana. This is a potential security risk.') if @ssl_disable_verify
+
       if prepare_request({ relative_url: '/api/datasources' }).execute.is_a?(Net::HTTPOK)
         # we have admin rights
         @logger.warn('Reporter is running with Admin privileges on grafana. This is a potential security risk.')
         return 'Admin'
       end
-      # check if we have lower rights
-      return 'Failed' unless prepare_request({ relative_url: '/api/dashboards/home' }).execute.is_a?(Net::HTTPOK)
+
+      # check if we have lower rights or an SSL error occurs
+      case prepare_request({ relative_url: '/api/dashboards/home' }).execute(nil, true)
+      when Net::HTTPOK
+      when OpenSSL::SSL::SSLError
+        return 'SSLError'
+      else
+        return 'Failed'
+      end
 
       @logger.info('Reporter is running with NON-Admin privileges on grafana.')
       'NON-Admin'
@@ -141,7 +151,7 @@ module Grafana
     # @param dashboard_uid [String] UID of the searched {Dashboard}
     # @return [Dashboard] dashboard object, if it has been found
     def dashboard(dashboard_uid)
-      return @dashboards[dashboard_uid] unless @dashboards[dashboard_uid].nil?
+      return @dashboards[dashboard_uid] if @dashboards[dashboard_uid]
 
       response = prepare_request({ relative_url: "/api/dashboards/uid/#{dashboard_uid}" }).execute
       raise DashboardDoesNotExistError, dashboard_uid unless response.is_a?(Net::HTTPOK)
@@ -163,7 +173,7 @@ module Grafana
     # @return [WebRequest] webrequest prepared for execution
     def prepare_request(options = {})
       auth = @key ? { authorization: "Bearer #{@key}" } : {}
-      WebRequest.new(@base_uri, auth.merge({ logger: @logger }).merge(options))
+      WebRequest.new(@base_uri, auth.merge({ logger: @logger, ssl_disable_verify: @ssl_disable_verify, ssl_cert: @ssl_cert }).merge(options))
     end
 
     private
@@ -183,6 +193,9 @@ module Grafana
           @logger.error("Datasource with name '#{ds_name}' and configuration: '#{ds_value}' could not be initialized.")
           @datasources.delete(ds_name)
         end
+      rescue OpenSSL::SSL::SSLError => e
+        @logger.error(e.message)
+
       end
 
       @datasources['default'] = @datasources[json['defaultDatasource']] if not @datasources[json['defaultDatasource']].nil?

data/lib/grafana/grafana_alerts_datasource.rb

@@ -22,6 +22,7 @@ module Grafana
       webrequest.relative_url = "/api/alerts#{url_parameters(query_description)}"
 
       result = webrequest.execute(query_description[:timeout])
+      return unless result
 
       json = JSON.parse(result.body)
 

data/lib/grafana/grafana_annotations_datasource.rb

@@ -21,6 +21,7 @@ module Grafana
       webrequest.relative_url = "/api/annotations#{url_parameters(query_description)}"
 
       result = webrequest.execute(query_description[:timeout])
+      return unless result
 
       json = JSON.parse(result.body)
 

data/lib/grafana/webrequest.rb

@@ -5,12 +5,6 @@ module Grafana
   class WebRequest
     attr_accessor :relative_url, :options
 
-    @ssl_cert = nil
-
-    class << self
-      attr_accessor :ssl_cert
-    end
-
     # Initializes a specific HTTP request.
     #
     # Default (can be overridden, by specifying the options Hash):
@@ -23,16 +17,19 @@ module Grafana
     def initialize(base_url, options = {})
       @base_url = base_url
       default_options = { accept: 'application/json', request: Net::HTTP::Get, content_type: 'application/json' }
-      @options = default_options.merge(options.reject { |k, _v| k == :logger && k == :relative_url })
+      @options = default_options.merge(options.reject { |k, _v| k == :logger && k == :relative_url && k == :ssl_disable_verify })
       @relative_url = options[:relative_url]
       @logger = options[:logger] || Logger.new(nil)
+      @ssl_disable_verify = options[:ssl_disable_verify] || false
+      @ssl_cert = options[:ssl_cert]
     end
 
     # Executes the HTTP request
     #
     # @param timeout [Integer] number of seconds to wait, before the http request is cancelled, defaults to 60 seconds
+    # @param return_ssl_error [Boolean] True, if the SSL error object shall be returned on SSL error
     # @return [Response] HTTP response object
-    def execute(timeout = nil)
+    def execute(timeout = nil, return_ssl_error = false)
       timeout ||= 60
 
       uri = URI.parse("#{@base_url}#{@relative_url}")
@@ -48,7 +45,13 @@ module Grafana
       request.body = @options[:body]
 
       @logger.debug("Requesting #{uri} with '#{@options[:body]}' and timeout '#{timeout}'")
-      response = @http.request(request)
+      begin
+        response = @http.request(request)
+      rescue OpenSSL::SSL::SSLError => e
+        @logger.error(e.message)
+        return e if return_ssl_error
+        return nil
+      end
       @logger.debug("Received response #{response}")
       @logger.debug("HTTP response body: #{response.body}") unless response.code =~ /^2.*/
 
@@ -59,13 +62,21 @@ module Grafana
 
     def configure_ssl
       @http.use_ssl = true
-      @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      if self.class.ssl_cert && !File.file?(self.class.ssl_cert)
-        @logger.warn('SSL certificate file does not exist.')
-      elsif self.class.ssl_cert
+
+      # allow OpenSSL::SSL::VERIFY_NONE if explicitly specified
+      if @ssl_disable_verify
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      else
+        @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      end
+
+      if @ssl_cert && !File.file?(@ssl_cert)
+        @logger.warn("SSL certificate file '#{@ssl_cert}' does not exist.")
+      elsif @ssl_cert
+        @logger.debug("Using ssl certificate '#{@ssl_cert}'.")
         @http.cert_store = OpenSSL::X509::Store.new
         @http.cert_store.set_default_paths
-        @http.cert_store.add_file(self.class.ssl_cert)
+        @http.cert_store.add_file(@ssl_cert)
       end
     end
   end

data/lib/grafana_reporter/abstract_query.rb

@@ -140,7 +140,6 @@ module GrafanaReporter
     def transpose(result, transpose_variable)
       return result unless transpose_variable
       return result unless transpose_variable.raw_value == 'true'
-
       result[:content] = result[:content].transpose
 
       result
@@ -202,8 +201,8 @@ module GrafanaReporter
               row[i] = format % row[i] if row[i]
             end
           rescue StandardError => e
-            @logger.error(e.message)
-            row[i] = e.message
+            @logger.warn("Formatting of row #{i} with content '#{row[i]}' and format request '#{format}'"\
+                         " was not possible. Row is left unchanged (message: #{e.message})")
           end
         end
       end
@@ -395,6 +394,30 @@ module GrafanaReporter
       (Time.at(date.to_time.to_i).to_i * 1000).to_s
     end
 
+    # Applies a given action string, separated by commas, in the given order to the results.
+    def apply(result, actions, variables)
+      actions.raw_value.split(',').each do |action|
+        case action.strip
+        when 'filter_columns'
+          result = filter_columns(result, variables['filter_columns'])
+        when 'format'
+          result = format_columns(result, variables['format'])
+        when 'replace_values'
+          result = replace_values(result, variables.select { |k, _v| k =~ /^replace_values_\d+/ })
+        when 'transpose!'
+          result = transpose(result, Variable.new('true'))
+        when 'transpose'
+          result = transpose(result, variables['transpose'])
+        else
+          @logger.warn("Unsupported action '#{action}' configured in 'after_fetch' or 'after_calculate'. Only" \
+                       " the following options are supported: filter_columns, format, replace_values, transpose,"\
+                       " transpose!")
+        end
+      end
+
+      result
+    end
+
     private
 
     # Used to specify variables to be used for this query. This method ensures, that only the values of the

data/lib/grafana_reporter/abstract_report.rb

@@ -64,6 +64,8 @@ module GrafanaReporter
       unless @grafana_instances[instance]
         @grafana_instances[instance] = ::Grafana::Grafana.new(@config.grafana_host(instance),
                                                               @config.grafana_api_key(instance),
+                                                              ssl_disable_verify: @config.grafana_ssl_disable_verify(instance),
+                                                              ssl_cert: @config.grafana_ssl_cert(instance),
                                                               logger: @logger)
       end
       @grafana_instances[instance]

data/lib/grafana_reporter/alerts_table_query.rb

@@ -20,18 +20,18 @@ module GrafanaReporter
       raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
 
       @datasource = Grafana::GrafanaAlertsDatasource.new(nil)
+      @variables['after_fetch'] ||= ::Grafana::Variable.new('filter_columns')
+      @variables['after_calculate'] ||= ::Grafana::Variable.new('format,replace_values,transpose')
     end
 
     # Filter the query result for the given columns and sets the result in the preformatted SQL
     # result stlye.
     #
-    # Additionally it applies {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
-    # {AbstractQuery#filter_columns}.
+    # Additionally it applies 'after_fetch' and 'after_calculate' actions.
     # @return [void]
     def post_process
-      @result = format_columns(@result, @variables['format'])
-      @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
-      @result = filter_columns(@result, @variables['filter_columns'])
+      @result = apply(@result, @variables['after_fetch'], @variables)
+      @result = apply(@result, @variables['after_calculate'], @variables)
 
       @result = format_table_output(@result,
                                     row_divider: @variables['row_divider'],

data/lib/grafana_reporter/annotations_table_query.rb

@@ -19,18 +19,18 @@ module GrafanaReporter
       raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
 
       @datasource = Grafana::GrafanaAnnotationsDatasource.new(nil)
+      @variables['after_fetch'] ||= ::Grafana::Variable.new('filter_columns')
+      @variables['after_calculate'] ||= ::Grafana::Variable.new('format,replace_values,transpose')
     end
 
     # Filters the query result for the given columns and sets the result
     # in the preformatted SQL result style.
     #
-    # Additionally it applies {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
-    # {AbstractQuery#filter_columns}.
+    # Additionally it applies 'after_fetch' and 'after_calculate' actions.
     # @return [void]
     def post_process
-      @result = format_columns(@result, @variables['format'])
-      @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
-      @result = filter_columns(@result, @variables['filter_columns'])
+      @result = apply(@result, @variables['after_fetch'], @variables)
+      @result = apply(@result, @variables['after_calculate'], @variables)
 
       @result = format_table_output(@result,
                                     row_divider: @variables['row_divider'],

data/lib/grafana_reporter/application/application.rb

@@ -64,15 +64,6 @@ module GrafanaReporter
             tmp_config.set_param("default-document-attributes:#{list[0]}", list[1])
           end
 
-          opts.on('--ssl-cert FILE', 'Manually specify a SSL cert file for HTTPS connection to grafana. Only '\
-                  'needed if not working properly otherwise.') do |file|
-            if File.file?(file)
-              tmp_config.set_param('grafana-reporter:ssl-cert', file)
-            else
-              config.logger.warn("SSL certificate file #{file} does not exist. Setting will be ignored.")
-            end
-          end
-
           opts.on('--test GRAFANA_INSTANCE', 'test current configuration against given GRAFANA_INSTANCE') do |instance|
             tmp_config.set_param('grafana-reporter:run-mode', 'test')
             tmp_config.set_param('grafana-reporter:test-instance', instance)
@@ -134,6 +125,8 @@ module GrafanaReporter
         when Configuration::MODE_CONNECTION_TEST
           res = Grafana::Grafana.new(config.grafana_host(config.test_instance),
                                      config.grafana_api_key(config.test_instance),
+                                     ssl_cert: config.grafana_ssl_cert(config.test_instance),
+                                     ssl_disable_verify: config.grafana_ssl_disable_verify(config.test_instance),
                                      logger: config.logger).test_connection
           puts res
 

data/lib/grafana_reporter/asciidoctor/help.rb

@@ -194,6 +194,26 @@ end}
               call: to="<timestamp>"
               description: can be used to override default `to` time
 
+            after_fetch:
+              call: after_fetch="<action_1>,<action_2>,..."
+              description: >-
+                Specify the actions, that shall be performed after the query data has been fetched (and before
+                `select_value` calculations are performed). Possible values are: `format`, `replace_values`,
+                `filter_columns`, `transpose` and `transpose!`. `transpose!` enforces a transposition of the
+                table, independent from the configuration `transpose="true"`, which can specifically be useful,
+                if a table is being transposed twice.
+                Default: `filter_columns`
+
+            after_calculate:
+              call: after_calculate="<action_1>,<action_2>,..."
+              description: >-
+                Specify the actions, that shall be performed after the query calculations have been finished,
+                i.e. after `select_value` calculations have been performed. Possible values are: `format`,
+                `replace_values`, `filter_columns`, `transpose` and `transpose!`. `transpose!` enforces a
+                transposition of the table, independent from the configuration `transpose="true"`, which can
+                specifically be useful, if a table is being transposed twice.
+                Default: `format,replace_values,transpose`
+
             format:
               call: format="<format_col1>,<format_col2>,..."
               description: >-
@@ -202,8 +222,6 @@ end}
                 apply `%.2f` to the first column and `%.3f` to the second column. All other columns would not be
                 formatted. You may also format time in milliseconds to a time format by specifying e.g. `date:iso`.
                 Commas in format strings are supported, but have to be escaped by using `_,`.
-                Execution of related functions is applied in the following order `format`,
-                `replace_values`, `filter_columns`, `transpose`.
               see: 'https://ruby-doc.org/core/Kernel.html#method-i-sprintf'
 
             replace_values:
@@ -212,9 +230,7 @@ end}
                 Specify result values which shall be replaced, e.g. `2:OK` will replace query values `2` with value `OK`.
                 Replacing several values is possible by separating by `,`. Matches with regular expressions are also
                 supported, but must be full matches, i.e. have to start with `^` and end with `$`, e.g. `^[012]$:OK`.
-                Number replacements can also be performed, e.g. `<8.2` or `<>3`. Execution of related functions is
-                applied in the following order `format`,
-                `replace_values`, `filter_columns`, `transpose`.
+                Number replacements can also be performed, e.g. `<8.2` or `<>3`.
               see: https://ruby-doc.org/core/Regexp.html#class-Regexp-label-Character+Classes
 
             include_headline:
@@ -226,8 +242,7 @@ end}
               call: filter_columns="<column_name_1>,<column_name_2>,..."
               description: >-
                 Removes specified columns from result.  Commas in format strings are supported, but have to be
-                escaped by using `_,`. Execution of related functions is applied in the following order
-                `format`, `replace_values`, `filter_columns`, `transpose`.
+                escaped by using `_,`.
 
             select_value:
               call: select_value="<select_value>"
@@ -238,23 +253,23 @@ end}
             transpose:
               call: transpose="true"
               description: >-
-                Transposes the query result, i.e. columns become rows and rows become columnns. Execution of related
-                functions is applied in the following order `format`, `replace_values`, `filter_columns`,
-                `transpose`.
+                Transposes the query result, i.e. columns become rows and rows become columnns.
 
             column_divider:
               call: column_divider="<divider>"
               description: >-
                 Replace the default column divider with another one, when used in conjunction with `table_formatter` set to
-                `adoc_deprecated`. Defaults to ` | ` for being interpreted as a asciidoctor column. DEPRECATED: switch to
-                `table_formatter` named `adoc_plain`, or implement a custom table formatter.
+                `adoc_deprecated`. Defaults to ` | ` for being interpreted as a asciidoctor column. Note that this option is
+                DEPRECATED. As a replacement,  switch to `table_formatter` named `adoc_plain`, or implement a custom table
+                formatter.
 
             row_divider:
               call: row_divider="<divider>"
               description: >-
                 Replace the default row divider with another one, when used in conjunction with `table_formatter` set to
-                `adoc_deprecated`. Defaults to `| ` for being interpreted as a asciidoctor row. DEPRECATED: switch to
-                `table_formatter` named `adoc_plain`, or implement a custom table formatter.
+                `adoc_deprecated`. Defaults to `| ` for being interpreted as a asciidoctor row. Note that this option is
+                DEPRECATED. As a replacement, switch to `table_formatter` named `adoc_plain`, or implement a custom table
+                formatter.
 
             table_formatter:
               call: table_formatter="<formatter>"
@@ -323,6 +338,8 @@ end}
                   or `grafana_default_dashboard` is set.
                 call: panel="<panel_id>"
             standard_options:
+              after_calculate:
+              after_fetch:
               column_divider:
               dashboard: >-
                 If this option, or the global option `grafana_default_dashboard` is set, the resulting alerts will be limited to
@@ -359,6 +376,8 @@ end}
                   `grafana_default_dashboard` is set.
                 call: panel="<panel_id>"
             standard_options:
+              after_calculate:
+              after_fetch:
               column_divider:
               dashboard: >-
                 If this option, or the global option `grafana_default_dashboard` is set, the resulting alerts will be limited to this
@@ -426,6 +445,8 @@ end}
                 call: query="<query_letter>"
                 description: +<query_letter>+ needs to point to the grafana query which shall be evaluated, e.g. +A+ or +B+.
             standard_options:
+              after_calculate:
+              after_fetch:
               column_divider:
               dashboard:
               filter_columns:
@@ -456,6 +477,8 @@ end}
                 call: query="<query_letter>"
                 description: +<query_letter>+ needs to point to the grafana query which shall be evaluated, e.g. +A+ or +B+.
             standard_options:
+              after_calculate:
+              after_fetch:
               dashboard:
               filter_columns:
               format:
@@ -478,6 +501,8 @@ end}
               Grafana variables will be replaced in the SQL statement.
             see: https://grafana.com/docs/grafana/latest/variables/syntax/
             standard_options:
+              after_calculate:
+              after_fetch:
               column_divider:
               filter_columns:
               format:
@@ -507,6 +532,8 @@ end}
               square brackets, i.e. +]+ needs to be replaced with +\\]+.
             see: https://grafana.com/docs/grafana/latest/variables/syntax/
             standard_options:
+              after_calculate:
+              after_fetch:
               filter_columns:
               format:
               from:

data/lib/grafana_reporter/asciidoctor/processor_mixin.rb

@@ -36,11 +36,12 @@ module GrafanaReporter
 
         result.merge!(item_hash.select do |k, _v|
           # TODO: specify accepted options for each processor class individually
-          k =~ /^(?:var-|render-)/ ||
-          k =~ /^(?:timeout|from|to)$/ ||
-          k =~ /filter_columns|format|replace_values_.*|transpose|from_timezone|
+          k.to_s =~ /^(?:var-|render-)/ ||
+          k.to_s =~ /^(?:timeout|from|to)$/ ||
+          k.to_s =~ /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|select_value/x
+               column_divider|row_divider|instant|interval|verbose_log|select_value|
+               after_fetch|after_calculate/x
         end)
 
         result

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

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

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

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

data/lib/grafana_reporter/configuration.rb

@@ -96,6 +96,18 @@ module GrafanaReporter
       get_config("grafana:#{instance}:api_key")
     end
 
+    # @param instance [String] grafana instance name, for which the value shall be retrieved.
+    # @return [String] configured 'ssl-cert' for the requested grafana instance.
+    def grafana_ssl_cert(instance = 'default')
+      get_config("grafana:#{instance}:ssl-cert")
+    end
+
+    # @param instance [String] grafana instance name, for which the value shall be retrieved.
+    # @return [String] configured 'ssl-disable-verify' for the requested grafana instance.
+    def grafana_ssl_disable_verify(instance = 'default')
+      get_config("grafana:#{instance}:ssl-disable-verify") || false
+    end
+
     # @return [String] configured folder, in which the report templates are stored including trailing slash.
     #   By default: current folder.
     def templates_folder
@@ -242,7 +254,6 @@ module GrafanaReporter
       @logger.level = Object.const_get("::Logger::Severity::#{debug_level}") if debug_level =~ /DEBUG|INFO|WARN|
                                                                                                 ERROR|FATAL|UNKNOWN/x
       self.report_class = Object.const_get(rep_class) if rep_class
-      ::Grafana::WebRequest.ssl_cert = get_config('grafana-reporter:ssl-cert')
 
       # register callbacks
       callbacks = get_config('grafana-reporter:callbacks')
@@ -323,7 +334,9 @@ module GrafanaReporter
                 Hash, 1, nil,
                 {
                   'host' => [String, 1, %r{^http(s)?://.+}],
-                  'api_key' => [String, 0, %r{^(?:[\w]+[=]*)?$}]
+                  'api_key' => [String, 0, %r{^(?:[\w]+[=]*)?$}],
+                  'ssl-disable-verify' => [TrueClass, 0, nil],
+                  'ssl-cert' => [String, 0, nil]
                 }
               ]
            }
@@ -342,7 +355,6 @@ module GrafanaReporter
             'report-class' => [String, 1, nil],
             'reports-folder' => [String, explicit ? 1 : 0, nil],
             'report-retention' => [Integer, explicit ? 1 : 0, nil],
-            'ssl-cert' => [String, 0, nil],
             'webservice-port' => [Integer, explicit ? 1 : 0, nil],
             'callbacks' => [Hash, 0, nil, { nil => [String, 1, nil] }]
           }

data/lib/grafana_reporter/console_configuration_wizard.rb

@@ -139,7 +139,9 @@ default-document-attributes:
         end
       end
 
-      grafana = ::Grafana::Grafana.new(config.grafana_host, config.grafana_api_key)
+      grafana = ::Grafana::Grafana.new(config.grafana_host, config.grafana_api_key,
+                                       ssl_cert: config.grafana_ssl_cert,
+                                       ssl_disable_verify: config.grafana_ssl_disable_verify)
       demo_report_content = DemoReportWizard.new(config.report_class.demo_report_classes).build(grafana)
 
       begin
@@ -155,32 +157,40 @@ default-document-attributes:
 
     def ui_config_grafana(config)
       valid = false
+
       url = nil
       api_key = nil
+      ssl_disable_verify = false
+      ssl_cert = nil
+
       until valid
         url ||= user_input('Specify grafana host', 'http://localhost:3000')
         print "Testing connection to '#{url}' #{api_key ? '_with_' : '_without_'} API key..."
         begin
           res = Grafana::Grafana.new(url,
                                      api_key,
+                                     ssl_disable_verify: ssl_disable_verify,
+                                     ssl_cert: ssl_cert,
                                      logger: config.logger).test_connection
+
         rescue StandardError => e
           puts
           puts e.message
+
         end
         puts 'done.'
 
         case res
         when 'Admin'
           tmp = user_input('Access to grafana is permitted as Admin, which is a potential security risk.'\
-                ' Do you want to use another [a]pi key, [r]e-enter url key or [i]gnore?', 'aRi')
+                ' Do you want to use another [a]pi key, [r]e-enter url key or [i]gnore?', 'R')
 
           case tmp
           when /(?:i|I)$/
             valid = true
 
           when /(?:a|A)$/
-            print 'Enter API key: '
+            print('Enter API key: ')
             api_key = gets.strip
 
           else
@@ -193,9 +203,52 @@ default-document-attributes:
           print 'Access to grafana is permitted as NON-Admin.'
           valid = true
 
+        when 'SSLError'
+          ssl_disable_verify = false
+          tmp = user_input('Could not connect to grafana, because of a SSL connection error. Do you want to provide the SSL'\
+                           ' [c]ertificate file, [d]isable SSL verification (POTENTIAL SECURITY RISK) or [i]gnore and proceed?', 'C')
+
+          case tmp
+          when /(?:i|I)$/
+            # skip this step
+
+          when /(?:d|D)$/
+            ssl_disable_verify = true
+
+          else
+            ssl_configured = false
+
+            until ssl_configured
+              print('Enter path and filename to SSL certificate: ')
+              ssl_cert = gets.strip
+
+              # check if file exists
+              unless File.exist?(ssl_cert)
+                tmp = user_input('Could not read SSL certificate file. Do you want to re-enter the path to the used SSL'\
+                                 ' [c]ertificate file or [s]kip configuration of SSL certificate file?', 'C')
+
+                case tmp
+                when /(?:s|S)$/
+                  ssl_configured = true
+                  ssl_cert = nil
+
+                else
+                  # try entering path again
+
+                end
+
+              else
+                # SSL file exists, try connecting with that file
+                ssl_configured = true
+
+              end
+            end
+
+          end
+
         else
           tmp = user_input("Grafana could not be accessed at '#{url}'. Do you want to use an [a]pi key,"\
-                ' [r]e-enter url, or [i]gnore and proceed?', 'aRi')
+                ' [r]e-enter url, or [i]gnore and proceed?', 'R')
 
           case tmp
           when /(?:i|I)$/
@@ -215,7 +268,7 @@ default-document-attributes:
       end
       %(grafana:
   default:
-    host: #{url}#{api_key ? "\n    api_key: #{api_key}" : ''}
+    host: #{url}#{api_key ? "\n    api_key: #{api_key}" : ''}#{ssl_disable_verify ? "\n    ssl-disable-verify: #{ssl_disable_verify}" : ''}
 )
     end
 

data/lib/grafana_reporter/logger/two_way_delegate_logger.rb

@@ -42,16 +42,34 @@ module GrafanaReporter
         @additional_logger = logger || ::Logger.new(nil)
       end
 
-      # Delegates all not configured calls to the internal and the additional logger.
-      def method_missing(method, *args)
-        @internal_logger.send(method, *args)
-        @additional_logger.send(method, *args)
+      def fatal(*args)
+        @internal_logger.fatal(*args)
+        @additional_logger.fatal(*args)
+      end
+
+      def error(*args)
+        @internal_logger.error(*args)
+        @additional_logger.error(*args)
+      end
+
+      def warn(*args)
+        @internal_logger.warn(*args)
+        @additional_logger.warn(*args)
       end
 
-      # Registers all methods to which the internal logger responds.
-      def respond_to_missing?(method, *_args)
-        super
-        @internal_logger.respond_to?(method)
+      def info(*args)
+        @internal_logger.info(*args)
+        @additional_logger.info(*args)
+      end
+
+      def debug(*args)
+        @internal_logger.debug(*args)
+        @additional_logger.debug(*args)
+      end
+
+      # Registers all methods to which the internal logger will respond.
+      def method_missing(method, *args)
+        @internal_logger.send(method, *args)
       end
     end
   end

data/lib/grafana_reporter/query_value_query.rb

@@ -10,21 +10,24 @@ module GrafanaReporter
         @datasource = @panel.datasource
       end
 
-      @variables['result_type'] ||= Variable.new('')
+      @variables['result_type'] ||= ::Grafana::Variable.new('')
+      @variables['after_fetch'] ||= ::Grafana::Variable.new('filter_columns')
+      @variables['after_calculate'] ||= ::Grafana::Variable.new('format,replace_values,transpose')
     end
 
-    # Executes {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
-    # {AbstractQuery#filter_columns} on the query results.
+    # Executes 'after_fetch', 'after_calculate' and 'select_value' on the on the query results.
     #
     # Finally the results are formatted as a asciidoctor table.
     # @see Grafana::AbstractQuery#post_process
     def post_process
-      modify_results
+      @result = apply(@result, @variables['after_fetch'], @variables)
 
       case @variables['result_type'].raw_value
       when 'object'
+        @result = apply(@result, @variables['after_calculate'], @variables)
 
       when /(?:panel_table|sql_table)/
+        @result = apply(@result, @variables['after_calculate'], @variables)
         @result = format_table_output(@result, row_divider: @variables['row_divider'],
                                                column_divider: @variables['column_divider'],
                                                table_formatter: @variables['table_formatter'],
@@ -32,7 +35,7 @@ module GrafanaReporter
                                                transpose: @variables['transpose'])
 
       when /(?:panel_value|sql_value)/
-        tmp = @result[:content] || []
+        tmp = @result[:content] || [[]]
         # use only first column of return values and replace null values with zero
         tmp = tmp.map{ |item| item[0] || 0 }
 
@@ -56,7 +59,9 @@ module GrafanaReporter
           raise UnsupportedSelectValueStatementError, @variables['select_value'].raw_value
         end
 
-        @result = result
+        @result[:content] = [[result]]
+        @result = apply(@result, @variables['after_calculate'], @variables)
+        @result = @result[:content].flatten.first
 
       else
         raise StandardError, "Unsupported 'result_type' received: '#{@variables['result_type'].raw_value}'"
@@ -80,14 +85,5 @@ module GrafanaReporter
 
       end
     end
-
-    private
-
-    def modify_results
-      @result = format_columns(@result, @variables['format'])
-      @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
-      @result = filter_columns(@result, @variables['filter_columns'])
-      @result = transpose(@result, @variables['transpose'])
-    end
   end
 end

data/lib/ruby_grafana_reporter.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-19 00:00:00.000000000 Z
+date: 2024-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor