ruby-grafana-reporter 0.6.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5e48d471e3c09009d65b08924a8d8ff1f4a2259fde86a2525f56554ee96f23a
-  data.tar.gz: 0e095029e10bd6bef2ae80ad866b243c13d3c1ebd5555c9b75d651d6da5ce15c
+  metadata.gz: 49639b5da410d46b0ad6cf16a187a3f30389fac610497de09d1e1466a66f22f5
+  data.tar.gz: 673791b6d38cd46e54292903f07e0fdd16070f5e0abf999565fecf04b930efbb
 SHA512:
-  metadata.gz: f6bc6604e3fed7fba3fe3057d42432098363f056c03afdf6c8f961d80abc0b0ad4505a01f895d44421774b5bb1a9227bb9bdef747cea7fe15669ebdf149b7611
-  data.tar.gz: fa8ec80a80e51d214c50d54e9d1dbf6d196c11e5320f749ac2f3d2c9b5ed5979ae3a71924ce5d47d43489e4e18c381b5d8d05ad47a3805122a5ba93d9947950f
+  metadata.gz: d4bb03253d7681c580c96f11e5e86112e036087b927ff01e0e490bebeb4aeadd5f213f9de7202007523b8bf384ed36f6fcc040d5b81aa5aceef88c7cb191ab50
+  data.tar.gz: d3695d4d6ce451c01e7ad33a28a942f697d019215cca603827bda44af488e292c4befaf658d266e19b5ca3e84ab1a06cbc5f4f5e189d262b5c8bb415c4ae1013

data/README.md

@@ -26,12 +26,10 @@ Reporting Service for Grafana
 
 ## Your support is appreciated!
 
-Hey there! Let me spend some personal words here:
-
-I provide you this software free of charge - and I'm happy, that I can do so. I have already
+Hey there! I provide you this software free of charge. I have already
 spend a lot of my private time in developing, maintaining and supporting it.
 
-If you enjoy my work, I would feel greatly honoured, if you buy me a coffee:
+If you enjoy my work, feel free to
 
 [![buymeacoffee](https://az743702.vo.msecnd.net/cdn/kofi3.png?v=0)](https://ko-fi.com/divinity666)
 
@@ -50,6 +48,10 @@ dashboards and to use it in your custom templates to finally create reports in P
 
 By default (an extended version of) Asciidoctor is enabled as template language.
 
+## Getting started
+
+![GettingStarted](./assets/GettingStartedAnimation.gif)
+
 ## Features
 
 * Supports creation of reports for multiple [grafana](https://github.com/grafana/grafana)

data/lib/VERSION.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Version information
-GRAFANA_REPORTER_VERSION = [0, 6, 6].freeze
+GRAFANA_REPORTER_VERSION = [0, 7, 0].freeze
 # Release date
-GRAFANA_REPORTER_RELEASE_DATE = '2024-02-22'
+GRAFANA_REPORTER_RELEASE_DATE = '2024-05-19'

data/lib/grafana/grafana.rb

@@ -68,6 +68,23 @@ module Grafana
       'NON-Admin'
     end
 
+    # Returns the datasource, which has been queried by model entry in the panel model.
+    #
+    # @param model_entry [Object] model entry of the searched datasource (e.g. String or Hash)
+    # @return [Datasource] Datasource for the specified datasource model entry
+    def datasource_by_model_entry(model_entry)
+      datasource = nil
+      if model_entry.is_a?(String)
+        datasource = datasource_by_name(model_entry)
+      elsif model_entry.is_a?(Hash)
+        datasource = datasource_by_uid(model_entry['uid'])
+      end
+
+      raise DatasourceDoesNotExistError.new('model entry', model_entry) unless datasource
+
+      datasource
+    end
+
     # Returns the datasource, which has been queried by the datasource name.
     #
     # @param datasource_name [String] name of the searched datasource
@@ -86,6 +103,8 @@ module Grafana
     # @param datasource_uid [String] unique id of the searched datasource
     # @return [Datasource] Datasource for the specified datasource unique id
     def datasource_by_uid(datasource_uid)
+      raise DatasourceDoesNotExistError.new('uid', datasource_uid) unless datasource_uid
+
       clean_nil_datasources
       datasource = @datasources.select { |ds_name, ds| ds.uid == datasource_uid }.values.first
       raise DatasourceDoesNotExistError.new('uid', datasource_uid) unless datasource

data/lib/grafana_reporter/abstract_query.rb

@@ -383,7 +383,7 @@ module GrafanaReporter
         delta_match = date_spec.match(/^(?<op>(?:-|\+))(?<count>\d+)?(?<unit>[smhdwMy])/)
         if delta_match
           date = delta_date(date, "#{delta_match[:op]}#{delta_match[:count] || 1}".to_i, delta_match[:unit])
-          date_spec = date_spec.gsub(/^#{delta_match[:op]}#{delta_match[:count]}#{delta_match[:unit]}/, '')
+          date_spec = date_spec.gsub(/^#{delta_match[:op] == '+' ? '\+' : '-'}#{delta_match[:count]}#{delta_match[:unit]}/, '')
         end
 
         raise TimeRangeUnknownError, orig_date unless fit_match || delta_match

data/lib/grafana_reporter/asciidoctor/help.rb

@@ -229,6 +229,12 @@ end}
                 escaped by using `_,`. Execution of related functions is applied in the following order
                 `format`, `replace_values`, `filter_columns`, `transpose`.
 
+            select_value:
+              call: select_value="<select_value>"
+              description: >-
+                Allows the selection of a specific value from the result set.  Supported options are `min`, `max`, `avg`,
+                `sum`, `first`, `last`.
+
             transpose:
               call: transpose="true"
               description: >-
@@ -456,6 +462,7 @@ end}
               from:
               instance:
               replace_values:
+              select_value:
               timeout:
               to:
               from_timezone:
@@ -505,6 +512,7 @@ end}
               from:
               instance:
               replace_values:
+              select_value:
               timeout:
               to:
               from_timezone:

data/lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb

@@ -80,7 +80,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'].include?('table')
 
         ref_id = nil
         panel.model['targets'].each do |item|

data/lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb

@@ -74,7 +74,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'] == 'singlestat'
 
         ref_id = nil
         panel.model['targets'].each do |item|

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|instant|interval|verbose_log/x
+               column_divider|row_divider|instant|interval|verbose_log|select_value/x
         end)
 
         result

data/lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb

@@ -74,7 +74,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'].include?('table')
 
         ref_id = nil
         panel.model['targets'].each do |item|
@@ -85,8 +84,8 @@ module GrafanaReporter
         end
         return nil unless ref_id
 
-        "|===\ninclude::grafana_sql_table:#{panel.dashboard.grafana.datasource_by_name(panel.model['datasource']).id}"\
-        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",filter_columns=\"time\","\
+        "|===\ninclude::grafana_sql_table:#{panel.dashboard.grafana.datasource_by_model_entry(panel.model['datasource']).id}"\
+        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\r\n", ' ').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",filter_columns=\"time\","\
         "dashboard=\"#{panel.dashboard.id}\",from=\"now-1h\",to=\"now\"]\n|==="
       end
     end

data/lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb

@@ -79,7 +79,6 @@ module GrafanaReporter
       # @see ProcessorMixin#build_demo_entry
       def build_demo_entry(panel)
         return nil unless panel
-        return nil unless panel.model['type'] == 'singlestat'
 
         ref_id = nil
         panel.model['targets'].each do |item|
@@ -90,8 +89,8 @@ module GrafanaReporter
         end
         return nil unless ref_id
 
-        "grafana_sql_value:#{panel.dashboard.grafana.datasource_by_name(panel.model['datasource']).id}"\
-        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",from=\"now-1h\","\
+        "grafana_sql_value:#{panel.dashboard.grafana.datasource_by_model_entry(panel.model['datasource']).id}"\
+        "[sql=\"#{panel.query(ref_id).gsub(/"/, '\"').gsub("\r\n", ' ').gsub("\n", ' ').gsub(/\\/, '\\\\')}\",from=\"now-1h\","\
         'to="now"]'
       end
     end

data/lib/grafana_reporter/errors.rb

@@ -79,6 +79,15 @@ module GrafanaReporter
     end
   end
 
+  # Thrown, if the value configuration in {QueryValueQuery#select_value} is
+  # invalid.
+  class UnsupportedSelectValueStatementError < GrafanaReporterError
+    def initialize(statement)
+      super("Unsupported 'select_value' specified in template file: '#{statement}'. Supported values are 'min', 'max', "\
+            "'avg', 'sum', 'first', 'last'.")
+    end
+  end
+
   # Thrown, if a configured parameter is malformed.
   class MalformedAttributeContentError < GrafanaReporterError
     def initialize(message, attribute, content)

data/lib/grafana_reporter/query_value_query.rb

@@ -33,7 +33,30 @@ module GrafanaReporter
 
       when /(?:panel_value|sql_value)/
         tmp = @result[:content] || []
-        @result = tmp.flatten.first
+        # use only first column of return values and replace null values with zero
+        tmp = tmp.map{ |item| item[0] || 0 }
+
+        # as default behaviour we fallback to the first_value, as this was the default in older releases
+        select_value = 'first'
+        select_value = @variables['select_value'].raw_value if @variables['select_value']
+        case select_value
+        when 'min'
+          result = tmp.min
+        when 'max'
+          result = tmp.max
+        when 'avg'
+          result = tmp.size > 0 ? tmp.sum / tmp.size : 0
+        when 'sum'
+          result = tmp.sum
+        when 'last'
+          result = tmp.last
+        when 'first'
+          result = tmp.first
+        else
+          raise UnsupportedSelectValueStatementError, @variables['select_value'].raw_value
+        end
+
+        @result = result
 
       else
         raise StandardError, "Unsupported 'result_type' received: '#{@variables['result_type'].raw_value}'"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.7.0
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Reporter Service for Grafana