ruby-grafana-reporter 0.3.0 → 0.4.0

data/lib/grafana_reporter/logger/two_way_logger.rb

@@ -25,7 +25,7 @@ module GrafanaReporter
       end
 
       # Sets the severity level of the additional logger to the given severity.
-      # @param severity one of {Logger::Severity}
+      # @param severity one of Logger::Severity
       def level=(severity)
         @additional_logger.level = severity
       end

data/lib/grafana_reporter/panel_image_query.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class is used to create an image out of a {Grafana::Panel}.
+  class PanelImageQuery < AbstractQuery
+    # Sets the proper render variables.
+    def pre_process
+      @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'] ||
+                           @variables['grafana_default_to_timezone'])
+      # TODO: ensure that in case of timezones are specified, that they are also forwarded to the image renderer
+      # rename "render-" variables
+      @variables = @variables.each_with_object({}) { |(k, v), h| h[k.gsub(/^render-/, '')] = v }
+      @datasource = Grafana::ImageRenderingDatasource.new(nil)
+    end
+
+    # Returns the body of the http query, which contains the raw image.
+    def post_process
+      @result = @result[:content].first
+      raise ImageCouldNotBeRenderedError, @panel if @result.include?('<html')
+    end
+
+    # @see AbstractQuery#raw_query
+    def raw_query
+      { panel: @panel }
+    end
+  end
+end

data/lib/grafana_reporter/panel_property_query.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class is used to query properties from a {Grafana::Panel}, such as +description+,
+  # +title+ etc.
+  class PanelPropertyQuery < AbstractQuery
+    # @see Grafana::AbstractQuery#pre_process
+    def pre_process
+      @datasource = Grafana::GrafanaPropertyDatasource.new(nil)
+    end
+
+    # @see Grafana::AbstractQuery#post_process
+    def post_process
+      @result = @result[:content].first
+    end
+
+    # @see Grafana::AbstractQuery#raw_query
+    def raw_query
+      @raw_query.merge({ panel: @panel })
+    end
+  end
+end

data/lib/grafana_reporter/query_value_query.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class provides a general query implementation for any kind of single value and table queries.
+  class QueryValueQuery < AbstractQuery
+    # Translates the from and to times.
+    # @see Grafana::AbstractQuery#pre_process
+    def pre_process
+      @datasource = @panel.datasource if @panel
+
+      @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'] ||
+                           @variables['grafana_default_to_timezone'])
+      @variables['result_type'] ||= Variable.new('')
+    end
+
+    # Executes {QueryMixin#format_columns}, {QueryMixin#replace_values} and
+    # {QueryMixin#filter_columns} on the query results.
+    #
+    # Finally the results are formatted as a asciidoctor table.
+    # @see Grafana::AbstractQuery#post_process
+    def post_process
+      modify_results
+
+      case @variables['result_type'].raw_value
+      when /(?:panel_table|sql_table)/
+        result_to_table
+
+      when /(?:panel_value|sql_value)/
+        tmp = @result[:content] || []
+        @result = tmp.flatten.first
+
+      else
+        raise StandardError, "Unsupported 'result_type' received: '#{@variables['result_type'].raw_value}'"
+
+      end
+    end
+
+    # @see Grafana::AbstractQuery#raw_query
+    def raw_query
+      return @raw_query if @raw_query
+
+      case @variables['result_type'].raw_value
+      when /(?:panel_table|panel_value)/
+        @variables['query'] ? @panel.query(@variables['query'].raw_value) : @panel.query(nil)
+
+      when /(?:sql_table|sql_value)/
+        nil
+
+      else
+        raise StandardError, "Unsupported 'result_type' received: '#{@variables['result_type'].raw_value}'"
+
+      end
+    end
+
+    private
+
+    def result_to_table
+      row_div = '| '
+      row_div = @variables['row_divider'].raw_value if @variables['row_divider'].is_a?(Grafana::Variable)
+      col_div = ' | '
+      col_div = @variables['column_divider'].raw_value if @variables['column_divider'].is_a?(Grafana::Variable)
+
+      @result = @result[:content].map do |row|
+        row_div + row.map do |item|
+          col_div == ' | ' ? item.to_s.gsub('|', '\\|') : item.to_s
+        end.join(col_div)
+      end
+    end
+
+    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/grafana_reporter/report_webhook.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class provides a default webhook implementation for report events. It sends out
+  # a webrequest to the configured +callback_url+ with all necessary information about the
+  # event and the report.
+  class ReportWebhook
+    def initialize(callback_url)
+      @callback_url = callback_url
+    end
+
+    # Implements the call of the configured webhook.
+    # Provides the following report information in JSON format:
+    #
+    # +object_id+ - id of the current report
+    # +path+ - file path to the report
+    # +status+ - report status as string, e.g. +cancelled+, +finished+ or +in progress+
+    # +execution_time+ - execution time of the report
+    # +template+ - name of the used template
+    # +start_time+ - time when the report creation started
+    # +end_time+ - time when the report creation ended
+    # +event+ - event, which has happened
+    def callback(event, report)
+      # build report information as JSON
+      data = { object_id: report.object_id, path: report.path, status: report.status,
+               execution_time: report.execution_time, template: report.template,
+               start_time: report.start_time, end_time: report.end_time, event: event }
+
+      request = { body: JSON.generate(data), accept: nil, content_type: nil }
+      res = ::Grafana::WebRequest.new(@callback_url, request).execute
+
+      "#{res} - Body: #{res.body}"
+    end
+  end
+end

data/lib/{ruby-grafana-reporter.rb → ruby_grafana_reporter.rb}

@@ -18,9 +18,6 @@ require 'asciidoctor-pdf'
 require 'zip'
 require_relative 'VERSION'
 
-# TODO: automatically build a template based on configured grafana dashboard
-# TODO: add an sample report to github from grafana play (if permitted)
-
 folders = [
   %w[grafana],
   %w[grafana_reporter logger],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -100,10 +100,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: Provides a standalone and a webservice frontend for creating reports
-  based on asciidoctor, including interfaces to integrate dynamic content captured
-  from grafana.By default the reports will be converted to PDF documents, whereas
-  other target formats can be used as well.
+description: Build reports based on grafana dashboards in asciidoctor syntax. Runs
+  as webservice for easy integration with grafana, or as a standalone, command line
+  utility.
 email: kohly@gmx.de
 executables:
 - ruby-grafana-reporter
@@ -113,49 +112,52 @@ extra_rdoc_files:
 - LICENSE
 files:
 - "./lib/VERSION.rb"
-- "./lib/grafana/abstract_panel_query.rb"
-- "./lib/grafana/abstract_query.rb"
-- "./lib/grafana/abstract_sql_query.rb"
+- "./lib/grafana/abstract_datasource.rb"
 - "./lib/grafana/dashboard.rb"
 - "./lib/grafana/errors.rb"
 - "./lib/grafana/grafana.rb"
+- "./lib/grafana/grafana_alerts_datasource.rb"
+- "./lib/grafana/grafana_annotations_datasource.rb"
+- "./lib/grafana/grafana_property_datasource.rb"
+- "./lib/grafana/graphite_datasource.rb"
+- "./lib/grafana/image_rendering_datasource.rb"
 - "./lib/grafana/panel.rb"
-- "./lib/grafana/panel_image_query.rb"
+- "./lib/grafana/prometheus_datasource.rb"
+- "./lib/grafana/sql_datasource.rb"
 - "./lib/grafana/variable.rb"
+- "./lib/grafana/webrequest.rb"
+- "./lib/grafana_reporter/abstract_query.rb"
 - "./lib/grafana_reporter/abstract_report.rb"
+- "./lib/grafana_reporter/alerts_table_query.rb"
+- "./lib/grafana_reporter/annotations_table_query.rb"
 - "./lib/grafana_reporter/application/application.rb"
 - "./lib/grafana_reporter/application/errors.rb"
 - "./lib/grafana_reporter/application/webservice.rb"
-- "./lib/grafana_reporter/asciidoctor/alerts_table_query.rb"
-- "./lib/grafana_reporter/asciidoctor/annotations_table_query.rb"
-- "./lib/grafana_reporter/asciidoctor/errors.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/alerts_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/annotations_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_image_block_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_image_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_property_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_query_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_query_value_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/processor_mixin.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/show_environment_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/show_help_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/sql_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/sql_value_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/value_as_variable_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/help.rb"
-- "./lib/grafana_reporter/asciidoctor/panel_first_value_query.rb"
-- "./lib/grafana_reporter/asciidoctor/panel_image_query.rb"
-- "./lib/grafana_reporter/asciidoctor/panel_property_query.rb"
-- "./lib/grafana_reporter/asciidoctor/panel_table_query.rb"
-- "./lib/grafana_reporter/asciidoctor/query_mixin.rb"
+- "./lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/processor_mixin.rb"
 - "./lib/grafana_reporter/asciidoctor/report.rb"
-- "./lib/grafana_reporter/asciidoctor/sql_first_value_query.rb"
-- "./lib/grafana_reporter/asciidoctor/sql_table_query.rb"
+- "./lib/grafana_reporter/asciidoctor/show_environment_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/show_help_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/value_as_variable_include_processor.rb"
 - "./lib/grafana_reporter/configuration.rb"
 - "./lib/grafana_reporter/console_configuration_wizard.rb"
+- "./lib/grafana_reporter/demo_report_wizard.rb"
 - "./lib/grafana_reporter/errors.rb"
+- "./lib/grafana_reporter/help.rb"
 - "./lib/grafana_reporter/logger/two_way_logger.rb"
-- "./lib/ruby-grafana-reporter.rb"
+- "./lib/grafana_reporter/panel_image_query.rb"
+- "./lib/grafana_reporter/panel_property_query.rb"
+- "./lib/grafana_reporter/query_value_query.rb"
+- "./lib/grafana_reporter/report_webhook.rb"
+- "./lib/ruby_grafana_reporter.rb"
 - LICENSE
 - README.md
 - bin/ruby-grafana-reporter

data/lib/grafana/abstract_panel_query.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'abstract_query'
-
-module Grafana
-  # @abstract
-  #
-  # Used as a superclass for all queries, which rely on a {Panel} object.
-  #
-  # @see AbstractQuery
-  class AbstractPanelQuery < AbstractQuery
-    attr_reader :panel
-
-    # Initializes the variables of the query using {AbstractQuery#extract_dashboard_variables}.
-    # @param panel [Panel] panel for which the query shall be executed
-    def initialize(panel)
-      super()
-      @panel = panel
-      extract_dashboard_variables(@panel.dashboard)
-    end
-  end
-end

data/lib/grafana/abstract_query.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Grafana
-  # @abstract Override {#url}, #{#request}, {#pre_process} and {#post_process} in subclass.
-  #
-  # Superclass containing everything for all queries towards grafana.
-  class AbstractQuery
-    attr_accessor :from, :to, :timeout, :result
-    attr_reader :variables
-
-    def initialize
-      @variables = {}
-    end
-
-    # Runs the whole process to receive values properly from this query:
-    # - calls {#pre_process}
-    # - executes this query against the given {Grafana} instance
-    # - calls {#post_process}
-    # - returns the result
-    #
-    # @param grafana [Grafana] {Grafana} object, against which the query is executed
-    # @return [Object] result of the query
-    def execute(grafana)
-      return @result unless @result.nil?
-
-      pre_process(grafana)
-      @result = grafana.execute_http_request(url, request, timeout)
-      post_process
-      @result
-    end
-
-    # Used to retrieve 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
-    def extract_dashboard_variables(dashboard)
-      @from = dashboard.from_time
-      @to = dashboard.to_time
-      dashboard.variables.each { |item| merge_variables({ "var-#{item.name}": item }) }
-      self
-    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
-    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
-      self
-    end
-
-    # @return [Hash<String, Variable>] all grafana variables stored in this query, i.e. the variable name
-    #  is prefixed with +var-+
-    def grafana_variables
-      @variables.select { |k, _v| k =~ /^var-.+/ }
-    end
-
-    # Replaces the grafana variables in the given string with their replacement value.
-    #
-    # @param string [String] string in which the variables shall be replaced
-    # @param variables [Hash<String,Variable>] Hash containing the variables, which shall be replaced in the
-    #  given string
-    # @return [String] string in which all variables are properly replaced
-    def replace_variables(string, variables = {})
-      res = string
-      repeat = true
-      repeat_count = 0
-
-      # TODO: find a proper way to replace variables recursively instead of over and over again
-      # TODO: add tests for recursive replacement of variable
-      while repeat && (repeat_count < 3)
-        repeat = false
-        repeat_count += 1
-        variables.each do |var_name, obj|
-          # only set ticks if value is string
-          variable = var_name.gsub(/^var-/, '')
-          res = res.gsub(/(?:\$\{#{variable}(?::(?<format>\w+))?\}|(?<!\.)\$#{variable}(?!\.))/) do
-            obj.value_formatted($LAST_MATCH_INFO ? $LAST_MATCH_INFO[:format] : nil)
-          end
-        end
-        repeat = true if res.include?('$')
-      end
-
-      res
-    end
-
-    # @abstract
-    #
-    # @return [String] String containing the relative URL to execute the query
-    def uri
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # @return [Hash] Hash containing the request parameters, which shall be overwritten or extended in
-    #  {Grafana#execute_http_request}
-    def request
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # Use this function to perform all necessary actions, before the query is actually executed.
-    # Here you can e.g. set values of variables or similar.
-    #
-    # @param grafana [Grafana] {Grafana} object, against which the query shall be executed
-    def pre_process(grafana)
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # Use this function to format the raw result of the @result variable to conform to the expected return value.
-    # You might also want to {#replace_variables} in the @result or similar.
-    def post_process
-      raise NotImplementedError
-    end
-  end
-end