ruby-grafana-reporter 0.3.0 → 0.4.0

data/lib/grafana_reporter/alerts_table_query.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class is used to query alerts from grafana.
+  class AlertsTableQuery < AbstractQuery
+    # Check if mandatory {Grafana::Variable} +columns+ is specified in variables.
+    #
+    # The value of the +columns+ variable has to be a comma separated list of column titles, which
+    # need to be included in the following list:
+    # - limit
+    # - dashboardId
+    # - panelId
+    # - query
+    # - state
+    # - folderId
+    # - dashboardQuery
+    # - dashboardTag
+    # @return [void]
+    def pre_process
+      raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
+
+      @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'])
+      @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}.
+    # @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'])
+
+      # TODO: move formatting to Asciidoctor namespace
+      @result = @result[:content].map { |row| "| #{row.map { |item| item.to_s.gsub('|', '\\|') }.join(' | ')}" }
+    end
+  end
+end

data/lib/grafana_reporter/annotations_table_query.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  # This class is used to query annotations from grafana.
+  class AnnotationsTableQuery < AbstractQuery
+    # Check if mandatory {Grafana::Variable} +columns+ is specified in variables.
+    #
+    # The value of the +columns+ variable has to be a comma separated list of column titles, which
+    # need to be included in the following list:
+    # - limit
+    # - alertId
+    # - userId
+    # - type
+    # - tags
+    # - dashboardId
+    # - panelId
+    # @return [void]
+    def pre_process
+      raise MissingMandatoryAttributeError, 'columns' unless @raw_query['columns']
+
+      @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'])
+      @datasource = Grafana::GrafanaAnnotationsDatasource.new(nil)
+    end
+
+    # 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}.
+    # @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'])
+
+      # TODO: move formatting to Asciidoctor namespace
+      @result = result[:content].map { |row| "| #{row.map { |item| item.to_s.gsub('|', '\\|') }.join(' | ')}" }
+    end
+  end
+end

data/lib/grafana_reporter/application/application.rb

@@ -19,8 +19,12 @@ module GrafanaReporter
       # Contains the {Configuration} object of the application.
       attr_accessor :config
 
+      # Stores the {Webservice} object of the application
+      attr_reader :webservice
+
       def initialize
         @config = Configuration.new
+        @webservice = Webservice.new
       end
 
       # This is the main method, which is called, if the application is
@@ -33,11 +37,11 @@ module GrafanaReporter
         action_wizard = false
 
         parser = OptionParser.new do |opts|
-          if ENV['OCRA_EXECUTABLE']
-            opts.banner = "Usage: #{ENV['OCRA_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '')} [options]"
-          else
-            opts.banner = "Usage: #{Gem.ruby} #{$PROGRAM_NAME} [options]"
-          end
+          opts.banner = if ENV['OCRA_EXECUTABLE']
+                          "Usage: #{ENV['OCRA_EXECUTABLE'].gsub("#{Dir.pwd}/".gsub('/', '\\'), '')} [options]"
+                        else
+                          "Usage: #{Gem.ruby} #{$PROGRAM_NAME} [options]"
+                        end
 
           opts.on('-c', '--config CONFIG_FILE_NAME', 'Specify custom configuration file,'\
                   " instead of #{CONFIG_FILE}.") do |file_name|
@@ -137,18 +141,18 @@ module GrafanaReporter
         when Configuration::MODE_CONNECTION_TEST
           res = Grafana::Grafana.new(config.grafana_host(config.test_instance),
                                      config.grafana_api_key(config.test_instance),
-                                     logger: config.logger, ssl_cert: config.ssl_cert).test_connection
+                                     logger: config.logger).test_connection
           puts res
 
         when Configuration::MODE_SINGLE_RENDER
           begin
             config.report_class.new(config, config.template, config.to_file).create_report
           rescue StandardError => e
-            puts e.message
+            puts "#{e.message}\n#{e.backtrace.join("\n")}"
           end
 
         when Configuration::MODE_SERVICE
-          Webservice.new(config).run
+          @webservice.run(config)
         end
 
         0

data/lib/grafana_reporter/application/webservice.rb

@@ -6,21 +6,30 @@ module GrafanaReporter
     # make use of `webrick` or similar, so that it can be used without futher dependencies
     # in conjunction with the standard asciidoctor docker container.
     class Webservice
-      def initialize(config)
+      def initialize
         @reports = []
+        @running = false
+      end
+
+      # Runs the webservice with the given {Configuration} object.
+      def run(config)
         @config = config
         @logger = config.logger
-      end
 
-      # Runs the webservice with the current set {Configuration} object.
-      def run
         # start webserver
         @server = TCPServer.new(@config.webserver_port)
         @logger.info("Server listening on port #{@config.webserver_port}...")
+        @running = true
 
         @progress_reporter = Thread.new {}
 
         accept_requests_loop
+        @running = false
+      end
+
+      # @return True, if webservice is up and running, false otherwise
+      def running?
+        @running
       end
 
       private
@@ -164,7 +173,8 @@ module GrafanaReporter
         return http_response(200, 'OK', content, "Content-Type": 'application/pdf') if content.start_with?('%PDF')
 
         http_response(200, 'OK', content, "Content-Type": 'application/octet-stream',
-                                          "Content-Disposition": "attachment; filename=report_#{attrs['report_id']}.zip")
+                                          "Content-Disposition": 'attachment; '\
+                                                                 "filename=report_#{attrs['report_id']}.zip")
       end
 
       def render_report(attrs)
@@ -210,7 +220,9 @@ module GrafanaReporter
                     "<td>#{report.start_time}</td>"\
                     "<td>#{report.end_time}</td>"\
                     "<td>#{report.template}</td>"\
-                    "<td>#{report.execution_time.to_i} secs</td><td>#{report.status} (#{(report.progress * 100).to_i}%)</td><td>#{report.error.join('<br>')}</td>"\
+                    "<td>#{report.execution_time.to_i} secs</td>"\
+                    "<td>#{report.status} (#{(report.progress * 100).to_i}%)</td>"\
+                    "<td>#{report.error.join('<br>')}</td>"\
                     "<td>#{!report.done && !report.cancel ? "<a href=\"/cancel_report?report_id=#{report.object_id}\">Cancel</a>&nbsp;" : ''}"\
                     "#{(report.status == 'finished') || (report.status == 'cancelled') ? "<a href=\"/view_report?report_id=#{report.object_id}\">View</a>&nbsp;" : '&nbsp;'}"\
                     "<a href=\"/view_log?report_id=#{report.object_id}\">Log</a></td>"\

data/lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    # Implements the hook
+    #   include::grafana_alerts[<options>]
+    #
+    # Returns the results of alerts query as a asciidoctor table.
+    #
+    # == Used document parameters
+    # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +grafana_default_dashboard+ - uid of grafana default dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # == Supported options
+    # +columns+ - see {AlertsTableQuery#pre_process} (*mandatory*)
+    #
+    # +instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +dashboard+ - uid of grafana dashboard to query for, empty string if no filter is wanted
+    #
+    # +panel+ - id of the panel to query for
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # +format+ - see {QueryMixin#format_columns}
+    #
+    # +replace_values+ - see {QueryMixin#replace_values}
+    #
+    # +filter_columns+ - see {QueryMixin#filter_columns}
+    class AlertsTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
+      include ProcessorMixin
+
+      # :nodoc:
+      def handles?(target)
+        target.start_with? 'grafana_alerts'
+      end
+
+      # :nodoc:
+      def process(doc, reader, _target, attrs)
+        return if @report.cancel
+
+        @report.next_step
+        instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
+        dashboard_id = attrs['dashboard'] || doc.attr('grafana_default_dashboard')
+        panel_id = attrs['panel']
+        @report.logger.debug("Processing AlertsTableIncludeProcessor (instance: #{instance},"\
+                             " dashboard: #{dashboard_id}, panel: #{panel_id})")
+
+        query = AlertsTableQuery.new(@report.grafana(instance))
+        query.set_defaults_from_dashboard(@report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        defaults = {}
+        defaults['dashboardId'] = dashboard_id if dashboard_id
+        defaults['panelId'] = panel_id if panel_id
+
+        query.merge_hash_variables(doc.attributes, attrs)
+        selected_attrs = attrs.select do |k, _v|
+          k =~ /(?:columns|limit|folderId|dashboardId|panelId|dahboardTag|dashboardQuery|state|query)/x
+        end
+        query.raw_query = defaults.merge(selected_attrs.each_with_object({}) { |(k, v), h| h[k] = v })
+        @report.logger.debug("from: #{query.from}, to: #{query.to}")
+
+        begin
+          reader.unshift_lines query.execute
+        rescue GrafanaReporterError => e
+          @report.logger.error(e.message)
+          reader.unshift_line "|#{e.message}"
+        rescue StandardError => e
+          @report.logger.fatal(e.message)
+          reader.unshift_line "|#{e.message}"
+        end
+
+        reader
+      end
+
+      # @see ProcessorMixin#build_demo_entry
+      def build_demo_entry(_panel)
+        "|===\ninclude::grafana_alerts[columns=\"panelId,name,state\"]\n|==="
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    # Implements the hook
+    #   include::grafana_annotations[<options>]
+    #
+    # Returns the results of alerts query as a asciidoctor table.
+    #
+    # == Used document parameters
+    # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +grafana_default_dashboard+ - uid of grafana default dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # == Supported options
+    # +columns+ - see {AnnotationsTableQuery#pre_process} (*mandatory*)
+    #
+    # +instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +dashboard+ - uid of grafana dashboard to query for, empty string if no filter is wanted
+    #
+    # +panel+ - id of the panel to query for
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # +format+ - see {QueryMixin#format_columns}
+    #
+    # +replace_values+ - see {QueryMixin#replace_values}
+    #
+    # +filter_columns+ - see {QueryMixin#filter_columns}
+    class AnnotationsTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
+      include ProcessorMixin
+
+      # :nodoc:
+      def handles?(target)
+        target.start_with? 'grafana_annotations'
+      end
+
+      # :nodoc:
+      def process(doc, reader, _target, attrs)
+        return if @report.cancel
+
+        @report.next_step
+        instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
+        dashboard_id = attrs['dashboard'] || doc.attr('grafana_default_dashboard')
+        panel_id = attrs['panel']
+        @report.logger.debug("Processing AnnotationsTableIncludeProcessor (instance: #{instance})")
+
+        query = AnnotationsTableQuery.new(@report.grafana(instance))
+        query.set_defaults_from_dashboard(@report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        defaults = {}
+        defaults['dashboardId'] = dashboard_id if dashboard_id
+        defaults['panelId'] = panel_id if panel_id
+
+        query.merge_hash_variables(doc.attributes, attrs)
+        selected_attrs = attrs.select do |k, _v|
+          k =~ /(?:columns|limit|alertId|dashboardId|panelId|userId|type|tags)/
+        end
+        query.raw_query = defaults.merge(selected_attrs.each_with_object({}) { |(k, v), h| h[k] = v })
+        @report.logger.debug("from: #{query.from}, to: #{query.to}")
+
+        begin
+          reader.unshift_lines query.execute
+        rescue GrafanaReporterError => e
+          @report.logger.error(e.message)
+          reader.unshift_line "|#{e.message}"
+        rescue StandardError => e
+          @report.logger.fatal(e.message)
+          reader.unshift_line "|#{e.message}"
+        end
+
+        reader
+      end
+
+      # @see ProcessorMixin#build_demo_entry
+      def build_demo_entry(_panel)
+        "|===\ninclude::grafana_annotations[columns=\"time,panelId,newState,prevState,text\"]\n|==="
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    # Implements the hook
+    #   grafana_panel_image::<panel_id>[<options>]
+    #
+    # Stores the queried panel as a temporary image file and returns an asciidoctor link
+    # to be included in the report.
+    #
+    # == Used document parameters
+    # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +grafana_default_dashboard+ - uid of grafana default dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    #
+    # == Supported options
+    # +field+ - property to query for, e.g. +description+ or +title+ (*mandatory*)
+    #
+    # +instance+ - name of grafana instance, 'default' if not specified
+    #
+    # +dashboard+ - uid of grafana dashboard to use
+    #
+    # +from+ - 'from' time for the sql query
+    #
+    # +to+ - 'to' time for the sql query
+    class PanelImageBlockMacro < ::Asciidoctor::Extensions::BlockMacroProcessor
+      include ProcessorMixin
+      use_dsl
+
+      named :grafana_panel_image
+
+      # :nodoc:
+      def process(parent, target, attrs)
+        return if @report.cancel
+
+        @report.next_step
+        instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
+        dashboard = attrs['dashboard'] || parent.document.attr('grafana_default_dashboard')
+        @report.logger.debug("Processing PanelImageBlockMacro (instance: #{instance}, dashboard: #{dashboard},"\
+                             " panel: #{target})")
+
+        begin
+          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
+          query.merge_hash_variables(parent.document.attributes, attrs)
+          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+
+          image = query.execute
+          image_path = @report.save_image_file(image)
+        rescue GrafanaReporterError => e
+          @report.logger.error(e.message)
+          return create_paragraph(parent, e.message, attrs)
+        rescue StandardError => e
+          @report.logger.fatal(e.message)
+          return create_paragraph(parent, e.message, attrs)
+        end
+
+        attrs['target'] = image_path
+        create_image_block(parent, attrs)
+      end
+
+      # @see ProcessorMixin#build_demo_entry
+      def build_demo_entry(panel)
+        return nil unless panel
+        return nil unless panel.model['type'] == 'graph'
+
+        "grafana_panel_image::#{panel.id}[dashboard=\"#{panel.dashboard.id}\",width=\"50%\"]"
+      end
+    end
+  end
+end