ruby-grafana-reporter 0.3.0 → 0.4.4

data/lib/{ruby-grafana-reporter.rb → ruby_grafana_reporter.rb}

@@ -18,15 +18,13 @@ require 'asciidoctor-pdf'
 require 'zip'
 require_relative 'VERSION'
 
-# TODO: automatically build a template based on configured grafana dashboard
-# TODO: add an sample report to github from grafana play (if permitted)
-
 folders = [
   %w[grafana],
   %w[grafana_reporter logger],
   %w[grafana_reporter],
   %w[grafana_reporter asciidoctor extensions],
   %w[grafana_reporter asciidoctor],
+  %w[grafana_reporter erb],
   %w[grafana_reporter application]
 ]
 folders.each { |folder| Dir[File.join(__dir__, *folder, '*.rb')].sort.each { |file| require_relative file } }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-grafana-reporter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.4
 platform: ruby
 authors:
 - Christian Kohlmeyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -100,10 +100,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: Provides a standalone and a webservice frontend for creating reports
-  based on asciidoctor, including interfaces to integrate dynamic content captured
-  from grafana.By default the reports will be converted to PDF documents, whereas
-  other target formats can be used as well.
+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.
 email: kohly@gmx.de
 executables:
 - ruby-grafana-reporter
@@ -113,49 +112,61 @@ extra_rdoc_files:
 - LICENSE
 files:
 - "./lib/VERSION.rb"
-- "./lib/grafana/abstract_panel_query.rb"
-- "./lib/grafana/abstract_query.rb"
-- "./lib/grafana/abstract_sql_query.rb"
+- "./lib/grafana/abstract_datasource.rb"
 - "./lib/grafana/dashboard.rb"
 - "./lib/grafana/errors.rb"
 - "./lib/grafana/grafana.rb"
+- "./lib/grafana/grafana_alerts_datasource.rb"
+- "./lib/grafana/grafana_annotations_datasource.rb"
+- "./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/panel_image_query.rb"
+- "./lib/grafana/prometheus_datasource.rb"
+- "./lib/grafana/sql_datasource.rb"
+- "./lib/grafana/unsupported_datasource.rb"
 - "./lib/grafana/variable.rb"
+- "./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/alerts_table_query.rb"
-- "./lib/grafana_reporter/asciidoctor/annotations_table_query.rb"
-- "./lib/grafana_reporter/asciidoctor/errors.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/alerts_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/annotations_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_image_block_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_image_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_property_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_query_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/panel_query_value_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/processor_mixin.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/show_environment_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/show_help_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/sql_table_include_processor.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/sql_value_inline_macro.rb"
-- "./lib/grafana_reporter/asciidoctor/extensions/value_as_variable_include_processor.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_first_value_query.rb"
-- "./lib/grafana_reporter/asciidoctor/panel_image_query.rb"
-- "./lib/grafana_reporter/asciidoctor/panel_property_query.rb"
-- "./lib/grafana_reporter/asciidoctor/panel_table_query.rb"
-- "./lib/grafana_reporter/asciidoctor/query_mixin.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"
+- "./lib/grafana_reporter/asciidoctor/panel_query_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/panel_query_value_inline_macro.rb"
+- "./lib/grafana_reporter/asciidoctor/processor_mixin.rb"
 - "./lib/grafana_reporter/asciidoctor/report.rb"
-- "./lib/grafana_reporter/asciidoctor/sql_first_value_query.rb"
-- "./lib/grafana_reporter/asciidoctor/sql_table_query.rb"
+- "./lib/grafana_reporter/asciidoctor/show_environment_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/show_help_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/sql_table_include_processor.rb"
+- "./lib/grafana_reporter/asciidoctor/sql_value_inline_macro.rb"
+- "./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/logger/two_way_logger.rb"
-- "./lib/ruby-grafana-reporter.rb"
+- "./lib/grafana_reporter/logger/two_way_delegate_logger.rb"
+- "./lib/grafana_reporter/panel_image_query.rb"
+- "./lib/grafana_reporter/panel_property_query.rb"
+- "./lib/grafana_reporter/query_value_query.rb"
+- "./lib/grafana_reporter/report_webhook.rb"
+- "./lib/ruby_grafana_extension.rb"
+- "./lib/ruby_grafana_reporter.rb"
 - LICENSE
 - README.md
 - bin/ruby-grafana-reporter
@@ -173,7 +184,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.3
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/grafana/abstract_panel_query.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'abstract_query'
-
-module Grafana
-  # @abstract
-  #
-  # Used as a superclass for all queries, which rely on a {Panel} object.
-  #
-  # @see AbstractQuery
-  class AbstractPanelQuery < AbstractQuery
-    attr_reader :panel
-
-    # Initializes the variables of the query using {AbstractQuery#extract_dashboard_variables}.
-    # @param panel [Panel] panel for which the query shall be executed
-    def initialize(panel)
-      super()
-      @panel = panel
-      extract_dashboard_variables(@panel.dashboard)
-    end
-  end
-end

data/lib/grafana/abstract_query.rb

@@ -1,132 +0,0 @@
-# frozen_string_literal: true
-
-module Grafana
-  # @abstract Override {#url}, #{#request}, {#pre_process} and {#post_process} in subclass.
-  #
-  # Superclass containing everything for all queries towards grafana.
-  class AbstractQuery
-    attr_accessor :from, :to, :timeout, :result
-    attr_reader :variables
-
-    def initialize
-      @variables = {}
-    end
-
-    # Runs the whole process to receive values properly from this query:
-    # - calls {#pre_process}
-    # - executes this query against the given {Grafana} instance
-    # - calls {#post_process}
-    # - returns the result
-    #
-    # @param grafana [Grafana] {Grafana} object, against which the query is executed
-    # @return [Object] result of the query
-    def execute(grafana)
-      return @result unless @result.nil?
-
-      pre_process(grafana)
-      @result = grafana.execute_http_request(url, request, timeout)
-      post_process
-      @result
-    end
-
-    # Used to retrieve default configurations from the given {Dashboard} and store them as settings in the query.
-    #
-    # Following data is extracted:
-    # - +from+, by {Dashboard#from_time}
-    # - +to+, by {Dashboard#to_time}
-    # - and all variables as {Variable}, prefixed with +var-+, as grafana also does it
-    def extract_dashboard_variables(dashboard)
-      @from = dashboard.from_time
-      @to = dashboard.to_time
-      dashboard.variables.each { |item| merge_variables({ "var-#{item.name}": item }) }
-      self
-    end
-
-    # Merges the given Hash with the stored variables.
-    #
-    # Can be used to easily set many values at once in the local variables hash.
-    #
-    # Please note, that the values of the Hash need to be of type {Variable}.
-    #
-    # @param hash [Hash<String,Variable>] Hash containing variable name as key and {Variable} as value
-    # @return [AbstractQuery] this object
-    def merge_variables(hash)
-      hash.each do |k, v|
-        if @variables[k.to_s].nil?
-          @variables[k.to_s] = v
-        else
-          @variables[k.to_s].raw_value = v.raw_value
-        end
-      end
-      self
-    end
-
-    # @return [Hash<String, Variable>] all grafana variables stored in this query, i.e. the variable name
-    #  is prefixed with +var-+
-    def grafana_variables
-      @variables.select { |k, _v| k =~ /^var-.+/ }
-    end
-
-    # Replaces the grafana variables in the given string with their replacement value.
-    #
-    # @param string [String] string in which the variables shall be replaced
-    # @param variables [Hash<String,Variable>] Hash containing the variables, which shall be replaced in the
-    #  given string
-    # @return [String] string in which all variables are properly replaced
-    def replace_variables(string, variables = {})
-      res = string
-      repeat = true
-      repeat_count = 0
-
-      # TODO: find a proper way to replace variables recursively instead of over and over again
-      # TODO: add tests for recursive replacement of variable
-      while repeat && (repeat_count < 3)
-        repeat = false
-        repeat_count += 1
-        variables.each do |var_name, obj|
-          # only set ticks if value is string
-          variable = var_name.gsub(/^var-/, '')
-          res = res.gsub(/(?:\$\{#{variable}(?::(?<format>\w+))?\}|(?<!\.)\$#{variable}(?!\.))/) do
-            obj.value_formatted($LAST_MATCH_INFO ? $LAST_MATCH_INFO[:format] : nil)
-          end
-        end
-        repeat = true if res.include?('$')
-      end
-
-      res
-    end
-
-    # @abstract
-    #
-    # @return [String] String containing the relative URL to execute the query
-    def uri
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # @return [Hash] Hash containing the request parameters, which shall be overwritten or extended in
-    #  {Grafana#execute_http_request}
-    def request
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # Use this function to perform all necessary actions, before the query is actually executed.
-    # Here you can e.g. set values of variables or similar.
-    #
-    # @param grafana [Grafana] {Grafana} object, against which the query shall be executed
-    def pre_process(grafana)
-      raise NotImplementedError
-    end
-
-    # @abstract
-    #
-    # Use this function to format the raw result of the @result variable to conform to the expected return value.
-    # You might also want to {#replace_variables} in the @result or similar.
-    def post_process
-      raise NotImplementedError
-    end
-  end
-end

data/lib/grafana/abstract_sql_query.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module Grafana
-  # @abstract
-  #
-  # Used as a superclass for all queries, which execute SQL queries against {Grafana}.
-  #
-  # @see AbstractQuery
-  class AbstractSqlQuery < AbstractQuery
-    attr_reader :sql, :datasource_id
-
-    # @param raw_sql [String] raw sql statement, as it can be sent to a SQL database
-    # @param datasource_id [Integer] ID of the datasource against which the query is run
-    def initialize(raw_sql, datasource_id)
-      super()
-      @sql = raw_sql
-      @datasource_id = datasource_id
-    end
-
-    # @return [String] relative URL, where the request has to be sent to.
-    def url
-      '/api/tsdb/query'
-    end
-
-    # @return [Hash] request, which executes the SQL statement against the specified datasource
-    def request
-      {
-        body: {
-          from: @from,
-          to: @to,
-          queries: [rawSql: @sql, datasourceId: @datasource_id.to_i, format: 'table']
-        }.to_json,
-        request: Net::HTTP::Post
-      }
-    end
-
-    # Replaces all variables in the SQL statement.
-    def pre_process(grafana)
-      raise MissingSqlQueryError if @sql.nil?
-      unless grafana.datasource_id_exists?(@datasource_id.to_i)
-        raise DatasourceDoesNotExistError.new('id', @datasource_id)
-      end
-
-      @sql = replace_variables(@sql, grafana_variables)
-      # remove comments in query
-      @sql.gsub!(/--[^\r\n]*(?:[\r\n]+|$)/, ' ')
-      @sql.gsub!(/\r\n/, ' ')
-      @sql.gsub!(/\n/, ' ')
-    end
-  end
-end

data/lib/grafana/panel_image_query.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Grafana
-  # Query, which allows to render a {Panel} as a PNG image.
-  class PanelImageQuery < AbstractPanelQuery
-    # Returns the URL for rendering the panel. Uses {Panel#render_url} and sets additional url
-    # parameters according {https://grafana.com/docs/grafana/latest/reference/share_panel Grafana Share Panel}.
-    #
-    # @see AbstractQuery#url
-    # @return [String] string for rendering the panel
-    def url
-      @panel.render_url + url_parameters
-    end
-
-    # Changes the result of the request to be of type +image/png+.
-    #
-    # @see AbstractQuery#request
-    def request
-      { accept: 'image/png' }
-    end
-
-    # Adds default variables for querying the image.
-    #
-    # @see AbstractQuery#pre_process
-    def pre_process(_grafana)
-      @variables['fullscreen'] = Variable.new(true)
-      @variables['theme'] = Variable.new('light')
-      @variables['timeout'] = Variable.new(timeout) if timeout
-      @variables['timeout'] ||= Variable.new(60)
-    end
-
-    # Checks if the rendering has been performed properly.
-    # If so, the resulting image is stored in the @result variable, otherwise an error is raised.
-    #
-    # @see AbstractQuery#post_process
-    def post_process
-      raise ImageCouldNotBeRenderedError, @panel if @result.body.include?('<html')
-    end
-
-    private
-
-    def url_parameters
-      url_vars = variables.select { |k, _v| k =~ /^(?:timeout|height|width|theme|fullscreen)/ || k =~ /^var-.+/ }
-      url_vars['from'] = Variable.new(@from) if @from
-      url_vars['to'] = Variable.new(@to) if @to
-      url_params = URI.encode_www_form(url_vars.map { |k, v| [k, v.raw_value.to_s] })
-      return '' if url_params.empty?
-
-      "&#{url_params}"
-    end
-  end
-end

data/lib/grafana_reporter/asciidoctor/alerts_table_query.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'query_mixin'
-
-module GrafanaReporter
-  module Asciidoctor
-    # This class is used to query alerts from grafana.
-    class AlertsTableQuery < Grafana::AbstractQuery
-      include QueryMixin
-
-      # @option opts [Grafana::Dashboard] :dashboard  dashboard, if alerts shall be filtered for a dashboard
-      # @option opts [Grafnaa::Oanel] :panel panel, if alerts shall be filtered for a panel
-      def initialize(opts = {})
-        super()
-
-        @dashboard = opts[:dashboard]
-        @panel = opts[:panel]
-        @dashboard = @panel.dashboard if @panel
-
-        extract_dashboard_variables(@dashboard) if @dashboard
-      end
-
-      # @return [String] URL for querying alerts
-      def url
-        "/api/alerts#{url_parameters}"
-      end
-
-      # @return [Hash] empty hash object
-      def request
-        {}
-      end
-
-      # Check if mandatory {Grafana::Variable} +columns+ is specified in variables.
-      #
-      # The value of the +columns+ variable has to be a comma separated list of column titles, which
-      # need to be included in the following list:
-      # - limit
-      # - dashboardId
-      # - panelId
-      # - query
-      # - state
-      # - folderId
-      # - dashboardQuery
-      # - dashboardTag
-      # @return [void]
-      def pre_process(_grafana)
-        raise MissingMandatoryAttributeError, 'columns' unless @variables['columns']
-
-        @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'])
-      end
-
-      # Filter the query result for the given columns and sets the result in the preformatted SQL
-      # result stlye.
-
-      # Additionally it applies {QueryMixin#format_columns}, {QueryMixin#replace_values} and
-      # {QueryMixin#filter_columns}.
-      # @return [void]
-      def post_process
-        # extract data from returned json
-        result = JSON.parse(@result.body)
-        content = []
-        begin
-          result.each { |item| content << item.fetch_values(*@variables['columns'].raw_value.split(',')) }
-        rescue KeyError => e
-          raise MalformedAttributeContentError.new(e.message, 'columns', @variables['columns'])
-        end
-
-        result = {}
-        result[:header] = [@variables['columns'].raw_value.split(',')]
-        result[:content] = content
-
-        result = format_columns(result, @variables['format'])
-        result = replace_values(result, @variables.select { |k, _v| k =~ /^replace_values_\d+/ })
-        result = filter_columns(result, @variables['filter_columns'])
-
-        @result = result[:content].map { |row| "| #{row.map { |item| item.to_s.gsub('|', '\\|') }.join(' | ')}" }
-      end
-
-      private
-
-      def url_parameters
-        url_vars = {}
-        url_vars['dashboardId'] = ::Grafana::Variable.new(@dashboard.id) if @dashboard
-        url_vars['panelId'] = ::Grafana::Variable.new(@panel.id) if @panel
-
-        url_vars.merge!(variables.select do |k, _v|
-          k =~ /^(?:limit|dashboardId|panelId|query|state|folderId|dashboardQuery|dashboardTag)/x
-        end)
-        url_vars['from'] = ::Grafana::Variable.new(@from) if @from
-        url_vars['to'] = ::Grafana::Variable.new(@to) if @to
-        url_params = URI.encode_www_form(url_vars.map { |k, v| [k, v.raw_value.to_s] })
-        return '' if url_params.empty?
-
-        "?#{url_params}"
-      end
-    end
-  end
-end