ruby-grafana-reporter 0.1.6

data/lib/grafana_reporter/asciidoctor/annotations_table_query.rb

@@ -0,0 +1,96 @@
+module GrafanaReporter
+  module Asciidoctor
+    # This class is used to query annotations from grafana.
+    class AnnotationsTableQuery < Grafana::AbstractQuery
+      include QueryMixin
+
+      # @option opts [Grafana::Dashboard] :dashboard dashboard, if annotations shall be filtered for a dashboard
+      # @option opts [Grafana::Panel] :panel panel, if annotations shall be filtered for a panel
+      def initialize(opts = {})
+        super()
+
+        @dashboard = opts[:dashboard]
+        @panel = opts[:panel]
+        @dashboard = @panel.dashboard if @panel
+
+        extract_dashboard_variables(@dashboard) if @dashboard
+      end
+
+      # @return [String] URL for querying annotations
+      def url
+        '/api/annotations' + url_parameters
+      end
+
+      # @return [Hash] empty hash object
+      def request
+        {}
+      end
+
+      # 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(_grafana)
+        raise MissingMandatoryAttributeError, 'columns' unless @variables['columns']
+
+        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
+        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
+      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
+        # extract data from returned json
+        result = JSON.parse(@result.body)
+        content = []
+        begin
+          result.each { |item| content << item.fetch_values(*@variables['columns'].raw_value.split(',')) }
+        rescue KeyError => e
+          raise MalformedAttributeContentError.new(e.message, 'columns', @variables['columns'])
+        end
+
+        result = {}
+        result[:header] = [@variables['columns'].raw_value.split(',')]
+        result[:content] = content
+
+        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'])
+        if @variables['filter_column']
+          @report.logger.warn("DEPRECATED: Call of  no longer supported function 'filter_column' has been found. Rename to 'filter_columns'")
+          result = filter_columns(result, @variables['filter_column'])
+        end
+
+        @result = result[:content].map { |row| '| ' + row.map { |item| item.to_s.gsub('|', '\\|') }.join(' | ') }
+      end
+
+      private
+
+      def url_parameters
+        url_vars = {}
+        url_vars['dashboardId'] = ::Grafana::Variable.new(@dashboard.id) if @dashboard
+        url_vars['panelId'] = ::Grafana::Variable.new(@panel.id) if @panel
+
+        url_vars.merge!(variables.select { |k, _v| k =~ /^(?:limit|alertId|dashboardId|panelId|userId|type|tags)/ })
+        url_vars['from'] = ::Grafana::Variable.new(@from) if @from
+        url_vars['to'] = ::Grafana::Variable.new(@to) if @to
+        url_params = URI.encode_www_form(url_vars.map { |k, v| [k, v.raw_value.to_s] })
+        return '' if url_params.empty?
+
+        '?' + url_params
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/errors.rb

@@ -0,0 +1,37 @@
+module GrafanaReporter
+  # This module contains all classes, which are necessary to use the grafana
+  # reporter to be used in conjunction with asciidoctor.
+  module Asciidoctor
+    # Thrown, if the value configuration in {QueryMixin#replace_values} is
+    # invalid.
+    class MalformedReplaceValuesStatementError < GrafanaReporterError
+      def initialize(statement)
+        super("The specified replace_values statement '#{statement}' is invalid. Make sure it contains exactly one not escaped ':' symbol.")
+      end
+    end
+
+    # Thrown, if a configured parameter is malformed.
+    class MalformedAttributeContentError < GrafanaReporterError
+      def initialize(message, attribute, content)
+        super("The content '#{content}' in attribute '#{attribute}' is malformed: #{message}")
+      end
+    end
+
+    # Thrown, if a configured time range is not supported by the reporter.
+    #
+    # If this happens, most likely the reporter has to implement the new
+    # time range definition.
+    class TimeRangeUnknownError < GrafanaReporterError
+      def initialize(time_range)
+        super("The specified time range '#{time_range}' is unknown.")
+      end
+    end
+
+    # Thrown, if a mandatory attribute is not set.
+    class MissingMandatoryAttributeError < GrafanaReporterError
+      def initialize(attribute)
+        super("Missing mandatory attribute '#{attribute}'.")
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/extensions/alerts_table_include_processor.rb

@@ -0,0 +1,86 @@
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # 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 = if dashboard_id.to_s.empty?
+                    # no dashboard shall be used, so also the panel will be omitted
+                    AlertsTableQuery.new
+                  elsif panel_id.to_s.empty?
+                    # a dashboard is given, but no panel, so set filter for dashboard only
+                    AlertsTableQuery.new(dashboard: @report.grafana(instance).dashboard(dashboard_id))
+                  else
+                    # dashboard and panel is given, so set filter for panel
+                    AlertsTableQuery.new(panel: @report.grafana(instance).dashboard(dashboard_id).panel(panel_id))
+                  end
+
+          query.merge_hash_variables(doc.attributes, attrs)
+          query.merge_variables(attrs.select { |k, _v| k =~ /(?:columns|limit|folderId|dashboardId|panelId|dahboardTag|dashboardQuery|state|query)/ }.transform_values { |item| ::Grafana::Variable.new(item) })
+          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+
+          begin
+            reader.unshift_lines query.execute(@report.grafana(instance))
+          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
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/extensions/annotations_table_include_processor.rb

@@ -0,0 +1,86 @@
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # 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 = if dashboard_id.to_s.empty?
+                    # no dashboard shall be used, so also the panel will be omitted
+                    AnnotationsTableQuery.new
+                  elsif panel_id.to_s.empty?
+                    # a dashboard is given, but no panel, so set filter for dashboard only
+                    AnnotationsTableQuery.new(dashboard: @report.grafana(instance).dashboard(dashboard_id))
+                  else
+                    # dashboard and panel is given, so set filter for panel
+                    AnnotationsTableQuery.new(panel: @report.grafana(instance).dashboard(dashboard_id).panel(panel_id))
+                  end
+
+          query.merge_hash_variables(doc.attributes, attrs)
+          query.merge_variables(attrs.select { |k, _v| k =~ /(?:columns|limit|alertId|dashboardId|panelId|userId|type|tags)/ }.transform_values { |item| ::Grafana::Variable.new(item) })
+          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+
+          begin
+            reader.unshift_lines query.execute(@report.grafana(instance))
+          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
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/extensions/panel_image_block_macro.rb

@@ -0,0 +1,67 @@
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # 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})")
+          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}")
+
+          begin
+            image = query.execute(@report.grafana(instance))
+            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
+          block = create_image_block(parent, attrs)
+          block
+        end
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/extensions/panel_image_inline_macro.rb

@@ -0,0 +1,65 @@
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # 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})")
+          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}")
+
+          begin
+            image = query.execute(@report.grafana(instance))
+            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
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/extensions/panel_property_inline_macro.rb

@@ -0,0 +1,58 @@
+require_relative 'processor_mixin'
+
+module GrafanaReporter
+  module Asciidoctor
+    module Extensions
+      # Implements the hook
+      #   grafana_panel_property:<panel_id>[<options>]
+      #
+      # Returns the requested panel property.
+      #
+      # == Used document parameters
+      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
+      #
+      # +grafana_default_dashboard+ - uid of grafana default dashboard to use
+      #
+      # == 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
+      class PanelPropertyInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
+        include ProcessorMixin
+        use_dsl
+
+        named :grafana_panel_property
+        name_positional_attributes :field
+
+        # :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 PanelPropertyInlineMacro (instance: #{instance}, dashboard: #{dashboard}, panel: #{target}, property: #{attrs[:field]})")
+          query = PanelPropertyQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), attrs[:field])
+          query.merge_hash_variables(parent.document.attributes, attrs)
+          @report.logger.debug("from: #{query.from}, to: #{query.to}")
+
+          begin
+            description = query.execute(@report.grafana(instance))
+          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
+
+          # translate linebreaks to asciidoctor syntax
+          # and HTML encode to make sure, that HTML formattings are respected
+          create_inline(parent, :quoted, CGI.escapeHTML(description.gsub(%r{//[^\n]*(?:\n)?}, '').gsub(/\n/, " +\n")))
+        end
+      end
+    end
+  end
+end