RubyGems - ruby-grafana-reporter - Versions diffs - 0.4.2 → 0.5.0 - Mend

ruby-grafana-reporter 0.4.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

checksums.yaml +4 -4
data/README.md +144 -11
data/lib/VERSION.rb +2 -2
data/lib/grafana/abstract_datasource.rb +9 -3
data/lib/grafana/dashboard.rb +6 -1
data/lib/grafana/errors.rb +4 -11
data/lib/grafana/grafana.rb +25 -1
data/lib/grafana/grafana_environment_datasource.rb +56 -0
data/lib/grafana/grafana_property_datasource.rb +8 -1
data/lib/grafana/image_rendering_datasource.rb +5 -1
data/lib/grafana/influxdb_datasource.rb +87 -3
data/lib/grafana/panel.rb +1 -1
data/lib/grafana/prometheus_datasource.rb +11 -2
data/lib/grafana/sql_datasource.rb +3 -9
data/lib/grafana/variable.rb +67 -36
data/lib/grafana/webrequest.rb +1 -0
data/lib/grafana_reporter/abstract_query.rb +65 -39
data/lib/grafana_reporter/abstract_report.rb +19 -4
data/lib/grafana_reporter/abstract_table_format_strategy.rb +74 -0
data/lib/grafana_reporter/alerts_table_query.rb +6 -1
data/lib/grafana_reporter/annotations_table_query.rb +6 -1
data/lib/grafana_reporter/application/application.rb +7 -2
data/lib/grafana_reporter/application/webservice.rb +41 -32
data/lib/grafana_reporter/asciidoctor/adoc_plain_table_format_strategy.rb +27 -0
data/lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb +3 -2
data/lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb +3 -2
data/lib/grafana_reporter/asciidoctor/help.rb +470 -0
data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb +7 -5
data/lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb +7 -5
data/lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb +5 -1
data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb +6 -2
data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb +3 -0
data/lib/grafana_reporter/asciidoctor/processor_mixin.rb +3 -2
data/lib/grafana_reporter/asciidoctor/report.rb +15 -13
data/lib/grafana_reporter/asciidoctor/show_environment_include_processor.rb +37 -6
data/lib/grafana_reporter/asciidoctor/show_help_include_processor.rb +1 -1
data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb +6 -2
data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb +5 -1
data/lib/grafana_reporter/asciidoctor/value_as_variable_include_processor.rb +0 -5
data/lib/grafana_reporter/configuration.rb +27 -0
data/lib/grafana_reporter/console_configuration_wizard.rb +5 -3
data/lib/grafana_reporter/csv_table_format_strategy.rb +25 -0
data/lib/grafana_reporter/demo_report_wizard.rb +3 -7
data/lib/grafana_reporter/erb/demo_report_builder.rb +46 -0
data/lib/grafana_reporter/erb/report.rb +13 -7
data/lib/grafana_reporter/errors.rb +9 -7
data/lib/grafana_reporter/panel_image_query.rb +1 -1
data/lib/grafana_reporter/query_value_query.rb +7 -1
data/lib/grafana_reporter/report_webhook.rb +12 -8
data/lib/grafana_reporter/reporter_environment_datasource.rb +24 -0
metadata +9 -3
data/lib/grafana_reporter/help.rb +0 -443

data/lib/grafana_reporter/application/webservice.rb CHANGED Viewed

@@ -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
@@ -224,35 +228,40 @@ module GrafanaReporter
       def get_reports_status_as_html(reports)
         i = reports.length
-        content = '<html>'\
-                  '<head></head>'\
-                  '<body>'\
-                  '<table>'\
-                  '<thead>'\
-                  '<th>#</th>'\
-                  '<th>Start Time</th>'\
-                  '<th>End Time</th>'\
-                  '<th>Template</th>'\
-                  '<th>Execution time</th>'\
-                  '<th>Status</th>'\
-                  '<th>Error</th>'\
-                  '<th>Action</th>'\
-                  '</thead>' +
-                  reports.reverse.map do |report|
-                    '<tr>'\
-                    "<td>#{i -= 1}</td>"\
-                    "<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.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>"\
-                    '</tr>'
-                  end.join('') +
-                  '</table></body></html>'
+        # TODO: make reporter HTML results customizable
+        template = <<~HTML_TEMPLATE
+          <html>
+          <head></head>
+          <body>
+          <table>
+            <thead>
+              <th>#</th><th>Start Time</th><th>End Time</th><th>Template</th><th>Execution time</th>
+              <th>Status</th><th>Error</th><th>Action</th>
+            </thead>
+            <tbody>
+            <% reports.reverse.map do |report| %>
+              <tr><td><%= i-= 1 %></td><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><% if !report.done && !report.cancel %>
+                <a href="/cancel_report?report_id=<%= report.object_id %>">Cancel</a>
+              <% end %>
+              &nbsp;
+              <% if (report.status == 'finished') || (report.status == 'cancelled') %>
+                <a href="/view_report?report_id=<%= report.object_id %>">View</a>
+              <% end %>
+              &nbsp;
+              <a href="/view_log?report_id=<%= report.object_id %>">Log</a></td></tr>
+            <% end.join('') %>
+            <tbody>
+          </table>
+          <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
+        content = ::ERB.new(template).result(binding)
         http_response(200, 'OK', content, "Content-Type": 'text/html')
       end

data/lib/grafana_reporter/asciidoctor/adoc_plain_table_format_strategy.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module GrafanaReporter
+  module Asciidoctor
+    # Implements a default table format strategy, which will return tables
+    # as asciidoctor formatted table.
+    class AdocPlainTableFormatStrategy < AbstractTableFormatStrategy
+      # @see AbstractTableFormatStrategy#abbreviation
+      def self.abbreviation
+        'adoc_plain'
+      end
+      # @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
+end

data/lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb CHANGED Viewed

@@ -59,7 +59,8 @@ module GrafanaReporter
         grafana_obj = @report.grafana(instance).dashboard(dashboard_id) if dashboard_id
         grafana_obj = grafana_obj.panel(panel_id) if panel_id
-        query = AlertsTableQuery.new(grafana_obj, variables: build_attribute_hash(doc.attributes, attrs))
+        vars = { 'table_formatter' => 'adoc_plain' }.merge(build_attribute_hash(doc.attributes, attrs))
+        query = AlertsTableQuery.new(grafana_obj, variables: vars)
         defaults = {}
         defaults['dashboardId'] = dashboard_id if dashboard_id
         defaults['panelId'] = panel_id if panel_id
@@ -70,7 +71,7 @@ module GrafanaReporter
         query.raw_query = defaults.merge(selected_attrs.each_with_object({}) { |(k, v), h| h[k] = v })
         begin
-          reader.unshift_lines query.execute
+          reader.unshift_lines query.execute.split("\n")
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"

data/lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb CHANGED Viewed

@@ -58,7 +58,8 @@ module GrafanaReporter
         grafana_obj = @report.grafana(instance).dashboard(dashboard_id) if dashboard_id
         grafana_obj = grafana_obj.panel(panel_id) if panel_id
-        query = AnnotationsTableQuery.new(grafana_obj, variables: build_attribute_hash(doc.attributes, attrs))
+        vars = { 'table_formatter' => 'adoc_plain' }.merge(build_attribute_hash(doc.attributes, attrs))
+        query = AnnotationsTableQuery.new(grafana_obj, variables: vars)
         defaults = {}
         defaults['dashboardId'] = dashboard_id if dashboard_id
         defaults['panelId'] = panel_id if panel_id
@@ -69,7 +70,7 @@ module GrafanaReporter
         query.raw_query = defaults.merge(selected_attrs.each_with_object({}) { |(k, v), h| h[k] = v })
         begin
-          reader.unshift_lines query.execute
+          reader.unshift_lines query.execute.split("\n")
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           reader.unshift_line "|#{e.message}"

data/lib/grafana_reporter/asciidoctor/help.rb ADDED Viewed

@@ -0,0 +1,470 @@
+# frozen_string_literal: true
+require 'yaml'
+module GrafanaReporter
+  module Asciidoctor
+    # This class generates the functional help documentation for the asciidoctor report.
+    # It can create the documentation for github markdown, as well as in asciidoctor syntax.
+    class Help
+      # @param headline_level [Integer] top level of headline
+      # @return [String] asciidoctor compatible documentation
+      def asciidoctor(headline_level = 2)
+        help_text(asciidoctor_options.merge(level: headline_level))
+      end
+      # @param headline_level [Integer] top level of headline
+      # @return [String] github markdown compatible documentation
+      def github(headline_level = 2)
+        "#{toc}\n\n#{help_text(github_options.merge(level: headline_level))}"
+      end
+      private
+      def github_options
+        { headline_separator: '#', code_begin: '`', code_end: '`', table_begin: "\n", head_postfix_col: '| -- ' }
+      end
+      def asciidoctor_options
+        { headline_separator: '=', code_begin: '`+', code_end: '+`', table_begin: "\n[%autowidth.stretch, "\
+          "options=\"header\"]\n|===\n", table_end: "\n|===" }
+      end
+      def help_text(opts)
+        %(#{opts[:headline_separator] * opts[:level]} Global options
+#{global_options_as_text(opts.merge(level: opts[:level] + 1))}
+#{opts[:headline_separator] * opts[:level]} Functions
+#{functions_as_text(opts.merge(level: opts[:level] + 1))})
+      end
+      def toc
+        result = []
+        result << 'Table of contents'
+        result << '* [Global options](#global-options)'
+        prepared_help[:global_options].sort.map do |k, _v|
+          result << "  * [#{k}](##{k.downcase})"
+        end
+        result << '* [Functions](#functions)'
+        prepared_help[:functions].sort.map do |k, _v|
+          result << "  * [#{k}](##{k.downcase})"
+        end
+        result.join("\n")
+      end
+      def global_options_as_text(opts = {})
+        opts = { level: 3 }.merge(opts)
+        result = []
+        prepared_help[:global_options].sort.map do |k, v|
+          result << %(
+#{opts[:headline_separator] * opts[:level]} #{opts[:code_begin]}#{k}#{opts[:code_end]}
+Usage: #{opts[:code_begin]}#{v['call']}#{opts[:code_end]}
+#{v['description']}
+)
+        end
+        result.join
+      end
+      def functions_as_text(opts = {})
+        opts = { level: 3, headline_separator: '=' }.merge(opts)
+        result = []
+        prepared_help[:functions].sort.map do |k, v|
+          result << %(
+#{opts[:headline_separator] * opts[:level]} #{opts[:code_begin]}#{k}#{opts[:code_end]}
+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('|', '\|')}#{"\nSee also: #{opt_v[:see]}" if opt_v[:see]}" }.join("\n") }#{opts[:table_end]})
+end}
+)
+        end
+        result.join
+      end
+      def prepared_help
+        yaml = YAML.safe_load(raw_help_yaml)
+        result = {}
+        result[:functions] = {}
+        result[:global_options] = yaml['global_options']
+        functions = result[:functions]
+        std_opts = yaml['standard_options']
+        yaml.reject { |k, _v| k =~ /.*_options$/ }.each_key do |key|
+          functions[key] = {}
+          res_item = functions[key]
+          res_item[:options] = {}
+          item = yaml[key]
+          res_item[:call] = item['call']
+          res_item[:description] = item['description']
+          res_item[:see] = item['see']
+          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 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
+              res_item[:options][opt_key][:see] = std_opts[opt_key]['see'] if std_opts[opt_key]['see']
+            else
+              res_item[:options][opt_key][:call] = item['options'][opt_key]['call']
+              res_item[:options][opt_key][:description] = item['options'][opt_key]['description']
+              res_item[:options][opt_key][:see] = item['options'][opt_key]['see'] if item['options'][opt_key]['see']
+            end
+          end
+        end
+        result
+      end
+      def raw_help_yaml
+        <<~YAML_HELP
+          global_options:
+            grafana_default_instance:
+              call: ":grafana_default_instance: <instance_name>"
+              description: >-
+                Specifies which grafana instance shall be used. If not set, the grafana instance names `default`
+                will be used.
+            grafana_default_dashboard:
+              call: ":grafana_default_dashboard: <dashboard_uid>"
+              description: >-
+                Specifies to which dashboard the queries shall be targeted by default.
+            grafana_default_from_timezone:
+              call: ":grafana_default_from_timezone: <timezone>"
+              description: Specifies which timezone shall be used for the `from` time, e.g. `CET` or `CEST`.
+            grafana_default_to_timezone:
+              call: ":grafana_default_to_timezone: <timezone>"
+              description: Specifies which timezone shall be used for the `to` time, e.g. `CET` or `CEST`.
+            from:
+              call: ":from: <from_timestamp>"
+              description: >-
+                Overrides the time setting from grafana. It may contain dates as `now-1M/M`, which will be translated
+                properly to timestamps relative to the called time.
+            to:
+              call: ":to: <to_timestamp>"
+              description: >-
+                Overrides the time setting from grafana. It may contain dates as `now-1M/M`, which will be translated
+                properly to timestamps relative to the called time.
+          standard_options:
+            instance:
+              call: instance="<instance_name>"
+              description: >-
+                can be used to override global grafana instance, set in the report with `grafana_default_instance`.
+                If nothing is set, the configured grafana instance with name `default` will be used.
+            dashboard:
+              call: dashboard="<dashboard_uid>"
+              description: >-
+                Specifies the dashboard to be used. If `grafana_default_dashboard` is specified in the report template,
+                this value can be overridden with this option.
+            from:
+              call: from="<timestamp>"
+              description: can be used to override default `from` time
+            from_timezone:
+              call: from_timezone="<timezone>"
+              description: can be used to override system timezone for `from` time and will also override `grafana_default_from_timezone` option
+            to_timezone:
+              call: to_timezone="<timezone>"
+              description: can be used to override system timezone for `to` time and will also override `grafana_default_to_timezone` option
+            to:
+              call: to="<timestamp>"
+              description: can be used to override default `to` time
+            format:
+              call: format="<format_col1>,<format_col2>,..."
+              description: >-
+                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'
+            replace_values:
+              call: replace_values="<replace_1>:<with_1>,<replace_2>:<with_2>,..."
+              description: >-
+                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 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.  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 of related
+                functions is applied in the following order `format`, `replace_values`, `filter_columns`,
+                `transpose`.
+            column_divider:
+              call: column_divider="<divider>"
+              description: >-
+                Replace the default column divider with another one, when used in conjunction with `table_formatter` set to
+                `adoc_deprecated`. Defaults to ` | ` for being interpreted as a asciidoctor column. DEPRECATED: switch to
+                `table_formatter` named `adoc_plain`, or implement a custom table formatter.
+            row_divider:
+              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
+                `table_formatter` named `adoc_plain`, or implement a custom table formatter.
+            table_formatter:
+              call: table_formatter="<formatter>"
+              description: >-
+                Specify a table formatter fitting for your expected target format. It defaults to `adoc_plain` for asciidoctor
+                templates and to `csv` for all other templates, e.g. ERB.
+            timeout:
+              call: timeout="<timeout_in_seconds>"
+              description: >-
+                Set a timeout for the current query. If not overridden with `grafana_default_timeout` in the report template,
+                this defaults to 60 seconds.
+          # ----------------------------------
+          # FUNCTION DOCUMENTATION STARTS HERE
+          # ----------------------------------
+          grafana_help:
+            description: Show all available grafana calls within the asciidoctor templates, including available options.
+            call: 'include::grafana_help[]'
+          grafana_environment:
+            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: >-
+              Returns a table of active alert states including the specified columns and the connected information. Supports
+              all query parameters from the Grafana Alerting API, such as `query`, `state`, `limit`, `folderId` and others.
+            call: 'include::grafana_alerts[columns="<column_name_1>,<column_name_2>,...",options]'
+            see: https://grafana.com/docs/grafana/latest/http_api/alerting/#get-alerts
+            options:
+              columns:
+                description: >-
+                  Specifies columns that shall be returned. Valid columns are `id`, `dashboardId`, `dashboardUId`, `dashboardSlug`,
+                  `panelId`, `name`, `state`, `newStateDate`, `evalDate`, `evalData` and `executionError`.
+                call: columns="<column_name_1>,<columns_name_2>,..."
+              panel:
+                description: >-
+                  If specified, the resulting alerts are filtered for this panel. This option will only work, if a `dashboard`
+                  or `grafana_default_dashboard` is set.
+                call: panel="<panel_id>"
+            standard_options:
+              column_divider:
+              dashboard: >-
+                If this option, or the global option `grafana_default_dashboard` is set, the resulting alerts will be limited to
+                this dashboard. To show all alerts in this case, specify `dashboard=""` as option.
+              filter_columns:
+              format:
+              from:
+              instance:
+              replace_values:
+              row_divider:
+              table_formatter:
+              timeout:
+              to:
+              transpose:
+              from_timezone:
+              to_timezone:
+          grafana_annotations:
+            description: >-
+              Returns a table of all annotations, matching the specified filter criteria and the specified columns. Supports all
+              query parameters from the Grafana Alerting API, such as `limit`, `alertId`, `panelId` and others.
+            call: 'include::grafana_annotations[columns="<column_name_1>,<column_name_2>,...",options]'
+            see: https://grafana.com/docs/grafana/latest/http_api/annotations/#find-annotations
+            options:
+              columns:
+                description: >-
+                  Specified the columns that shall be returned. Valid columns are `id`, `alertId`, `dashboardId`, `panelId`, `userId`,
+                  `userName`, `newState`, `prevState`, `time`, `timeEnd`, `text`, `metric` and `type`.
+                call: columns="<column_name_1>,<columns_name_2>,..."
+              panel:
+                description: >-
+                  If specified, the resulting alerts are filtered for this panel. This option will only work, if a `dashboard` or
+                  `grafana_default_dashboard` is set.
+                call: panel="<panel_id>"
+            standard_options:
+              column_divider:
+              dashboard: >-
+                If this option, or the global option `grafana_default_dashboard` is set, the resulting alerts will be limited to this
+                dashboard. To show all alerts in this case, specify `dashboard=""` as option.
+              filter_columns:
+              format:
+              from:
+              instance:
+              replace_values:
+              row_divider:
+              table_formatter:
+              timeout:
+              to:
+              transpose:
+              from_timezone:
+              to_timezone:
+          grafana_panel_property:
+            description: >-
+              Returns a property field for the specified panel. `<type>` can either be `title` or `description`.
+              Grafana variables will be replaced in the returned value.
+            call: 'grafana_panel_property:<panel_id>["<type>",options]'
+            see: https://grafana.com/docs/grafana/latest/variables/syntax/
+            standard_options:
+              dashboard:
+              instance:
+          grafana_panel_image:
+            description: Includes a panel image as an image in the document. Can be called for inline-images as well as for blocks.
+            call: 'grafana_panel_image:<panel_id>[options] or grafana_panel_image::<panel_id>[options]'
+            options:
+              render-height:
+                description: can be used to override default `height` in which the panel shall be rendered
+                call: render-height="<height>"
+              render-width:
+                description: can be used to override default `width` in which the panel shall be rendered
+                call: render-width="<width>"
+              render-theme:
+                description: can be used to override default `theme` in which the panel shall be rendered (light by default)
+                call: render-theme="<theme>"
+              render-timeout:
+                description: can be used to override default `timeout` in which the panel shall be rendered (60 seconds by default)
+                call: render-timeout="<timeout>"
+            standard_options:
+              dashboard:
+              from:
+              instance:
+              timeout:
+              to:
+              from_timezone:
+              to_timezone:
+          grafana_panel_query_table:
+            description: >-
+              Returns the results of a query, which is configured in a grafana panel, as a table in asciidoctor.
+              Grafana variables will be replaced in the panel's SQL statement.
+            call: 'include::grafana_panel_query_table:<panel_id>[query="<query_letter>",options]'
+            see: https://grafana.com/docs/grafana/latest/variables/syntax/
+            options:
+              query:
+                call: query="<query_letter>"
+                description: +<query_letter>+ needs to point to the grafana query which shall be evaluated, e.g. +A+ or +B+.
+            standard_options:
+              column_divider:
+              dashboard:
+              filter_columns:
+              format:
+              from:
+              instance:
+              replace_values:
+              row_divider:
+              table_formatter:
+              timeout:
+              to:
+              transpose:
+              from_timezone:
+              to_timezone:
+          grafana_panel_query_value:
+            call: 'grafana_panel_query_value:<panel_id>[query="<query_letter>",options]'
+            description: >-
+              Returns the value in the first column and the first row of a query, which is configured in a grafana panel.
+              Grafana variables will be replaced in the panel's SQL statement.
+            see: https://grafana.com/docs/grafana/latest/variables/syntax/
+            options:
+              query:
+                call: query="<query_letter>"
+                description: +<query_letter>+ needs to point to the grafana query which shall be evaluated, e.g. +A+ or +B+.
+            standard_options:
+              dashboard:
+              filter_columns:
+              format:
+              from:
+              instance:
+              replace_values:
+              timeout:
+              to:
+              from_timezone:
+              to_timezone:
+          grafana_sql_table:
+            call: 'include::grafana_sql_table:<datasource_id>[sql="<sql_query>",options]'
+            description: >-
+              Returns a table with all results of the given query.
+              Grafana variables will be replaced in the SQL statement.
+            see: https://grafana.com/docs/grafana/latest/variables/syntax/
+            standard_options:
+              column_divider:
+              filter_columns:
+              format:
+              from:
+              instance:
+              replace_values:
+              row_divider:
+              table_formatter:
+              timeout:
+              to:
+              transpose:
+              from_timezone:
+              to_timezone:
+          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.
+            see: https://grafana.com/docs/grafana/latest/variables/syntax/
+            standard_options:
+              filter_columns:
+              format:
+              from:
+              instance:
+              replace_values:
+              timeout:
+              to:
+              from_timezone:
+              to_timezone:
+        YAML_HELP
+      end
+    end
+  end
+end

data/lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb CHANGED Viewed

@@ -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
@@ -46,10 +44,14 @@ module GrafanaReporter
                              " panel: #{target})")
         begin
-          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target), variables: build_attribute_hash(parent.document.attributes, attrs))
+          query = PanelImageQuery.new(@report.grafana(instance).dashboard(dashboard).panel(target),
+                                      variables: build_attribute_hash(parent.document.attributes, attrs))
           image = query.execute
           image_path = @report.save_image_file(image)
+        rescue Grafana::GrafanaError => e
+          @report.logger.error(e.message)
+          return create_paragraph(parent, e.message, attrs)
         rescue GrafanaReporterError => e
           @report.logger.error(e.message)
           return create_paragraph(parent, e.message, attrs)