ruby-grafana-reporter 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06912db0a0635560dca75c00c01c047deac42741c7c6ba2ee717cbccdf26cb19'
-  data.tar.gz: 8d09e509266737bf1b73c3f6ad5c03255de461c116a6e5ec7b45bfaef56520b7
+  metadata.gz: a7dd2bc839c1b488d0c4e13d2837686a9c274845ec4f1a2ef46e95708aa4e96d
+  data.tar.gz: 353185c2bbe335ab78b0b2dca7e4edc561ccdfcc1fa72e12d139b8b93da57698
 SHA512:
-  metadata.gz: 66e81686e253f8e98101f97b0b08db97f955cd1c274f2ed683f597b675c228adf198cd2c66f9ce3df05506a760564643e43b94c40fa952b13748122ecc8d6890
-  data.tar.gz: 916ec07231acf19c20b0f01d7bfe9a47d5825a8e0c3a6c67a9fa615e2b993343d1506fb129cc72b66e2be9b02102c15e338a6e8b5746286494de4164a9678c38
+  metadata.gz: '079bfb28f6365ecd10612076212447015839c1c31bbb976c99c29dbfd4a5af9e9d45d7d542b6e30d019beee4c409c3a86f0ab84aa6ae5db02352b985d04d2841'
+  data.tar.gz: b4d008a5bd31f825a88ec428b3b9e3b117f60156bdfd1609fea3b06d64ff9037a177a7dcdbee5490d79c177e41abb51e7e345b5b82f056448d7509712dcc6d07

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 5, 0].freeze
+GRAFANA_REPORTER_VERSION = [0, 5, 1].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2021-11-05'
+GRAFANA_REPORTER_RELEASE_DATE = '2021-12-18'

data/lib/grafana/influxdb_datasource.rb

@@ -23,9 +23,13 @@ module Grafana
       # replace $timeFilter variable
       query = query.gsub(/\$timeFilter(?=\W|$)/, "time >= #{query_description[:from]}ms and time <= #{query_description[:to]}ms")
 
+      interval = query_description[:variables].delete('interval') || ((query_description[:to].to_i - query_description[:from].to_i) / 1000).to_i
+      interval = interval.raw_value if interval.is_a?(Variable)
+
       # replace grafana variables $__interval and $__interval_ms in query
-      query = query.gsub(/\$(?:__)?interval(?=\W|$)/, "#{((query_description[:to].to_i - query_description[:from].to_i) / 1000 / 1000).to_i}s")
-      query = query.gsub(/\$(?:__)?interval_ms(?=\W|$)/, "#{((query_description[:to].to_i - query_description[:from].to_i) / 1000).to_i}")
+      # TODO: check where calculation and replacement of interval variable should take place
+      query = query.gsub(/\$(?:__)?interval(?=\W|$)/, "#{interval.is_a?(String) ? interval : "#{(interval / 1000).to_i}s"}")
+      query = query.gsub(/\$(?:__)?interval_ms(?=\W|$)/, "#{interval}")
 
       url = "/api/datasources/proxy/#{id}/query?db=#{@model['database']}&q=#{ERB::Util.url_encode(query)}&epoch=ms"
 

data/lib/grafana/prometheus_datasource.rb

@@ -14,13 +14,25 @@ module Grafana
     def request(query_description)
       raise MissingSqlQueryError if query_description[:raw_query].nil?
 
-      # TODO: properly allow endpoint to be set - also check raw_query method
-      end_point = @endpoint ? @endpoint : "query_range"
+      query_hash = query_description[:raw_query].is_a?(Hash) ? query_description[:raw_query] : {}
 
-      # TODO: set query option 'step' on request
-      url = "/api/datasources/proxy/#{id}/api/v1/#{end_point}?"\
-            "start=#{query_description[:from]}&end=#{query_description[:to]}"\
-            "&query=#{replace_variables(query_description[:raw_query], query_description[:variables])}"
+      # read instant value and convert instant value to boolean value
+      instant = query_description[:variables].delete('instant') || query_hash[:instant] || false
+      instant = instant.raw_value if instant.is_a?(Variable)
+      instant = instant.to_s.downcase == 'true'
+      interval = query_description[:variables].delete('interval') || query_hash[:interval] || 15
+      interval = interval.raw_value if interval.is_a?(Variable)
+      query = query_hash[:query] || query_description[:raw_query]
+
+      url = if instant
+        "/api/datasources/proxy/#{id}/api/v1/query?time=#{query_description[:to]}&query="\
+        "#{CGI.escape(replace_variables(query, query_description[:variables]))}"
+      else
+        "/api/datasources/proxy/#{id}/api/v1/query_range?start=#{query_description[:from]}"\
+        "&end=#{query_description[:to]}"\
+        "&query=#{CGI.escape(replace_variables(query, query_description[:variables]))}"\
+        "&step=#{interval}"
+      end
 
       webrequest = query_description[:prepared_request]
       webrequest.relative_url = url
@@ -32,8 +44,8 @@ module Grafana
 
     # @see AbstractDatasource#raw_query_from_panel_model
     def raw_query_from_panel_model(panel_query_target)
-      @endpoint = panel_query_target['format'] == 'time_series' && (panel_query_target['instant'] == false || !panel_query_target['instant']) ? 'query_range' : 'query'
-      panel_query_target['expr']
+      { query: panel_query_target['expr'], instant: panel_query_target['instant'],
+        interval: panel_query_target['step'] }
     end
 
     # @see AbstractDatasource#default_variable_format
@@ -45,16 +57,35 @@ module Grafana
 
     # @see AbstractDatasource#preformat_response
     def preformat_response(response_body)
-      json = JSON.parse(response_body)['data']['result']
+      json = JSON.parse(response_body)
+
+      # handle response with error result
+      unless json['error'].nil?
+        return { header: ['error'], content: [[ json['error'] ]] }
+      end
+
+      result_type = json['data']['resultType']
+      json = json['data']['result']
 
       headers = ['time']
       content = {}
 
+      # handle vector queries
+      if result_type == 'vector'
+        return {
+          header: (headers << 'value') + json.first['metric'].keys,
+          content: [ [json.first['value'][0], json.first['value'][1]] + json.first['metric'].values ]
+        }
+      end
+
+      # handle scalar queries
+      if result_type =~ /^(?:scalar|string)$/
+        return { header: headers << result_type, content: [[json[0], json[1]]] }
+      end
+
       # keep sorting, if json has only one target item, otherwise merge results and return
       # as a time sorted array
-      # TODO properly set headlines
       if json.length == 1
-        return { header: headers << json.first['metric'].to_s, content: [[json.first['value'][1], json.first['value'][0]]] } if json.first.has_key?('value') # this happens for the special case of calls to '/query' endpoint
         return { header: headers << json.first['metric']['mode'], content: json.first['values'] }
       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('|', '\|')}#{"\nSee also: #{opt_v[:see]}" if opt_v[:see]}" }.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
@@ -256,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
           # ----------------------------------
@@ -403,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]'
@@ -425,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]'
@@ -446,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:
@@ -463,6 +488,8 @@ end}
               to:
               from_timezone:
               to_timezone:
+              instant:
+              interval:
         YAML_HELP
       end
     end

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/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/configuration.rb

@@ -263,13 +263,13 @@ module GrafanaReporter
       cur_pos
     end
 
-    def validate_schema(schema, subject)
+    def validate_schema(schema, subject, pattern = nil)
       return nil if subject.nil?
 
       schema.each do |key, config|
-        type, min_occurence, next_level = config
+        type, min_occurence, pattern, next_level = config
 
-        validate_schema(next_level, subject[key]) if next_level
+        validate_schema(next_level, subject[key], pattern) if next_level
 
         if key.nil?
           # apply to all on this level
@@ -289,9 +289,13 @@ module GrafanaReporter
         elsif subject.is_a?(Hash)
           if !subject.key?(key) && min_occurence.positive?
             raise ConfigurationDoesNotMatchSchemaError.new(key, 'occur', min_occurence, 0)
-          end
-          if !subject[key].is_a?(type) && subject.key?(key)
+          elsif !subject[key].is_a?(type) && subject.key?(key)
             raise ConfigurationDoesNotMatchSchemaError.new(key, 'be a', type, subject[key].class)
+          elsif pattern
+            # validate for regex
+            unless subject[key].to_s =~ pattern
+              raise ConfigurationDoesNotMatchSchemaError.new(key, 'match pattern', pattern.inspect, subject[key].to_s)
+            end
           end
 
         else
@@ -312,35 +316,35 @@ module GrafanaReporter
       {
         'grafana' =>
          [
-           Hash, 1,
+           Hash, 1, nil,
            {
              nil =>
               [
-                Hash, 1,
+                Hash, 1, nil,
                 {
-                  'host' => [String, 1],
-                  'api_key' => [String, 0]
+                  'host' => [String, 1, %r{^http(s)?://.+}],
+                  'api_key' => [String, 0, %r{^(?:[\w]+[=]*)?$}]
                 }
               ]
            }
          ],
-        'default-document-attributes' => [Hash, explicit ? 1 : 0],
-        'to_file' => [String, 0],
+        'default-document-attributes' => [Hash, explicit ? 1 : 0, nil],
+        'to_file' => [String, 0, nil],
         'grafana-reporter' =>
         [
-          Hash, 1,
+          Hash, 1, nil,
           {
-            'check-for-updates' => [Integer, 0],
-            'debug-level' => [String, 0],
-            'run-mode' => [String, 0],
-            'test-instance' => [String, 0],
-            'templates-folder' => [String, explicit ? 1 : 0],
-            'report-class' => [String, 1],
-            'reports-folder' => [String, explicit ? 1 : 0],
-            'report-retention' => [Integer, explicit ? 1 : 0],
-            'ssl-cert' => [String, 0],
-            'webservice-port' => [Integer, explicit ? 1 : 0],
-            'callbacks' => [Hash, 0, { nil => [String, 1] }]
+            'check-for-updates' => [Integer, 0, /^[0-9]*$/],
+            'debug-level' => [String, 0, /^(?:DEBUG|INFO|WARN|ERROR|FATAL|UNKNOWN)?$/],
+            'run-mode' => [String, 0, /^(?:test|single-render|webservice)?$/],
+            'test-instance' => [String, 0, nil],
+            'templates-folder' => [String, explicit ? 1 : 0, nil],
+            'report-class' => [String, 1, nil],
+            'reports-folder' => [String, explicit ? 1 : 0, nil],
+            'report-retention' => [Integer, explicit ? 1 : 0, nil],
+            'ssl-cert' => [String, 0, nil],
+            'webservice-port' => [Integer, explicit ? 1 : 0, nil],
+            'callbacks' => [Hash, 0, nil, { nil => [String, 1, nil] }]
           }
         ]
       }

data/lib/grafana_reporter/errors.rb

@@ -27,7 +27,7 @@ module GrafanaReporter
   # 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})"\
+      super("The datasource request to '#{datasource.name}' (#{datasource.class}) "\
             "returned an invalid value: '#{message}'")
     end
   end
@@ -65,7 +65,7 @@ module GrafanaReporter
   # Details about how to fix that are provided in the message.
   class ConfigurationDoesNotMatchSchemaError < ConfigurationError
     def initialize(item, verb, expected, currently)
-      super("Configuration file does not match schema definition. Expected '#{item}' to #{verb} '#{expected}',"\
+      super("Configuration file does not match schema definition. Expected '#{item}' to #{verb} '#{expected}', "\
             "but was '#{currently}'.")
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -100,9 +100,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: Build reports based on grafana dashboards in asciidoctor syntax. Runs
-  as webservice for easy integration with grafana, or as a standalone, command line
-  utility.
+description: Build reports based on grafana dashboards in asciidoctor or ERB syntax.
+  Runs as webservice for easy integration with grafana, or as a standalone, command
+  line utility.
 email: kohly@gmx.de
 executables:
 - ruby-grafana-reporter
@@ -193,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Reporter Service for Grafana