ruby-grafana-reporter 0.4.1 → 0.4.5

data/lib/grafana_reporter/erb/report_jail.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GrafanaReporter
+  module ERB
+    # An instance of this class is used as binding for the ERB execution, i.e.
+    # this class contains everything known within the ERB template
+    class ReportJail
+      attr_reader :report, :attributes
+
+      def initialize(report, attributes)
+        @report = report
+        @attributes = attributes
+      end
+
+      # @return binding to this object
+      def bind
+        binding
+      end
+    end
+  end
+end

data/lib/grafana_reporter/errors.rb

@@ -10,9 +10,25 @@ module GrafanaReporter
 
   # Raised if a datasource shall be queried, which is not (yet) supported by the reporter
   class DatasourceNotSupportedError < GrafanaReporterError
-    def initialize(ds, query)
-      super("The datasource '#{ds.name}' is of type '#{ds.type}' which is currently not supported for "\
-            "the query type '#{query}'.")
+    def initialize(datasource, query)
+      super("The datasource '#{datasource.name}' is of type '#{datasource.type}' which is currently "\
+            "not supported for the query type '#{query}'.")
+    end
+  end
+
+  # Raised if some unhandled exception is raised during a datasource request execution.
+  class DatasourceRequestInternalError < GrafanaReporterError
+    def initialize(datasource, message)
+      super("The datasource request to '#{datasource.name}' (#{datasource.class}) failed with "\
+            "an internal error: #{message}")
+    end
+  end
+
+  # Raised if the return value of a datasource request does not match the expected return hash.
+  class DatasourceRequestInvalidReturnValueError < GrafanaReporterError
+    def initialize(datasource, message)
+      super("The datasource request to '#{datasource.name}' (#{datasource.class})"\
+            "returned an invalid value: '#{message}'")
     end
   end
 

data/lib/grafana_reporter/panel_image_query.rb

@@ -5,10 +5,7 @@ module GrafanaReporter
   class PanelImageQuery < AbstractQuery
     # Sets the proper render variables.
     def pre_process
-      @from = translate_date(@from, @variables['grafana_report_timestamp'], false, @variables['from_timezone'] ||
-                             @variables['grafana_default_from_timezone'])
-      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
-                           @variables['grafana_default_to_timezone'])
+      # TODO: properly show error, if a (maybe a repeated template) panel can not be rendered
       # TODO: ensure that in case of timezones are specified, that they are also forwarded to the image renderer
       # rename "render-" variables
       @variables = @variables.each_with_object({}) { |(k, v), h| h[k.gsub(/^render-/, '')] = v }
@@ -18,7 +15,7 @@ module GrafanaReporter
     # Returns the body of the http query, which contains the raw image.
     def post_process
       @result = @result[:content].first
-      raise ImageCouldNotBeRenderedError, @panel if @result.include?('<html')
+      raise ::Grafana::ImageCouldNotBeRenderedError, @panel if @result.include?('<html')
     end
 
     # @see AbstractQuery#raw_query

data/lib/grafana_reporter/query_value_query.rb

@@ -3,15 +3,10 @@
 module GrafanaReporter
   # This class provides a general query implementation for any kind of single value and table queries.
   class QueryValueQuery < AbstractQuery
-    # Translates the from and to times.
     # @see Grafana::AbstractQuery#pre_process
     def pre_process
       @datasource = @panel.datasource if @panel
 
-      @from = translate_date(@from, @variables['grafana_report_timestamp'], false, @variables['from_timezone'] ||
-                             @variables['grafana_default_from_timezone'])
-      @to = translate_date(@to, @variables['grafana_report_timestamp'], true, @variables['to_timezone'] ||
-                           @variables['grafana_default_to_timezone'])
       @variables['result_type'] ||= Variable.new('')
     end
 
@@ -25,7 +20,7 @@ module GrafanaReporter
 
       case @variables['result_type'].raw_value
       when /(?:panel_table|sql_table)/
-        result_to_table
+        @result = format_table_output(@result, row_divider: @variables['row_divider'], column_divider: @variables['column_divider'], table_formatter: @variables['table_formatter'], include_headline: @variables['include_headline'])
 
       when /(?:panel_value|sql_value)/
         tmp = @result[:content] || []
@@ -56,19 +51,6 @@ module GrafanaReporter
 
     private
 
-    def result_to_table
-      row_div = '| '
-      row_div = @variables['row_divider'].raw_value if @variables['row_divider'].is_a?(Grafana::Variable)
-      col_div = ' | '
-      col_div = @variables['column_divider'].raw_value if @variables['column_divider'].is_a?(Grafana::Variable)
-
-      @result = @result[:content].map do |row|
-        row_div + row.map do |item|
-          col_div == ' | ' ? item.to_s.gsub('|', '\\|') : item.to_s
-        end.join(col_div)
-      end
-    end
-
     def modify_results
       @result = format_columns(@result, @variables['format'])
       @result = replace_values(@result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })

data/lib/grafana_reporter/report_webhook.rb

@@ -12,14 +12,18 @@ module GrafanaReporter
     # Implements the call of the configured webhook.
     # Provides the following report information in JSON format:
     #
-    # +object_id+ - id of the current report
-    # +path+ - file path to the report
-    # +status+ - report status as string, e.g. +cancelled+, +finished+ or +in progress+
-    # +execution_time+ - execution time of the report
-    # +template+ - name of the used template
-    # +start_time+ - time when the report creation started
-    # +end_time+ - time when the report creation ended
-    # +event+ - event, which has happened
+    #   :object_id      - id of the current report
+    #   :path           - file path to the report
+    #   :status         - report status as string, e.g. `cancelled`, `finished` or `in progress`
+    #   :execution_time - execution time in seconds of the report
+    #   :template       - name of the used template
+    #   :start_time     - time when the report creation started
+    #   :end_time       - time when the report creation ended
+    #   :event          - event, which has happened, e.g. `on-before-create`
+    #
+    # Please note that this callback is a non-blocking event, i.e. the report
+    # generation is proceeding, no matter if the callback is successfull and
+    # no matter how long the execution of the callback does take.
     def callback(event, report)
       # build report information as JSON
       data = { object_id: report.object_id, path: report.path, status: report.status,

data/lib/ruby_grafana_reporter.rb

@@ -18,17 +18,16 @@ require 'asciidoctor-pdf'
 require 'zip'
 require_relative 'VERSION'
 
-# TODO: show error in document, if grafana could not be accessed
-# TODO: show backtrace in extension error rescues
-# TODO: improve ERB calls
-# TODO: add test case for proper image generation
-# TODO: allow to choose report-class during execution, not mandatory by config file
-# TODO: add docu for ERB reports
-# TODO: add docu for custom plugins
-# TODO: add docu for webhook
-
-# TODO: enable as asciidoctor extension
-# TODO: build ADOC template as a result with resolved grafana content for further editing
+# TODO: add test to see if datasource default formats are applied
+# TODO: add test for render-height and render-width, as they are not forwarded
+# TODO: show convert-backend, template language and all variables in webservice overview
+# TODO: add automated test against grafana playground before building a new release
+# TODO: allow registration of files to be defined in config file
+# TODO: PRIO: check in cloud - variables fetched from queries are replaced with SQL query instead of the resolved values, which can lead to issues, e.g. when using that in a function as SUBSTRING
+# TODO: PRIO: allow multiple report classes in configuration file including possibility to decide for the individual class for each rendering call
+# TODO: add configuration example to README
+# TODO: find a way, how to automatically update test grafana responses with _real_ grafana responses
+# TODO: append necessary variables on demo report creation for plain SQL queries, as they are lacking the grafana reference
 
 folders = [
   %w[grafana],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.5
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -121,6 +121,7 @@ files:
 - "./lib/grafana/grafana_property_datasource.rb"
 - "./lib/grafana/graphite_datasource.rb"
 - "./lib/grafana/image_rendering_datasource.rb"
+- "./lib/grafana/influxdb_datasource.rb"
 - "./lib/grafana/panel.rb"
 - "./lib/grafana/prometheus_datasource.rb"
 - "./lib/grafana/sql_datasource.rb"
@@ -129,13 +130,16 @@ files:
 - "./lib/grafana/webrequest.rb"
 - "./lib/grafana_reporter/abstract_query.rb"
 - "./lib/grafana_reporter/abstract_report.rb"
+- "./lib/grafana_reporter/abstract_table_format_strategy.rb"
 - "./lib/grafana_reporter/alerts_table_query.rb"
 - "./lib/grafana_reporter/annotations_table_query.rb"
 - "./lib/grafana_reporter/application/application.rb"
 - "./lib/grafana_reporter/application/errors.rb"
 - "./lib/grafana_reporter/application/webservice.rb"
+- "./lib/grafana_reporter/asciidoctor/adoc_plain_table_format_strategy.rb"
 - "./lib/grafana_reporter/asciidoctor/alerts_table_include_processor.rb"
 - "./lib/grafana_reporter/asciidoctor/annotations_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/help.rb"
 - "./lib/grafana_reporter/asciidoctor/panel_image_block_macro.rb"
 - "./lib/grafana_reporter/asciidoctor/panel_image_inline_macro.rb"
 - "./lib/grafana_reporter/asciidoctor/panel_property_inline_macro.rb"
@@ -150,10 +154,12 @@ files:
 - "./lib/grafana_reporter/asciidoctor/value_as_variable_include_processor.rb"
 - "./lib/grafana_reporter/configuration.rb"
 - "./lib/grafana_reporter/console_configuration_wizard.rb"
+- "./lib/grafana_reporter/csv_table_format_strategy.rb"
 - "./lib/grafana_reporter/demo_report_wizard.rb"
+- "./lib/grafana_reporter/erb/demo_report_builder.rb"
 - "./lib/grafana_reporter/erb/report.rb"
+- "./lib/grafana_reporter/erb/report_jail.rb"
 - "./lib/grafana_reporter/errors.rb"
-- "./lib/grafana_reporter/help.rb"
 - "./lib/grafana_reporter/logger/two_way_delegate_logger.rb"
 - "./lib/grafana_reporter/panel_image_query.rb"
 - "./lib/grafana_reporter/panel_property_query.rb"

data/lib/grafana_reporter/help.rb

@@ -1,443 +0,0 @@
-# frozen_string_literal: true
-
-require 'yaml'
-
-module GrafanaReporter
-  # This class generates the functional help documentation for the reporter.
-  # It can create the documentation for github markdown, as well as in asciidoctor.
-  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('|', '\|')}" }.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 item['standard_options'].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
-
-    # TODO: use same wording/grouping as in README file
-    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 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`,
-              `replace_values`, `filter_columns`, `transpose`.
-            see: 'https://ruby-doc.org/core-2.4.0/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 is applied in the following order `format`,
-              `replace_values`, `filter_columns`, `transpose`.
-            see: https://ruby-doc.org/core-2.7.1/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`.
-
-          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`.
-
-          column_divider:
-            call: column_divider="<divider>"
-            description: >-
-              Replace the default column divider with another one. Defaults to ` | ` for being interpreted as a asciidoctor column.
-
-          row_divider:
-            call: row_divider="<divider>"
-            description: >-
-              Replace the default row divider with another one. Defaults to `| ` for being interpreted as a asciidoctor row.
-
-          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.
-          call: 'include::grafana_environment[]'
-
-        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:
-            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:
-            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/templates-and-variables/#variable-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/templates-and-variables/#variable-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:
-            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/templates-and-variables/#variable-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/templates-and-variables/#variable-syntax
-          standard_options:
-            column_divider:
-            filter_columns:
-            format:
-            from:
-            instance:
-            replace_values:
-            row_divider:
-            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/templates-and-variables/#variable-syntax
-          standard_options:
-            filter_columns:
-            format:
-            from:
-            instance:
-            replace_values:
-            timeout:
-            to:
-            from_timezone:
-            to_timezone:
-      YAML_HELP
-    end
-  end
-end