ruby-grafana-reporter 0.2.0 → 0.4.1

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

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   include::grafana_sql_table:<datasource_id>[<options>]
-      #
-      # Returns the results of the SQL query as a asciidoctor table.
-      #
-      # == Used document parameters
-      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # All other variables starting with +var-+ will be used to replace grafana templating strings
-      # in the given SQL query.
-      #
-      # == Supported options
-      # +sql+ - sql statement (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +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 SqlTableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-        include ProcessorMixin
-
-        # :nodoc:
-        def handles?(target)
-          target.start_with? 'grafana_sql_table:'
-        end
-
-        # :nodoc:
-        def process(doc, reader, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
-          @report.logger.debug("Processing SqlTableIncludeProcessor (instance: #{instance},"\
-                               " datasource: #{target.split(':')[1]}, sql: #{attrs['sql']})")
-          query = SqlTableQuery.new(attrs['sql'], target.split(':')[1])
-          query.merge_hash_variables(doc.attributes, attrs)
-          @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/sql_value_inline_macro.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # Implements the hook
-      #   grafana_sql_value:<datasource_id>[<options>]
-      #
-      # Returns the first value of the resulting SQL query.
-      #
-      # == Used document parameters
-      # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +from+ - 'from' time for the sql query
-      #
-      # +to+ - 'to' time for the sql query
-      #
-      # All other variables starting with +var-+ will be used to replace grafana templating strings
-      # in the given SQL query.
-      #
-      # == Supported options
-      # +sql+ - sql statement (*mandatory*)
-      #
-      # +instance+ - name of grafana instance, 'default' if not specified
-      #
-      # +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 SqlValueInlineMacro < ::Asciidoctor::Extensions::InlineMacroProcessor
-        include ProcessorMixin
-        use_dsl
-
-        named :grafana_sql_value
-
-        # @see GrafanaReporter::Asciidoctor::SqlFirstValueQuery
-        def process(parent, target, attrs)
-          return if @report.cancel
-
-          @report.next_step
-          instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
-          @report.logger.debug("Processing SqlValueInlineMacro (instance: #{instance}, datasource: #{target},"\
-                               " sql: #{attrs['sql']})")
-          query = SqlFirstValueQuery.new(attrs['sql'], target)
-          query.merge_hash_variables(parent.document.attributes, attrs)
-          @report.logger.debug("from: #{query.from}, to: #{query.to}")
-
-          begin
-            create_inline(parent, :quoted, query.execute(@report.grafana(instance)))
-          rescue GrafanaReporterError => e
-            @report.logger.error(e.message)
-            create_inline(parent, :quoted, e.message)
-          rescue StandardError => e
-            @report.logger.fatal(e.message)
-            create_inline(parent, :quoted, e.message)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'processor_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    module Extensions
-      # TODO: add documentation
-      class ValueAsVariableIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
-        include ProcessorMixin
-
-        # :nodoc:
-        def handles?(target)
-          target.start_with? 'grafana_value_as_variable'
-        end
-
-        # :nodoc:
-        def process(doc, reader, target, attrs)
-          return if @report.cancel
-
-          # do NOT increase step, as this is done by sub processor
-          # @report.next_step
-
-          call_attr = attrs.delete('call')
-          call, target = call_attr.split(':') if call_attr
-          attribute = attrs.delete('variable_name')
-          @report.logger.debug("Processing ValueAsVariableIncludeProcessor (call: #{call}, target: #{target},"\
-                               " variable_name: #{attribute}, attrs: #{attrs})")
-          if !call || !attribute
-            @report.logger.error("Missing mandatory attribute 'call' or 'variable_name'.")
-            return reader
-          end
-
-          # TODO: remove dirty hack to allow the document as parameter for other processors
-          def doc.document
-            self
-          end
-
-          # TODO: properly show error messages also in document
-          ext = doc.extensions.find_inline_macro_extension(call) if doc.extensions.inline_macros?
-          if !ext
-            @report.logger.error("Could not find inline macro extension for '#{call}'.")
-          else
-            @report.logger.debug('ValueAsVariableIncludeProcessor: Calling sub-method.')
-            item = ext.process_method.call(doc, target, attrs)
-            if !item.text.to_s.empty?
-              result = ":#{attribute}: #{item.text}"
-              @report.logger.debug("ValueAsVariableIncludeProcessor: Adding '#{result}' to document.")
-              reader.unshift_line(result)
-            else
-              @report.logger.debug("ValueAsVariableIncludeProcessor: Not adding variable '#{attribute}',"\
-                                   ' as query result was empty.')
-            end
-          end
-
-          reader
-        end
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/panel_first_value_query.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'sql_first_value_query'
-
-module GrafanaReporter
-  module Asciidoctor
-    # (see SqlFirstValueQuery)
-    #
-    # The SQL query as well as the datasource configuration are thereby captured from a
-    # {Grafana::Panel}.
-    class PanelFirstValueQuery < SqlFirstValueQuery
-      include QueryMixin
-
-      # (see PanelTableQuery#initialize)
-      def initialize(panel, query_letter)
-        super(nil, nil)
-        @panel = panel
-        @query_letter = query_letter
-        extract_dashboard_variables(@panel.dashboard)
-      end
-
-      # (see PanelTableQuery#pre_process)
-      def pre_process(grafana)
-        @sql = @panel.query(@query_letter)
-        # resolve datasource name
-        @datasource = @panel.field('datasource')
-        @datasource_id = grafana.datasource_id(@datasource)
-        super(grafana)
-        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
-        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/panel_image_query.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module GrafanaReporter
-  module Asciidoctor
-    # This class is used to create an image out of a {Grafana::Panel}.
-    class PanelImageQuery < Grafana::PanelImageQuery
-      include QueryMixin
-
-      # Sets the proper render variables.
-      def pre_process(grafana)
-        super
-        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
-        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
-        # rename "render-" variables
-        @variables.transform_keys! { |k| k.gsub(/^render-/, '') }
-      end
-
-      # Returns the body of the http query, which contains the raw image.
-      def post_process
-        super
-        @result = @result.body
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/panel_property_query.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module GrafanaReporter
-  module Asciidoctor
-    # This class is used to query properties from a {Grafana::Panel}, such as +description+,
-    # +title+ etc.
-    class PanelPropertyQuery < ::Grafana::AbstractPanelQuery
-      include QueryMixin
-
-      # @param panel [Grafana::Panel] panel object, for which the property shall be retrieved
-      # @param property [String] queried property, e.g. +title+
-      def initialize(panel, property)
-        super(panel)
-        @property = property
-      end
-
-      # Overrides the default method, as the query does not have to run against a SQL table,
-      # but rather against the panel model.
-      # @param grafana [Grafana::Grafana] grafana instance against which the panel property is queried
-      # @return [String] fetched property
-      def execute(grafana)
-        return @result unless @result.nil?
-
-        pre_process(grafana)
-        @result = panel.field(@property)
-        post_process
-        @result
-
-        # TODO: handle text (markdown and similar) properly
-      end
-
-      # Prepare query. Mainly here nothing special has to take place.
-      def pre_process(_grafana)
-        @from = nil
-        @to = nil
-      end
-
-      # Replaces variables in the property field, if any are available.
-      def post_process
-        @result = replace_variables(@result, grafana_variables)
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/panel_table_query.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'sql_table_query'
-
-module GrafanaReporter
-  module Asciidoctor
-    # (see SqlTableQuery)
-    #
-    # The SQL query as well as the datasource configuration are thereby captured from a
-    # {Grafana::Panel}.
-    class PanelTableQuery < SqlTableQuery
-      include QueryMixin
-
-      # @param panel [Grafana::Panel] panel which contains the query
-      # @param query_letter [String] letter of the query within the panel, which shall be used, e.g. +C+
-      def initialize(panel, query_letter)
-        super(nil, nil)
-        @panel = panel
-        @query_letter = query_letter
-        extract_dashboard_variables(@panel.dashboard)
-      end
-
-      # Retrieves the SQL query and the configured datasource from the panel.
-      # @see Grafana::AbstractSqlQuery#pre_process
-      # @param grafana [Grafana::Grafana] grafana instance against which the query shall be executed
-      # @return [void]
-      def pre_process(grafana)
-        @sql = @panel.query(@query_letter)
-        # resolve datasource name
-        @datasource = @panel.field('datasource')
-        @datasource_id = grafana.datasource_id(@datasource)
-        super(grafana)
-        @from = translate_date(@from, @variables['grafana-report-timestamp'], false)
-        @to = translate_date(@to, @variables['grafana-report-timestamp'], true)
-      end
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/query_mixin.rb

@@ -1,310 +0,0 @@
-module GrafanaReporter
-  module Asciidoctor
-    # This mixin contains several common methods, which can be used within the queries.
-    module QueryMixin
-      # Merges the given hashes to the current object by using the {Grafana::AbstractQuery#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]
-      def merge_hash_variables(document_hash, item_hash)
-        merge_variables(document_hash.select { |k, _v| k =~ /^var-/ || k == 'grafana-report-timestamp' }.transform_values { |item| ::Grafana::Variable.new(item) })
-        # TODO: add documentation for transpose, column_divider and row_divider
-        merge_variables(item_hash.select { |k, _v| k =~ /^var-/ || k =~ /^render-/ || k =~ /filter_columns|format|replace_values_.*|transpose|column_divider|row_divider/ }.transform_values { |item| ::Grafana::Variable.new(item) })
-        # TODO: add documentation for timeout and grafana-default-timeout
-        self.timeout = item_hash['timeout'] || document_hash['grafana-default-timeout'] || timeout
-        self.from = item_hash['from'] || document_hash['from'] || from
-        self.to = item_hash['to'] || document_hash['to'] || to
-      end
-
-      # Formats the SQL results returned from grafana to an easier to use format.
-      #
-      # The result is being formatted as stated below:
-      #
-      #   {
-      #     :header => [column_title_1, column_title_2],
-      #     :content => [
-      #                   [row_1_column_1, row_1_column_2],
-      #                   [row_2_column_1, row_2_column_2]
-      #                 ]
-      #   }
-      # @param raw_result [Hash] query result hash from grafana
-      # @return [Hash] sql result formatted as stated above
-      # TODO: support series query results properly
-      def preformat_sql_result(raw_result)
-        results = {}
-        results.default = []
-
-        JSON.parse(raw_result)['results'].each_value do |query_result|
-          if query_result.key?('error')
-            results[:header] = results[:header] << ['SQL Error']
-            results[:content] = [[query_result['error']]]
-          elsif query_result['tables']
-            query_result['tables'].each do |table|
-              results[:header] = results[:header] << table['columns'].map { |header| header['text'] }
-              results[:content] = table['rows']
-            end
-          else
-            # TODO: add test for series results
-            results[:header] = 'time'
-            query_result['series'].each do |table|
-              results[:header] << table[:name]
-              results[:content] = []
-              content_position = results[:header].length - 1
-              table[:points].each do |point|
-                result = []
-                result << point[1]
-                (content_position - 1).times { result << nil }
-                result << point[0]
-                results[:content][0] << result
-              end
-            end
-          end
-        end
-
-        results
-      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 {#preformat_sql_result})
-      # @param transpose_variable [Grafana::Variable] true, if the result hash shall be transposed
-      # @return [Hash] transposed query result
-      def transpose(result, transpose_variable)
-        return result unless transpose_variable
-        return result unless transpose_variable.raw_value == 'true'
-
-        result[:content] = result[:content].transpose
-
-        result
-      end
-
-      # Filters columns out of the query result.
-      #
-      # 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 {#preformat_sql_result})
-      # @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)
-        return result unless filter_columns_variable
-
-        filter_columns = filter_columns_variable.raw_value
-        filter_columns.split(',').each do |filter_column|
-          pos = result[:header][0].index(filter_column)
-
-          unless pos.nil?
-            result[:header][0].delete_at(pos)
-            result[:content].each { |row| row.delete_at(pos) }
-          end
-        end
-
-        result
-      end
-
-      # Uses the {Kernel#format} method to format values in the query results.
-      #
-      # 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 {#preformat_sql_result})
-      # @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
-
-        formats.text.split(',').each_index do |i|
-          format = formats.text.split(',')[i]
-          next if format.empty?
-
-          result[:content].map do |row|
-            next unless row.length > i
-
-            begin
-              row[i] = format % row[i] if row[i]
-            rescue StandardError => e
-              row[i] = e.message
-            end
-          end
-        end
-        result
-      end
-
-      # Used to replace values in a query result according given configurations.
-      #
-      # The given variables will be applied to an appropriate column, depending
-      # on the naming of the variable. The variable name ending specifies the column,
-      # e.g. a variable named +replace_values_2+ will be applied to the second column.
-      #
-      # The {Grafana::Variable#text} needs to contain the replace specification.
-      # Multiple replacements can be specified by separating them with +,+. If a
-      # literal comma is needed, it can be escaped with a backslash:  +\\,+.
-      #
-      # The rule will be separated from the replacement text with a colon +:+.
-      # If a literal colon is wanted, it can be escaped with a backslash: +\\:+.
-      #
-      # Examples:
-      # - Basic string replacement
-      #    MyTest:ThisValue
-      # will replace all occurences of the text 'MyTest' with 'ThisValue'.
-      # - Number comparison
-      #     <=10:OK
-      # will replace all values smaller or equal to 10 with 'OK'.
-      # - Regular expression
-      #     ^[^ ]\\+ (\d+)$:\1 is the answer
-      # will replace all values matching the pattern, e.g. 'answerToAllQuestions 42' to
-      # '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 {#preformat_sql_result}.
-      # @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
-      def replace_values(result, configs)
-        return result if configs.empty?
-
-        configs.each do |key, formats|
-          cols = key.split('_')[2..-1].map(&:to_i)
-
-          formats.text.split(/(?<!\\),/).each_index do |j|
-            format = formats.text.split(/(?<!\\),/)[j]
-
-            arr = format.split(/(?<!\\):/)
-            raise MalformedReplaceValuesStatementError, format if arr.length != 2
-
-            k = arr[0]
-            v = arr[1]
-            k.gsub!(/\\([:,])/, '\1')
-            v.gsub!(/\\([:,])/, '\1')
-            result[:content].map do |row|
-              (row.length - 1).downto 0 do |i|
-                if cols.include?(i + 1) || cols.empty?
-
-                  # handle regular expressions
-                  if k.start_with?('^') && k.end_with?('$')
-                    begin
-                      row[i] = row[i].to_s.gsub(/#{k}/, v) if row[i].to_s =~ /#{k}/
-                    rescue StandardError => e
-                      row[i] = e.message
-                    end
-
-                  # handle value comparisons
-                  elsif (match = k.match(/^ *(?<operator>[<>]=?|<>|=) *(?<number>[+-]?\d+(?:\.\d+)?)$/))
-                    skip = false
-                    begin
-                      val = Float(row[i])
-                    rescue StandardError
-                      # value cannot be converted to number, simply ignore it as the comparison does not fit here
-                      skip = true
-                    end
-
-                    unless skip
-                      begin
-                        op = match[:operator].gsub(/^=$/, '==').gsub(/^<>$/, '!=')
-                        if val.public_send(op.to_sym, Float(match[:number]))
-                          row[i] = if v.include?('\\1')
-                                     v.gsub(/\\1/, row[i].to_s)
-                                   else
-                                     v
-                                   end
-                        end
-                      rescue StandardError => e
-                        row[i] = e.message
-                      end
-                    end
-
-                  # handle as normal comparison
-                  elsif row[i].to_s == k
-                    row[i] = v
-                  end
-                end
-              end
-            end
-          end
-        end
-
-        result
-      end
-
-      # Used to translate the relative date strings used by grafana, e.g. +now-5d/w+ to the
-      # correct timestamp. Reason is that grafana does this in the frontend, which we have
-      # to emulate here for the reporter.
-      #
-      # Additionally providing this function the +report_time+ assures that all queries
-      # rendered within one report will use _exactly_ the same timestamp in those relative
-      # times, i.e. there shouldn't appear any time differences, no matter how long the
-      # report is running.
-      # @param orig_date [String] time string provided by grafana, usually +from+ or +to+.
-      # @param report_time [Grafana::Variable] report start time
-      # @param is_to_time [Boolean] true, if the time should be calculated for +to+, false if it shall be
-      #   calculated for +from+
-      # @return [String] translated date as timestamp string
-      def translate_date(orig_date, report_time, is_to_time)
-        report_time ||= 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+$/
-
-        # replace grafana from and to values using now, now-2d etc.
-        date_splitted = orig_date.match(%r{^(?<now>now)(?:-(?<sub_count>\d+)?(?<sub_unit>[smhdwMy]?))?(?:/(?<fit>[smhdwMy]))?$})
-        raise TimeRangeUnknownError, orig_date unless date_splitted
-
-        date = DateTime.parse(report_time.raw_value)
-        # substract specified time
-        count = 1
-        count = date_splitted[:sub_count].to_i if date_splitted[:sub_count]
-        case date_splitted[:sub_unit]
-        when 's'
-          date = (date.to_time - (count * 1)).to_datetime
-        when 'm'
-          date = (date.to_time - (count * 60)).to_datetime
-        when 'h'
-          date = (date.to_time - (count * 60 * 60)).to_datetime
-        when 'd'
-          date = date.prev_day(count)
-        when 'w'
-          date = date.prev_day(count * 7)
-        when 'M'
-          date = date.prev_month(count)
-        when 'y'
-          date = date.prev_year(count)
-        end
-
-        # fit to specified time frame
-        case date_splitted[:fit]
-        when 's'
-          date = DateTime.new(date.year, date.month, date.day, date.hour, date.min, date.sec, date.zone)
-          date = (date.to_time + 1).to_datetime if is_to_time
-        when 'm'
-          date = DateTime.new(date.year, date.month, date.day, date.hour, date.min, 0, date.zone)
-          date = (date.to_time + 60).to_datetime if is_to_time
-        when 'h'
-          date = DateTime.new(date.year, date.month, date.day, date.hour, 0, 0, date.zone)
-          date = (date.to_time + 60 * 60).to_datetime if is_to_time
-        when 'd'
-          date = DateTime.new(date.year, date.month, date.day, 0, 0, 0, date.zone)
-          date = date.next_day(1) if is_to_time
-        when 'w'
-          date = DateTime.new(date.year, date.month, date.day, 0, 0, 0, date.zone)
-          date = if date.wday.zero?
-                   date.prev_day(7)
-                 else
-                   date.prev_day(date.wday - 1)
-                 end
-          date = date.next_day(7) if is_to_time
-        when 'M'
-          date = DateTime.new(date.year, date.month, 1, 0, 0, 0, date.zone)
-          date = date.next_month if is_to_time
-        when 'y'
-          date = DateTime.new(date.year, 1, 1, 0, 0, 0, date.zone)
-          date = date.next_year if is_to_time
-        end
-
-        (date.to_time.to_i * 1000).to_s
-      end
-    end
-  end
-end