ruby-grafana-reporter 0.4.5 → 0.5.2

data/lib/grafana_reporter/abstract_query.rb

@@ -13,7 +13,6 @@ module GrafanaReporter
     attr_reader :variables, :result, :panel, :dashboard
 
     def timeout
-      # TODO: PRIO check where value priorities should be evaluated
       return @variables['timeout'].raw_value if @variables['timeout']
       return @variables['grafana_default_timeout'].raw_value if @variables['grafana_default_timeout']
 
@@ -44,6 +43,7 @@ module GrafanaReporter
       else
         raise GrafanaReporterError, "Internal error in AbstractQuery: given object is of type #{grafana_obj.class.name}, which is not supported"
       end
+      @logger = @grafana ? @grafana.logger : ::Logger.new($stderr, level: :info)
       @variables = {}
       @variables['from'] = Grafana::Variable.new(nil)
       @variables['to'] = Grafana::Variable.new(nil)
@@ -79,7 +79,7 @@ module GrafanaReporter
       raise DatasourceNotSupportedError.new(@datasource, self) if @datasource.is_a?(Grafana::UnsupportedDatasource)
 
       begin
-        @result = @datasource.request(from: from, to: to, raw_query: raw_query, variables: grafana_variables,
+        @result = @datasource.request(from: from, to: to, raw_query: raw_query, variables: @variables,
                                       prepared_request: @grafana.prepare_request, timeout: timeout)
       rescue ::Grafana::GrafanaError
         # grafana errors will be directly passed through
@@ -143,6 +143,8 @@ module GrafanaReporter
     #
     # 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).
+    #
+    # Commas can be used in a format string, but need to be escaped by using +_,+.
     # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#request})
     # @param filter_columns_variable [Grafana::Variable] column names, which shall be removed in the query result
     # @return [Hash] filtered query result
@@ -150,8 +152,8 @@ module GrafanaReporter
       return result unless filter_columns_variable
 
       filter_columns = filter_columns_variable.raw_value
-      filter_columns.split(',').each do |filter_column|
-        pos = result[:header].index(filter_column)
+      filter_columns.split(/(?<!_),/).each do |filter_column|
+        pos = result[:header].index(filter_column.gsub("_,", ","))
 
         unless pos.nil?
           result[:header].delete_at(pos)
@@ -167,23 +169,33 @@ module GrafanaReporter
     # 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.
+    #
+    # It is also possible to format milliseconds as dates by specifying date formats, e.g. +date:iso+. It is
+    # possible to use any date format according
+    # {https://grafana.com/docs/grafana/latest/variables/variable-types/global-variables/#from-and-to}
+    #
+    # Commas can be used in a format string, but need to be escaped by using +_,+.
     # @param result [Hash] preformatted sql hash, (see {Grafana::AbstractDatasource#request})
     # @param formats [Grafana::Variable] formats, which shall be applied to the columns in the query result
     # @return [Hash] formatted query result
     def format_columns(result, formats)
       return result unless formats
 
-      formats.text.split(',').each_index do |i|
-        format = formats.text.split(',')[i]
+      formats.text.split(/(?<!_),/).each_index do |i|
+        format = formats.text.split(/(?<!_),/)[i].gsub("_,", ",")
         next if format.empty?
 
         result[:content].map do |row|
           next unless row.length > i
 
           begin
-            row[i] = format % row[i] if row[i]
+            if format =~ /^date:/
+              row[i] = ::Grafana::Variable.format_as_date(row[i], format.sub(/^date:/, '')) if row[i]
+            else
+              row[i] = format % row[i] if row[i]
+            end
           rescue StandardError => e
-            @grafana.logger.error(e.message)
+            @logger.error(e.message)
             row[i] = e.message
           end
         end
@@ -248,7 +260,7 @@ module GrafanaReporter
                   begin
                     row[i] = row[i].to_s.gsub(/#{k}/, v) if row[i].to_s =~ /#{k}/
                   rescue StandardError => e
-                    @grafana.logger.error(e.message)
+                    @logger.error(e.message)
                     row[i] = e.message
                   end
 
@@ -273,7 +285,7 @@ module GrafanaReporter
                                  end
                       end
                     rescue StandardError => e
-                      @grafana.logger.error(e.message)
+                      @logger.error(e.message)
                       row[i] = e.message
                     end
                   end
@@ -298,17 +310,19 @@ module GrafanaReporter
     # @option opts [Grafana::Variable] :column_divider requested row divider for the result table, only to be used with table_formatter `adoc_deprecated`
     # @option opts [Grafana::Variable] :include_headline specifies if table should contain headline, defaults to false
     # @option opts [Grafana::Variable] :table_formatter specifies which formatter shall be used, defaults to 'csv'
+    # @option opts [Grafana::Variable] :transposed specifies whether the result table is transposed
     # @return [String] table in custom output format
     def format_table_output(result, opts)
       opts = { include_headline: Grafana::Variable.new('false'),
                table_formatter: Grafana::Variable.new('csv'),
                row_divider: Grafana::Variable.new('| '),
-               column_divider: Grafana::Variable.new(' | ') }.merge(opts.delete_if {|_k, v| v.nil? })
+               column_divider: Grafana::Variable.new(' | '),
+               transpose: Grafana::Variable.new('false') }.merge(opts.delete_if {|_k, v| v.nil? })
 
       if opts[:table_formatter].raw_value == 'adoc_deprecated'
-        @grafana.logger.warn("You are using deprecated 'table_formatter' named 'adoc_deprecated', which will be "\
-                             "removed in a future version. Start using 'adoc_plain' or register your own "\
-                             "implementation of AbstractTableFormatStrategy.")
+        @logger.warn("You are using deprecated 'table_formatter' named 'adoc_deprecated', which will be "\
+                     "removed in a future version. Start using 'adoc_plain' or register your own "\
+                     "implementation of AbstractTableFormatStrategy.")
         return result[:content].map do |row|
           opts[:row_divider].raw_value + row.map do |item|
             item.to_s.gsub('|', '\\|')
@@ -316,7 +330,7 @@ module GrafanaReporter
         end.join("\n")
       end
 
-      AbstractTableFormatStrategy.get(opts[:table_formatter].raw_value).format(result, opts[:include_headline].raw_value.downcase == 'true')
+      AbstractTableFormatStrategy.get(opts[:table_formatter].raw_value).format(result, opts[:include_headline].raw_value.downcase == 'true', opts[:transpose].raw_value.downcase == 'true')
     end
 
     # Used to translate the relative date strings used by grafana, e.g. +now-5d/w+ to the
@@ -334,7 +348,7 @@ module GrafanaReporter
     # @param timezone [Grafana::Variable] timezone to use, if not system timezone
     # @return [String] translated date as timestamp string
     def translate_date(orig_date, report_time, is_to_time, timezone = nil)
-      @grafana.logger.warn("#translate_date has been called without 'report_time' - using current time as fallback.") unless report_time
+      @logger.warn("#translate_date has been called without 'report_time' - using current time as fallback.") unless report_time
       report_time ||= ::Grafana::Variable.new(Time.now.to_s)
       orig_date = orig_date.raw_value if orig_date.is_a?(Grafana::Variable)
 
@@ -405,8 +419,7 @@ module GrafanaReporter
     def datasource_response_valid?
       return false if @result.nil?
       return false unless @result.is_a?(Hash)
-      # TODO: compare how empty valid responses look like in grafana
-      return true if @result.empty?
+      return false if @result.empty?
       return false unless @result.key?(:header)
       return false unless @result.key?(:content)
       return false unless @result[:header].is_a?(Array)
@@ -415,12 +428,6 @@ module GrafanaReporter
       true
     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
-
     def delta_date(date, delta_count, time_letter)
       # substract specified time
       case time_letter

data/lib/grafana_reporter/abstract_report.rb

@@ -143,6 +143,8 @@ module GrafanaReporter
       notify(:on_before_create)
       @start_time = Time.new
       logger.info("Report started at #{@start_time}")
+      logger.info("You are running ruby-grafana-reporter version #{GRAFANA_REPORTER_VERSION.join('.')}.")
+      logger.info("A newer version is released. Check out https://github.com/divinity666/ruby-grafana-reporter/releases/latest") unless @config.latest_version_check_ok?
       build
     rescue MissingTemplateError => e
       @logger.error(e.message)

data/lib/grafana_reporter/abstract_table_format_strategy.rb

@@ -23,12 +23,52 @@ module GrafanaReporter
       raise NotImplementedError
     end
 
-    # @abstract
-    # @param column [Array] datasource table result
+    # Used to format a given content array to the desired output format. The default
+    # implementation applies the {#format_rules} to create a custom string export. If
+    # this is not sufficient for a desired table format, you may simply overwrite this
+    # function to have full freedom about the desired output.
+    # @param content [Hash] datasource table result
     # @param include_headline [Boolean] true, if headline should be included in result
+    # @param transposed [Boolean] true, if result array is in transposed format
     # @return [String] formatted in table format
-    def format(content, include_headline)
-      raise NotImplementedError
+    def format(content, include_headline, transposed)
+      result = content[:content]
+
+      # add the headline at the correct position to the content array
+      if include_headline
+        if transposed
+          result.each_index do |i|
+            result[i] = [content[:header][i]] + result[i]
+          end
+        else
+          result = result.unshift(content[:header])
+        end
+      end
+
+      # translate the content to a table
+      result.map do |row|
+        format_rules[:row_start] + row.map do |item|
+          value = item.to_s
+          if format_rules[:replace_string_or_regex]
+            value = value.gsub(format_rules[:replace_string_or_regex], format_rules[:replacement])
+          end
+
+          format_rules[:cell_start] + value + format_rules[:cell_end]
+        end.join(format_rules[:between_cells])
+      end.join(format_rules[:row_end])
+    end
+
+    # Formatting rules, which are applied to build the table output format.
+    def format_rules
+      {
+        row_start: '',
+        row_end: '',
+        cell_start: '',
+        between_cells: '',
+        cell_end: '',
+        replace_string_or_regex: nil,
+        replacement: ''
+      }
     end
   end
 end

data/lib/grafana_reporter/alerts_table_query.rb

@@ -37,7 +37,8 @@ module GrafanaReporter
                                     row_divider: @variables['row_divider'],
                                     column_divider: @variables['column_divider'],
                                     table_formatter: @variables['table_formatter'],
-                                    include_headline: @variables['include_headline'])
+                                    include_headline: @variables['include_headline'],
+                                    transpose: @variables['transpose'])
     end
   end
 end

data/lib/grafana_reporter/annotations_table_query.rb

@@ -36,7 +36,8 @@ module GrafanaReporter
                                     row_divider: @variables['row_divider'],
                                     column_divider: @variables['column_divider'],
                                     table_formatter: @variables['table_formatter'],
-                                    include_headline: @variables['include_headline'])
+                                    include_headline: @variables['include_headline'],
+                                    transpose: @variables['transpose'])
     end
   end
 end

data/lib/grafana_reporter/application/webservice.rb

@@ -26,7 +26,13 @@ module GrafanaReporter
         @progress_reporter = Thread.new {}
 
         @status = :running
-        accept_requests_loop
+        begin
+          accept_requests_loop
+        rescue SystemExit, Interrupt
+          @logger.info("Server shutting down.")
+          stop!
+          retry
+        end
         @status = :stopped
       end
 
@@ -57,8 +63,6 @@ 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
@@ -252,7 +256,7 @@ module GrafanaReporter
             <% end.join('') %>
             <tbody>
           </table>
-          <p style="font-size: small; color:grey">You are running ruby-grafana-reporter version <%= GRAFANA_REPORTER_VERSION.join('.') %>.</p>
+          <p style="font-size: small; color:grey">You are running ruby-grafana-reporter version <%= GRAFANA_REPORTER_VERSION.join('.') %>.<%= @config.latest_version_check_ok? ? '' : ' Check out the latest version <a href="https://github.com/divinity666/ruby-grafana-reporter/releases/latest">here</a>.' %></p>
           </body>
           </html>
         HTML_TEMPLATE

data/lib/grafana_reporter/asciidoctor/adoc_plain_table_format_strategy.rb

@@ -10,15 +10,17 @@ module GrafanaReporter
         'adoc_plain'
       end
 
-      # @see AbstractTableFormatStrategy#format
-      def format(result, include_headline)
-        headline = '| ' + result[:header].map { |item| item.to_s.gsub(' | ', '\\|') }.join(' | ')
-
-        content = result[:content].map do |row|
-          '| ' + row.map { |item| item.to_s.gsub(' | ', '\\|') }.join(' | ')
-        end.join("\n")
-
-        "#{"#{headline}\n" if include_headline}#{content}"
+      # @see AbstractTableFormatStrategy#format_rules
+      def format_rules
+        {
+          row_start: '| ',
+          row_end: "\n",
+          cell_start: '',
+          between_cells: ' | ',
+          cell_end: '',
+          replace_string_or_regex: '|',
+          replacement: '\\|'
+        }
       end
     end
   end

data/lib/grafana_reporter/asciidoctor/help.rb

@@ -22,12 +22,13 @@ module GrafanaReporter
       private
 
       def github_options
-        { headline_separator: '#', code_begin: '`', code_end: '`', table_begin: "\n", head_postfix_col: '| -- ' }
+        { headline_separator: '#', code_begin: '`', code_end: '`', table_begin: "\n", head_postfix_col: '| -- ',
+          table_linebreak: "<br />"}
       end
 
       def asciidoctor_options
         { headline_separator: '=', code_begin: '`+', code_end: '+`', table_begin: "\n[%autowidth.stretch, "\
-          "options=\"header\"]\n|===\n", table_end: "\n|===" }
+          "options=\"header\"]\n|===\n", table_end: "\n|===", table_linebreak: "\n\n" }
       end
 
       def help_text(opts)
@@ -82,7 +83,7 @@ Usage: #{opts[:code_begin]}#{v[:call]}#{opts[:code_end]}
 #{v[:description]}#{"\n\nSee also: #{v[:see]}" if v[:see]}#{unless v[:options].empty?
 %(
 #{opts[:table_begin]}| Option | Description#{"\n#{opts[:head_postfix_col] * 2}" if opts[:head_postfix_col]}
-#{v[:options].sort.map { |_opt_k, opt_v| "| #{opts[:code_begin]}#{opt_v[:call]}#{opts[:code_end]} | #{opt_v[:description].gsub('|', '\|')}" }.join("\n") }#{opts[:table_end]})
+#{v[:options].sort.map { |_opt_k, opt_v| "| #{opts[:code_begin]}#{opt_v[:call]}#{opts[:code_end]} | #{opt_v[:description].gsub('|', '\|')}#{"#{opts[:table_linebreak]}See also: #{opt_v[:see]}" if opt_v[:see]}" }.join("\n") }#{opts[:table_end]})
 end}
 )
         end
@@ -109,12 +110,12 @@ end}
           res_item[:description] = item['description']
           res_item[:see] = item['see']
 
-          opts = ((item['options'] ? item['options'].keys : [])
+          opts = ((item['options'] ? item['options'].keys : []) +
                   (item['standard_options'] ? item['standard_options'].keys : [])).sort
           opts.each do |opt_key|
             res_item[:options][opt_key] = {}
 
-            if item['standard_options'].key?(opt_key)
+            if std_opts.key?(opt_key)
               res_item[:options][opt_key][:call] = std_opts[opt_key]['call']
               res_item[:options][opt_key][:description] = "#{std_opts[opt_key]['description']} "\
                                                           "#{item['standard_options'][opt_key]}".chop
@@ -196,8 +197,12 @@ end}
             format:
               call: format="<format_col1>,<format_col2>,..."
               description: >-
-                Specify format in which the results shall be returned, e.g. `%.2f` for only two digit decimals of a
-                float. Several columns are separated by `,`. Execution is applied in the following order `format`,
+                Specify format in which the results in a specific column shall be returned, e.g. `%.2f` for only
+                two digit decimals of a float. Several column formats are separated by `,`, i.e. `%.2f,%.3f` would
+                apply `%.2f` to the first column and `%.3f` to the second column. All other columns would not be
+                formatted. You may also format time in milliseconds to a time format by specifying e.g. `date:iso`.
+                Commas in format strings are supported, but have to be escaped by useing `_,`.
+                Execution of related functions is applied in the following order `format`,
                 `replace_values`, `filter_columns`, `transpose`.
               see: 'https://ruby-doc.org/core/Kernel.html#method-i-sprintf'
 
@@ -207,21 +212,24 @@ end}
                 Specify result values which shall be replaced, e.g. `2:OK` will replace query values `2` with value `OK`.
                 Replacing several values is possible by separating by `,`. Matches with regular expressions are also
                 supported, but must be full matches, i.e. have to start with `^` and end with `$`, e.g. `^[012]$:OK`.
-                Number replacements can also be performed, e.g. `<8.2` or `<>3`. Execution is applied in the following order `format`,
+                Number replacements can also be performed, e.g. `<8.2` or `<>3`. Execution of related functions is
+                applied in the following order `format`,
                 `replace_values`, `filter_columns`, `transpose`.
               see: https://ruby-doc.org/core/Regexp.html#class-Regexp-label-Character+Classes
 
             filter_columns:
               call: filter_columns="<column_name_1>,<column_name_2>,..."
               description: >-
-                Removes specified columns from result. Execution is applied in the following order `format`, `replace_values`,
-                `filter_columns`, `transpose`.
+                Removes specified columns from result.  Commas in format strings are supported, but have to be
+                escaped by useing `_,`. Execution of related functions is applied in the following order
+                `format`, `replace_values`, `filter_columns`, `transpose`.
 
             transpose:
               call: transpose="true"
               description: >-
-                Transposes the query result, i.e. columns become rows and rows become columnns. Execution is applied in the
-                following order `format`, `replace_values`, `filter_columns`, `transpose`.
+                Transposes the query result, i.e. columns become rows and rows become columnns. Execution of related
+                functions is applied in the following order `format`, `replace_values`, `filter_columns`,
+                `transpose`.
 
             column_divider:
               call: column_divider="<divider>"
@@ -234,7 +242,7 @@ end}
               call: row_divider="<divider>"
               description: >-
                 Replace the default row divider with another one, when used in conjunction with `table_formatter` set to
-                `adoc_deprecated`. . Defaults to `| ` for being interpreted as a asciidoctor row. DEPRECATED: switch to
+                `adoc_deprecated`. Defaults to `| ` for being interpreted as a asciidoctor row. DEPRECATED: switch to
                 `table_formatter` named `adoc_plain`, or implement a custom table formatter.
 
             table_formatter:
@@ -249,6 +257,20 @@ end}
                 Set a timeout for the current query. If not overridden with `grafana_default_timeout` in the report template,
                 this defaults to 60 seconds.
 
+            interval:
+              call: interval="<intervaL>"
+              description: >-
+                Used to set the interval size for timescale datasources, whereas the value is used without further
+                conversion directly in the datasource specific interval parameter.
+                Prometheus default: 15 (passed as `step` parameter)
+                Influx default: similar to grafana default, i.e. `(to_time - from_time) / 1000`
+                (replaces `interval_ms` and `interval` variables in query)
+
+            instant:
+              call: instant="true"
+              description: >-
+                Optional parameter for Prometheus `instant` queries. Ignored for other datasources than Prometheus.
+
           # ----------------------------------
           # FUNCTION DOCUMENTATION STARTS HERE
           # ----------------------------------
@@ -258,8 +280,13 @@ end}
             call: 'include::grafana_help[]'
 
           grafana_environment:
-            description: Shows all available variables in the rendering context which can be used in the asciidoctor template.
+            description: >-
+              Shows all available variables in the rendering context which can be used in the asciidoctor template.
+              If optional `instance` is specified, additional information about the configured grafana instance will be provided.
+              This is especially helpful for debugging.
             call: 'include::grafana_environment[]'
+            standard_options:
+              instance:
 
           grafana_alerts:
             description: >-
@@ -391,6 +418,8 @@ end}
               transpose:
               from_timezone:
               to_timezone:
+              instant:
+              interval:
 
           grafana_panel_query_value:
             call: 'grafana_panel_query_value:<panel_id>[query="<query_letter>",options]'
@@ -413,6 +442,8 @@ end}
               to:
               from_timezone:
               to_timezone:
+              instant:
+              interval:
 
           grafana_sql_table:
             call: 'include::grafana_sql_table:<datasource_id>[sql="<sql_query>",options]'
@@ -434,12 +465,18 @@ end}
               transpose:
               from_timezone:
               to_timezone:
+              instant:
+              interval:
 
           grafana_sql_value:
             call: 'grafana_sql_value:<datasource_id>[sql="<sql_query>",options]'
             description: >-
               Returns the value in the first column and the first row of the given query.
               Grafana variables will be replaced in the SQL statement.
+
+              Please note that asciidoctor might fail, if you use square brackets in your
+              sql statement. To overcome this issue, you'll need to escape the closing
+              square brackets, i.e. +]+ needs to be replaced with +\\]+.
             see: https://grafana.com/docs/grafana/latest/variables/syntax/
             standard_options:
               filter_columns:
@@ -451,6 +488,8 @@ end}
               to:
               from_timezone:
               to_timezone:
+              instant:
+              interval:
         YAML_HELP
       end
     end

data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb

@@ -7,8 +7,8 @@ module GrafanaReporter
     # 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.
+    # Stores the queried panel as a temporary image file and returns a relative asciidoctor link
+    # to the storage location, which can then be included in the report.
     #
     # == Used document parameters
     # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
@@ -20,8 +20,6 @@ module GrafanaReporter
     # +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

data/lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb

@@ -7,8 +7,8 @@ module GrafanaReporter
     # 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.
+    # Stores the queried panel as a temporary image file and returns a relative asciidoctor link
+    # to the storage location, which can then be included in the report.
     #
     # == Used document parameters
     # +grafana_default_instance+ - name of grafana instance, 'default' if not specified
@@ -20,8 +20,6 @@ module GrafanaReporter
     # +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

data/lib/grafana_reporter/asciidoctor/processor_mixin.rb

@@ -40,7 +40,7 @@ module GrafanaReporter
           k =~ /^(?:timeout|from|to)$/ ||
           k =~ /filter_columns|format|replace_values_.*|transpose|from_timezone|
                to_timezone|result_type|query|table_formatter|include_headline|
-               column_divider|row_divider/x
+               column_divider|row_divider|instant|interval/x
         end)
 
         result

data/lib/grafana_reporter/asciidoctor/show_environment_include_processor.rb

@@ -13,6 +13,9 @@ module GrafanaReporter
     #
     # == Used document parameters
     # All, to be listed as the available environment.
+    #
+    # == Supported options
+    # +instance+ - grafana instance name, if extended information about the grafana instance shall be printed
     class ShowEnvironmentIncludeProcessor < ::Asciidoctor::Extensions::IncludeProcessor
       include ProcessorMixin
 
@@ -22,19 +25,47 @@ module GrafanaReporter
       end
 
       # :nodoc:
-      def process(doc, reader, _target, _attrs)
+      def process(doc, reader, _target, attrs)
         # return if @report.cancel
         @report.next_step
+        instance = attrs['instance'] || doc.attr('grafana_default_instance') || 'default'
+        attrs['result_type'] = 'sql_table'
         @report.logger.debug('Processing ShowEnvironmentIncludeProcessor')
+        grafana = @report.grafana(instance)
+
+        vars = { 'table_formatter' => 'adoc_plain', 'include_headline' => 'true'}
+        vars = vars.merge(build_attribute_hash(doc.attributes, attrs))
+
+        # query reporter environment
+        result = ['== Reporter', '|===']
+        query = QueryValueQuery.new(grafana, variables: vars.merge({'transpose' => 'true'}))
+        query.datasource = ::GrafanaReporter::ReporterEnvironmentDatasource.new(nil)
+        result += query.execute.split("\n")
+
+        # query grafana environment
+        result += ['|===', '',
+                   '== Grafana Instance', '|===']
+        query = QueryValueQuery.new(grafana, variables: vars.merge({'transpose' => 'true'}))
+        query.raw_query = {grafana: grafana, mode: 'general'}
+        query.datasource = ::Grafana::GrafanaEnvironmentDatasource.new(nil)
+        result += query.execute.split("\n")
+
+        result += ['|===', '',
+                   '== Accessible Dashboards', '|===']
+        query = QueryValueQuery.new(grafana, variables: vars)
+        query.raw_query = {grafana: grafana, mode: 'dashboards'}
+        query.datasource = Grafana::GrafanaEnvironmentDatasource.new(nil)
+        result += query.execute.split("\n")
 
-        vars = ['== Accessible Variables',
-                '|===']
+        result += ['|===', '',
+                   '== Accessible Variables',
+                   '|===']
         doc.attributes.sort.each do |k, v|
-          vars << "| `+{#{k}}+` | #{v}"
+          result << "| `+{#{k}}+` | #{v}"
         end
-        vars << '|==='
+        result << '|==='
 
-        reader.unshift_lines vars
+        reader.unshift_lines result
       end
 
       # @see ProcessorMixin#build_demo_entry

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -44,15 +44,24 @@ module GrafanaReporter
         @report.next_step
         instance = attrs['instance'] || parent.document.attr('grafana_default_instance') || 'default'
         attrs['result_type'] = 'sql_value'
+        sql = attrs['sql']
         @report.logger.debug("Processing SqlValueInlineMacro (instance: #{instance}, datasource: #{target},"\
-                             " sql: #{attrs['sql']})")
+                             " sql: #{sql})")
+
+        # translate sql statement to fix asciidoctor issue
+        # refer https://github.com/asciidoctor/asciidoctor/issues/4072#issuecomment-991305715
+        sql_translated = CGI::unescapeHTML(sql) if sql
+        if sql != sql_translated
+          @report.logger.debug("Translating SQL query to fix asciidoctor issue: #{sql_translated}")
+          sql = sql_translated
+        end
 
         begin
           # catch properly if datasource could not be identified
           query = QueryValueQuery.new(@report.grafana(instance),
                                       variables: build_attribute_hash(parent.document.attributes, attrs))
           query.datasource = @report.grafana(instance).datasource_by_id(target)
-          query.raw_query = attrs['sql']
+          query.raw_query = sql
 
           create_inline(parent, :quoted, query.execute)
         rescue Grafana::GrafanaError => e

data/lib/grafana_reporter/asciidoctor/value_as_variable_include_processor.rb

@@ -58,11 +58,6 @@ module GrafanaReporter
           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