ruby-grafana-reporter 0.2.0 → 0.4.1

data/lib/grafana_reporter/application/webservice.rb

@@ -6,21 +6,48 @@ 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)
+      # Array of possible webservice running states
+      STATUS = %I[stopped running stopping].freeze
+
+      def initialize
         @reports = []
+        @status = :stopped
+      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}...")
 
         @progress_reporter = Thread.new {}
 
+        @status = :running
         accept_requests_loop
+        @status = :stopped
+      end
+
+      # @return True, if webservice is stopped, false otherwise
+      def stopped?
+        @status == :stopped
+      end
+
+      # @return True, if webservice is up and running, false otherwise
+      def running?
+        @status == :running
+      end
+
+      # Forces stopping the webservice.
+      def stop!
+        @status = :stopping
+
+        # invoke a new request, so that the webservice stops.
+        socket = TCPSocket.new('localhost', @config.webserver_port)
+        socket.send '', 0
+        socket.close
       end
 
       private
@@ -30,6 +57,14 @@ module GrafanaReporter
           # step 1) accept incoming connection
           socket = @server.accept
 
+          # TODO: shutdown properly on SIGINT/SIGHUB
+
+          # stop webservice properly, if shall be shutdown
+          if @status == :stopping
+            socket.close
+            break
+          end
+
           # step 2) print the request headers (separated by a blank line e.g. \r\n)
           request = ''
           line = ''
@@ -48,9 +83,6 @@ module GrafanaReporter
           rescue WebserviceUnknownPathError => e
             @logger.debug(e.message)
             socket.write http_response(404, '', e.message)
-          rescue MissingTemplateError => e
-            @logger.error(e.message)
-            socket.write http_response(400, 'Bad Request', e.message)
           rescue WebserviceGeneralRenderingError => e
             @logger.fatal(e.message)
             socket.write http_response(400, 'Bad Request', e.message)
@@ -160,17 +192,17 @@ module GrafanaReporter
 
         # provide report
         @logger.debug("Returning PDF report at #{report.path}")
-        content = File.read(report.path)
+        content = File.read(report.path, mode: 'rb')
         return http_response(200, 'OK', content, "Content-Type": 'application/pdf') if content.start_with?('%PDF')
 
-        # TODO: properly provide file as zip
         http_response(200, 'OK', content, "Content-Type": 'application/octet-stream',
-                                          "Content-Disposition": 'attachment; filename=report.zip')
+                                          "Content-Disposition": 'attachment; '\
+                                                                 "filename=report_#{attrs['report_id']}.zip")
       end
 
       def render_report(attrs)
         # build report
-        template_file = "#{@config.templates_folder}#{attrs['var-template']}.adoc"
+        template_file = "#{@config.templates_folder}#{attrs['var-template']}"
 
         file = Tempfile.new('gf_pdf_', @config.reports_folder)
         begin
@@ -179,9 +211,10 @@ module GrafanaReporter
           @logger.debug("File permissions could not be set for #{file.path}: #{e.message}")
         end
 
-        report = @config.report_class.new(@config, template_file, file, attrs)
+        report = @config.report_class.new(@config)
+        Thread.report_on_exception = false
         Thread.new do
-          report.create_report
+          report.create_report(template_file, file, attrs)
         end
         @reports << report
 
@@ -211,7 +244,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 {AbstractQuery#format_columns}
+    #
+    # +replace_values+ - see {AbstractQuery#replace_values}
+    #
+    # +filter_columns+ - see {AbstractQuery#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))
+        assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        defaults = {}
+        defaults['dashboardId'] = dashboard_id if dashboard_id
+        defaults['panelId'] = panel_id if panel_id
+
+        assign_doc_and_item_variables(query, 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 {AbstractQuery#format_columns}
+    #
+    # +replace_values+ - see {AbstractQuery#replace_values}
+    #
+    # +filter_columns+ - see {AbstractQuery#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))
+        assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard_id)) if dashboard_id
+        defaults = {}
+        defaults['dashboardId'] = dashboard_id if dashboard_id
+        defaults['panelId'] = panel_id if panel_id
+
+        assign_doc_and_item_variables(query, 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,77 @@
+# 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))
+          assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard))
+          assign_doc_and_item_variables(query, 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

data/lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb

@@ -0,0 +1,79 @@
+# 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 PanelImageInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+      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 PanelImageInlineMacro (instance: #{instance}, dashboard: #{dashboard},"\
+                             " panel: #{target})")
+
+        begin
+          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target))
+          # set alt text to a default, because otherwise asciidoctor fails
+          attrs['alt'] = '' unless attrs['alt']
+          assign_dashboard_defaults(query, @report.grafana(instance).dashboard(dashboard))
+          assign_doc_and_item_variables(query, 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_inline(parent, :quoted, e.message)
+        rescue StandardError => e
+          @report.logger.fatal(e.message)
+          return create_inline(parent, :quoted, e.message)
+        end
+
+        create_inline(parent, :image, nil, { target: image_path, attributes: attrs })
+      end
+
+      # @see ProcessorMixin#build_demo_entry
+      def build_demo_entry(panel)
+        return nil unless panel
+        return nil unless panel.model['type'] == 'graph'
+
+        "see here: grafana_panel_image:#{panel.id}[dashboard=\"#{panel.dashboard.id}\","\
+        'width="90%"] - a working inline image'
+      end
+    end
+  end
+end