ruby-grafana-reporter 0.4.0 → 0.4.1

data/lib/grafana/errors.rb

@@ -57,21 +57,13 @@ module Grafana
     end
   end
 
-  # Raised if no SQL query is specified in a {AbstractSqlQuery} object.
+  # Raised if no SQL query is specified.
   class MissingSqlQueryError < GrafanaError
     def initialize
       super('No SQL statement has been specified.')
     end
   end
 
-  # Raised if a datasource shall be queried, which is not (yet) supported by the reporter
-  class DatasourceTypeNotSupportedError < GrafanaError
-    def initialize(name, type)
-      super("The configured datasource with name '#{name}' is of type '#{type}', which is currently "\
-            'not supported by ruby-grafana-reporter. It will only be usable in panel image queries.')
-    end
-  end
-
   # Raised if a datasource shall be queried, which is not (yet) supported by the reporter
   class InvalidDatasourceQueryProvidedError < GrafanaError
     def initialize(query)

data/lib/grafana/grafana.rb

@@ -9,6 +9,8 @@
 module Grafana
   # Main class for handling the interaction with one specific Grafana instance.
   class Grafana
+    attr_reader :logger
+
     # @param base_uri [String] full URI pointing to the specific grafana instance without
     #   trailing slash, e.g. +https://localhost:3000+.
     # @param key [String] API key for the grafana instance, if required
@@ -116,13 +118,7 @@ module Grafana
 
       json = JSON.parse(settings.body)
       json['datasources'].select { |_k, v| v['id'].to_i.positive? }.each do |ds_name, ds_value|
-        begin
-          @datasources[ds_name] = AbstractDatasource.build_instance(ds_value)
-        rescue DatasourceTypeNotSupportedError => e
-          # an unsupported datasource type has been configured in the dashboard
-          # - no worries here
-          @logger.warn(e.message)
-        end
+        @datasources[ds_name] = AbstractDatasource.build_instance(ds_value)
       end
       @datasources['default'] = @datasources[json['defaultDatasource']]
     end

data/lib/grafana/graphite_datasource.rb

@@ -3,6 +3,12 @@
 module Grafana
   # Implements the interface to graphite datasources.
   class GraphiteDatasource < AbstractDatasource
+    # @see AbstractDatasource#handles?
+    def self.handles?(model)
+      tmp = new(model)
+      tmp.type == 'graphite'
+    end
+
     # +:raw_query+ needs to contain a Graphite query as String
     # @see AbstractDatasource#request
     def request(query_description)

data/lib/grafana/prometheus_datasource.rb

@@ -3,6 +3,12 @@
 module Grafana
   # Implements the interface to Prometheus datasources.
   class PrometheusDatasource < AbstractDatasource
+    # @see AbstractDatasource#handles?
+    def self.handles?(model)
+      tmp = new(model)
+      tmp.type == 'prometheus'
+    end
+
     # +:raw_query+ needs to contain a Prometheus query as String
     # @see AbstractDatasource#request
     def request(query_description)

data/lib/grafana/sql_datasource.rb

@@ -3,6 +3,12 @@
 module Grafana
   # Implements the interface to all SQL based datasources (tested with PostgreSQL and MariaDB/MySQL).
   class SqlDatasource < AbstractDatasource
+    # @see AbstractDatasource#handles?
+    def self.handles?(model)
+      tmp = new(model)
+      tmp.category == 'sql'
+    end
+
     # +:raw_query+ needs to contain a SQL query as String in the respective database dialect
     # @see AbstractDatasource#request
     def request(query_description)

data/lib/grafana/unsupported_datasource.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Grafana
+  # Dummy class, which is used, if a datasource is currently unsupported.
+  class UnsupportedDatasource < AbstractDatasource
+  end
+end

data/lib/grafana/webrequest.rb

@@ -59,7 +59,7 @@ module Grafana
     def configure_ssl
       @http.use_ssl = true
       @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      if self.class.ssl_cert && !File.exist?(self.class.ssl_cert)
+      if self.class.ssl_cert && !File.file?(self.class.ssl_cert)
         @logger.warn('SSL certificate file does not exist.')
       elsif self.class.ssl_cert
         @http.cert_store = OpenSSL::X509::Store.new

data/lib/grafana_reporter/abstract_query.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module GrafanaReporter
-  # @abstract Override {#pre_process}, {#post_process} and {#self.build_demo_entry} in subclass.
+  # @abstract Override {#pre_process} and {#post_process} in subclass.
   #
   # Superclass containing everything for all queries towards grafana.
   class AbstractQuery
@@ -9,7 +9,7 @@ module GrafanaReporter
     attr_writer :raw_query
     attr_reader :variables, :result, :panel
 
-    # @param grafana_or_panel [Object] {Grafana} or {Panel} object for which the query is executed
+    # @param grafana_or_panel [Object] {Grafana::Grafana} or {Grafana::Panel} object for which the query is executed
     def initialize(grafana_or_panel)
       if grafana_or_panel.is_a?(Grafana::Panel)
         @panel = grafana_or_panel
@@ -24,7 +24,7 @@ module GrafanaReporter
     #
     # Runs the whole process to receive values properly from this query:
     # - calls {#pre_process}
-    # - executes this query against the {Grafana} instance
+    # - executes this query against the {Grafana::AbstractDatasource} implementation instance
     # - calls {#post_process}
     #
     # @return [Hash] result of the query in standardized format
@@ -32,25 +32,14 @@ module GrafanaReporter
       return @result unless @result.nil?
 
       pre_process
+      raise DatasourceNotSupportedError.new(@datasource, self) if @datasource.is_a?(Grafana::UnsupportedDatasource)
+
       @result = @datasource.request(from: @from, to: @to, raw_query: raw_query, variables: grafana_variables,
                                     prepared_request: @grafana.prepare_request, timeout: timeout)
       post_process
       @result
     end
 
-    # Sets default configurations from the given {Dashboard} and store them as settings in the query.
-    #
-    # Following data is extracted:
-    # - +from+, by {Dashboard#from_time}
-    # - +to+, by {Dashboard#to_time}
-    # - and all variables as {Variable}, prefixed with +var-+, as grafana also does it
-    # @param dashboard [Dashboard] dashboard from which the defaults are captured
-    def set_defaults_from_dashboard(dashboard)
-      @from = dashboard.from_time
-      @to = dashboard.to_time
-      dashboard.variables.each { |item| merge_variables({ "var-#{item.name}": item }) }
-    end
-
     # Overwrite this function to extract a proper raw query value from this object.
     #
     # If the property +@raw_query+ is not set manually by the calling object, this
@@ -77,35 +66,22 @@ module GrafanaReporter
       raise NotImplementedError
     end
 
-    # Merges the given hashes to the current object by using the {#merge_variables} method.
-    # It respects the priorities of the hashes and the object and allows only valid variables to be passed.
-    # @param document_hash [Hash] variables from report template level
-    # @param item_hash [Hash] variables from item configuration level, i.e. specific call, which may override document
-    # @return [void]
-    # TODO: rename method
-    def merge_hash_variables(document_hash, item_hash)
-      sel_doc_items = document_hash.select do |k, _v|
-        k =~ /^var-/ || k == 'grafana-report-timestamp' || k =~ /grafana_default_(?:from|to)_timezone/
-      end
-      merge_variables(sel_doc_items.each_with_object({}) { |(k, v), h| h[k] = ::Grafana::Variable.new(v) })
-
-      sel_items = item_hash.select do |k, _v|
-        # TODO: specify accepted options in each class or check if simply all can be allowed with prefix +var-+
-        k =~ /^var-/ || k =~ /^render-/ || k =~ /filter_columns|format|replace_values_.*|transpose|column_divider|
-                                                 row_divider|from_timezone|to_timezone|result_type|query/x
-      end
-      merge_variables(sel_items.each_with_object({}) { |(k, v), h| h[k] = ::Grafana::Variable.new(v) })
+    # Used to specify variables to be used for this query. This method ensures, that only the values of the
+    # {Grafana::Variable} stored in the +variables+ Array are overwritten.
+    # @param name [String] name of the variable to set
+    # @param variable [Grafana::Variable] variable from which the {Grafana::Variable#raw_value} will be assigned to the query variables
+    def assign_variable(name, variable)
+      raise GrafanaReporterError, "Provided variable is not of type Grafana::Variable (name: '#{name}', value: '#{value}')" unless variable.is_a?(Grafana::Variable)
 
-      @timeout = item_hash['timeout'] || document_hash['grafana-default-timeout'] || @timeout
-      @from = item_hash['from'] || document_hash['from'] || @from
-      @to = item_hash['to'] || document_hash['to'] || @to
+      @variables[name] ||= variable
+      @variables[name].raw_value = variable.raw_value
     end
 
     # Transposes the given result.
     #
     # NOTE: Only the +:content+ of the given result hash is transposed. The +:header+ is ignored.
     #
-    # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#preformat_response})
+    # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#request})
     # @param transpose_variable [Grafana::Variable] true, if the result hash shall be transposed
     # @return [Hash] transposed query result
     def transpose(result, transpose_variable)
@@ -121,7 +97,7 @@ module GrafanaReporter
     #
     # Multiple columns may be filtered. Therefore the column titles have to be named in the
     # {Grafana::Variable#raw_value} and have to be separated by +,+ (comma).
-    # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#preformat_response})
+    # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#request})
     # @param filter_columns_variable [Grafana::Variable] column names, which shall be removed in the query result
     # @return [Hash] filtered query result
     def filter_columns(result, filter_columns_variable)
@@ -145,10 +121,9 @@ module GrafanaReporter
     # The formatting will be applied separately for every column. Therefore the column formats have to be named
     # in the {Grafana::Variable#raw_value} and have to be separated by +,+ (comma). If no value is specified for
     # a column, no change will happen.
-    # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#preformat_response})
+    # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#request})
     # @param formats [Grafana::Variable] formats, which shall be applied to the columns in the query result
     # @return [Hash] formatted query result
-    # TODO: make sure that caught errors are also visible in logger
     def format_columns(result, formats)
       return result unless formats
 
@@ -162,6 +137,7 @@ module GrafanaReporter
           begin
             row[i] = format % row[i] if row[i]
           rescue StandardError => e
+            @grafana.logger.error(e.message)
             row[i] = e.message
           end
         end
@@ -195,7 +171,7 @@ module GrafanaReporter
     # '42 is the answer'. Important to know: the regular expressions always have to start
     # with +^+ and end with +$+, i.e. the expression itself always has to match
     # the whole content in one field.
-    # @param result [Hash] preformatted query result (see {Grafana::AbstractDatasource#preformat_response}.
+    # @param result [Hash] preformatted query result (see {Grafana::AbstractDatasource#request}.
     # @param configs [Array<Grafana::Variable>] one variable for replacing values in one column
     # @return [Hash] query result with replaced values
     # TODO: make sure that caught errors are also visible in logger
@@ -280,7 +256,8 @@ module GrafanaReporter
     # @param timezone [Grafana::Variable] timezone to use, if not system timezone
     # @return [String] translated date as timestamp string
     def translate_date(orig_date, report_time, is_to_time, timezone = nil)
-      report_time ||= Variable.new(Time.now.to_s)
+      # TODO: add test case for creation of variable, if not given, maybe also print a warning
+      report_time ||= ::Grafana::Variable.new(Time.now.to_s)
       return (DateTime.parse(report_time.raw_value).to_time.to_i * 1000).to_s unless orig_date
       return orig_date if orig_date =~ /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$/
       return orig_date if orig_date =~ /^\d+$/
@@ -378,24 +355,5 @@ module GrafanaReporter
 
       date
     end
-
-    # Merges the given Hash with the stored variables.
-    #
-    # Can be used to easily set many values at once in the local variables hash.
-    #
-    # Please note, that the values of the Hash need to be of type {Variable}.
-    #
-    # @param hash [Hash<String,Variable>] Hash containing variable name as key and {Variable} as value
-    # @return [AbstractQuery] this object
-    # TODO: test if this method can be removed, or make it private at least
-    def merge_variables(hash)
-      hash.each do |k, v|
-        if @variables[k.to_s].nil?
-          @variables[k.to_s] = v
-        else
-          @variables[k.to_s].raw_value = v.raw_value
-        end
-      end
-    end
   end
 end

data/lib/grafana_reporter/abstract_report.rb

@@ -35,21 +35,13 @@ module GrafanaReporter
     attr_reader :done
 
     # @param config [Configuration] configuration object
-    # @param template [String] path to the template to be used
-    # @param destination_file_or_path [String or File] path to the destination report or file object to use
-    # @param custom_attributes [Hash] custom attributes, which shall be merged with priority over the configuration
-    def initialize(config, template, destination_file_or_path = nil, custom_attributes = {})
+    def initialize(config)
       @config = config
       @logger = Logger::TwoWayDelegateLogger.new
       @logger.additional_logger = @config.logger
-      @done = false
-      @template = template
-      @destination_file_or_path = destination_file_or_path
-      @custom_attributes = custom_attributes
-      @start_time = nil
-      @end_time = nil
-      @cancel = false
-      raise MissingTemplateError, @template.to_s unless File.exist?(@template.to_s)
+      @grafana_instances = {}
+
+      init_before_create
     end
 
     # Registers a new event listener object.
@@ -66,6 +58,17 @@ module GrafanaReporter
       @@event_listeners.default = []
     end
 
+    # @param instance [String] requested grafana instance
+    # @return [Grafana::Grafana] the requested grafana instance.
+    def grafana(instance)
+      unless @grafana_instances[instance]
+        @grafana_instances[instance] = ::Grafana::Grafana.new(@config.grafana_host(instance),
+                                                              @config.grafana_api_key(instance),
+                                                              logger: @logger)
+      end
+      @grafana_instances[instance]
+    end
+
     # Call to request cancelling the report generation.
     # @return [void]
     def cancel!
@@ -122,25 +125,73 @@ module GrafanaReporter
     end
 
     # Is being called to start the report generation.
+    # @param template [String] path to the template to be used, trailing +.adoc+ extension may be omitted
+    # @param destination_file_or_path [String or File] path to the destination report or file object to use
+    # @param custom_attributes [Hash] custom attributes, which shall be merged with priority over the configuration
     # @return [void]
-    def create_report
+    def create_report(template, destination_file_or_path = nil, custom_attributes = {})
+      init_before_create
+      @template = template
+      @destination_file_or_path = destination_file_or_path
+      @custom_attributes = custom_attributes
+
+      # automatically add extension, if a file with adoc extension exists
+      @template = "#{@template}.adoc" if File.file?("#{@template}.adoc") && !File.file?(@template.to_s)
+      raise MissingTemplateError, @template.to_s unless File.file?(@template.to_s)
+
       notify(:on_before_create)
       @start_time = Time.new
       logger.info("Report started at #{@start_time}")
     end
 
-    # @abstract
+    # Used to calculate the progress of a report. By default expects +@total_steps+ to contain the total
+    # number of steps, which will be processed with each call of {#next_step}.
     # @return [Integer] number between 0 and 100, representing the current progress of the report creation.
     def progress
+      return @current_pos.to_i if @total_steps.to_i.zero?
+
+      @current_pos.to_f / @total_steps
+    end
+
+    # Increments the progress.
+    # @return [Integer] number of the current progress position.
+    def next_step
+      @current_pos += 1
+      @current_pos
+    end
+
+    # @abstract
+    # Provided class objects need to implement a method +build_demo_entry(panel)+.
+    # @return [Array<Class>] array of class objects, which shall be included in a demo report
+    def self.demo_report_classes
       raise NotImplementedError
     end
 
     private
 
+    # Called, if the report generation has died with an error.
+    # @param error [StandardError] occured error
+    # @return [void]
+    def died_with_error(error)
+      @error = [error.message] << [error.backtrace]
+      done!
+    end
+
+    def init_before_create
+      @done = false
+      @start_time = nil
+      @end_time = nil
+      @cancel = false
+      @current_pos = 0
+    end
+
     def done!
+      return if @done
+
       @done = true
       @end_time = Time.new
-      logger.info("Report creation ended after #{@end_time - @start_time} seconds with status '#{status}'")
+      @start_time ||= @end_time
+      logger.info("Report creation ended after #{@end_time.to_i - @start_time.to_i} seconds with status '#{status}'")
       notify(:on_after_finish)
     end
 

data/lib/grafana_reporter/alerts_table_query.rb

@@ -19,18 +19,18 @@ module GrafanaReporter
     def pre_process
       raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
 
-      @from = translate_date(@from, @variables['grafana-report-timestamp'], false, @variables['from_timezone'] ||
+      @from = translate_date(@from, @variables['grafana_report_timestamp'], false, @variables['from_timezone'] ||
                              @variables['grafana_default_from_timezone'])
-      @to = translate_date(@to, @variables['grafana-report-timestamp'], true, @variables['to_timezone'] ||
+      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
                            @variables['grafana_default_to_timezone'])
       @datasource = Grafana::GrafanaAlertsDatasource.new(nil)
     end
 
     # Filter the query result for the given columns and sets the result in the preformatted SQL
     # result stlye.
-
-    # Additionally it applies {QueryMixin#format_columns}, {QueryMixin#replace_values} and
-    # {QueryMixin#filter_columns}.
+    #
+    # Additionally it applies {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
+    # {AbstractQuery#filter_columns}.
     # @return [void]
     def post_process
       @result = format_columns(@result, @variables['format'])

data/lib/grafana_reporter/annotations_table_query.rb

@@ -18,9 +18,9 @@ module GrafanaReporter
     def pre_process
       raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
 
-      @from = translate_date(@from, @variables['grafana-report-timestamp'], false, @variables['from_timezone'] ||
+      @from = translate_date(@from, @variables['grafana_report_timestamp'], false, @variables['from_timezone'] ||
                              @variables['grafana_default_from_timezone'])
-      @to = translate_date(@to, @variables['grafana-report-timestamp'], true, @variables['to_timezone'] ||
+      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
                            @variables['grafana_default_to_timezone'])
       @datasource = Grafana::GrafanaAnnotationsDatasource.new(nil)
     end
@@ -28,8 +28,8 @@ module GrafanaReporter
     # Filters the query result for the given columns and sets the result
     # in the preformatted SQL result style.
     #
-    # Additionally it applies {QueryMixin#format_columns}, {QueryMixin#replace_values} and
-    # {QueryMixin#filter_columns}.
+    # Additionally it applies {AbstractQuery#format_columns}, {AbstractQuery#replace_values} and
+    # {AbstractQuery#filter_columns}.
     # @return [void]
     def post_process
       @result = format_columns(@result, @variables['format'])

data/lib/grafana_reporter/application/application.rb

@@ -13,8 +13,6 @@ module GrafanaReporter
     # It can be run to test the grafana connection, render a single template
     # or run as a service.
     class Application
-      # Default file name for grafana reporter configuration file
-      CONFIG_FILE = 'grafana_reporter.config'
 
       # Contains the {Configuration} object of the application.
       attr_accessor :config
@@ -32,7 +30,7 @@ module GrafanaReporter
       # @param params [Array<String>] command line parameters, mainly ARGV can be used.
       # @return [Integer] 0 if everything is fine, -1 if execution aborted.
       def configure_and_run(params = [])
-        config_file = CONFIG_FILE
+        config_file = Configuration::DEFAULT_CONFIG_FILE_NAME
         tmp_config = Configuration.new
         action_wizard = false
 
@@ -44,10 +42,14 @@ module GrafanaReporter
                         end
 
           opts.on('-c', '--config CONFIG_FILE_NAME', 'Specify custom configuration file,'\
-                  " instead of #{CONFIG_FILE}.") do |file_name|
+                  " instead of #{Configuration::DEFAULT_CONFIG_FILE_NAME}.") do |file_name|
             config_file = file_name
           end
 
+          opts.on('-r', '--register FILE', 'Register a custom plugin, e.g. your own Datasource implementation') do |plugin|
+            require plugin
+          end
+
           opts.on('-d', '--debug LEVEL', 'Specify detail level: FATAL, ERROR, WARN, INFO, DEBUG.') do |level|
             tmp_config.set_param('grafana-reporter:debug-level', level)
           end
@@ -65,7 +67,7 @@ module GrafanaReporter
 
           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.exist?(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.")
@@ -106,22 +108,14 @@ module GrafanaReporter
         end
 
         # abort if config file does not exist
-        unless File.exist?(config_file)
+        unless File.file?(config_file)
           puts "Config file '#{config_file}' does not exist. Consider calling the configuration wizard"\
                ' with option \'-w\' or use \'-h\' to see help message. Aborting.'
           return -1
         end
 
-        # read config file
-        config_hash = nil
-        begin
-          config_hash = YAML.load_file(config_file)
-        rescue StandardError => e
-          raise ConfigurationError, "Could not read config file '#{config_file}' (Error: #{e.message})"
-        end
-
         # merge command line configuration with read config file
-        @config.config = config_hash
+        @config.load_config_from_file(config_file)
         @config.merge!(tmp_config)
 
         run
@@ -146,7 +140,7 @@ module GrafanaReporter
 
         when Configuration::MODE_SINGLE_RENDER
           begin
-            config.report_class.new(config, config.template, config.to_file).create_report
+            config.report_class.new(config).create_report(config.template, config.to_file)
           rescue StandardError => e
             puts "#{e.message}\n#{e.backtrace.join("\n")}"
           end