ruby-grafana-reporter 0.1.7 → 0.4.0

data/lib/grafana/dashboard.rb

@@ -1,66 +1,75 @@
-module Grafana
-  # Representation of one specific dashboard in a {Grafana} instance.
-  class Dashboard
-    # @return [Grafana] parent {Grafana} object
-    attr_reader :grafana
-    attr_reader :panels, :variables
-
-    # @param model [Hash] converted JSON Hash of the grafana dashboard
-    # @param grafana [Grafana] parent {Grafana} object
-    def initialize(model, grafana)
-      @grafana = grafana
-      @model = model
-
-      # read panels
-      @panels = []
-      if @model.key?('panels')
-        @model['panels'].each do |panel|
-          if panel.key?('panels')
-            panel['panels'].each do |subpanel|
-              @panels << Panel.new(subpanel, self)
-            end
-          else
-            @panels << Panel.new(panel, self)
-          end
-        end
-      end
-
-      # store variables in array as objects of type Variable
-      @variables = []
-      return unless @model.key?('templating')
-
-      list = @model['templating']['list']
-      return unless list.is_a? Array
-
-      list.each do |item|
-        @variables << Variable.new(item)
-      end
-    end
-
-    # @return [String] +from+ time configured in the dashboard.
-    def from_time
-      return @model['time']['from'] if @model['time']
-
-      nil
-    end
-
-    # @return [String] +to+ time configured in the dashboard.
-    def to_time
-      @model['time']['to'] if @model['time']
-      nil
-    end
-
-    # @return [String] dashboard UID
-    def id
-      @model['uid']
-    end
-
-    # @return [Panel] panel for the specified ID
-    def panel(id)
-      panels = @panels.select { |item| item.field('id') == id.to_i }
-      raise PanelDoesNotExistError.new(id, self) if panels.empty?
-
-      panels.first
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Grafana
+  # Representation of one specific dashboard in a {Grafana} instance.
+  class Dashboard
+    # @return [Grafana] parent {Grafana} object
+    attr_reader :grafana
+    attr_reader :panels, :variables
+
+    # @param model [Hash] converted JSON Hash of the grafana dashboard
+    # @param grafana [Grafana] parent {Grafana} object
+    def initialize(model, grafana)
+      @grafana = grafana
+      @model = model
+
+      init_panels
+      init_variables
+    end
+
+    # @return [String] +from+ time configured in the dashboard.
+    def from_time
+      return @model['time']['from'] if @model['time']
+
+      nil
+    end
+
+    # @return [String] +to+ time configured in the dashboard.
+    def to_time
+      @model['time']['to'] if @model['time']
+      nil
+    end
+
+    # @return [String] dashboard UID
+    def id
+      @model['uid']
+    end
+
+    # @return [Panel] panel for the specified ID
+    def panel(id)
+      panels = @panels.select { |item| item.field('id') == id.to_i }
+      raise PanelDoesNotExistError.new(id, self) if panels.empty?
+
+      panels.first
+    end
+
+    private
+
+    # store variables in array as objects of type Variable
+    def init_variables
+      @variables = []
+      return unless @model.key?('templating')
+
+      list = @model['templating']['list']
+      return unless list.is_a? Array
+
+      list.each { |item| @variables << Variable.new(item) }
+    end
+
+    # read panels
+    def init_panels
+      @panels = []
+      return unless @model.key?('panels')
+
+      @model['panels'].each do |panel|
+        if panel.key?('panels')
+          panel['panels'].each do |subpanel|
+            @panels << Panel.new(subpanel, self)
+          end
+        else
+          @panels << Panel.new(panel, self)
+        end
+      end
+    end
+  end
+end

data/lib/grafana/errors.rb

@@ -1,61 +1,81 @@
-module Grafana
-  # A top level alarm for all other errors in current module.
-  class GrafanaError < StandardError
-    def initialize(message)
-      super("GrafanaError: #{message} (#{self.class})")
-    end
-  end
-
-  # Raised if a given dashboard does not exist in a specific {Grafana} instance.
-  class DashboardDoesNotExistError < GrafanaError
-    # @param dashboard_uid [String] dashboard uid, which could not be found
-    def initialize(dashboard_uid)
-      super("The specified dashboard '#{dashboard_uid}' does not exist.")
-    end
-  end
-
-  # Raised if a given panel does not exist on a specific {Dashboard} in the current {Grafana} instance.
-  class PanelDoesNotExistError < GrafanaError
-    # @param panel_id [String] panel id, which could not be found on the dashboard
-    # @param dashboard [Dashboard] dashboard object on which the panel could not be found
-    def initialize(panel_id, dashboard)
-      super("The specified panel id '#{panel_id}' does not exist on the dashboard '#{dashboard.id}'.")
-    end
-  end
-
-  # Raised if a given query letter does not exist on a specific {Panel}.
-  class QueryLetterDoesNotExistError < GrafanaError
-    # @param query_letter [String] query letter name, which could not be found on the panel
-    # @param panel [Panel] panel object on which the query could not be found
-    def initialize(query_letter, panel)
-      super("The specified query '#{query_letter}' does not exist in the panel '#{panel.id}' in dashboard '#{panel.dashboard}'.")
-    end
-  end
-
-  # Raised if a given datasource does not exist in a specific {Grafana} instance.
-  class DatasourceDoesNotExistError < GrafanaError
-    # @param field [String] specifies, how the datasource has been searched, e.g. 'id' or 'name'
-    # @param datasource_identifier [String] identifier of the datasource, which could not be found, e.g. the specifiy id or name
-    def initialize(field, datasource_identifier)
-      super("Datasource with #{field} '#{datasource_identifier}' does not exist.")
-    end
-  end
-
-  # Raised if a {Panel} could not be rendered as an image.
-  #
-  # Most likely this happens, because the image renderer is not configures properly in grafana,
-  # or the panel rendering ran into a timeout.
-  class ImageCouldNotBeRenderedError < GrafanaError
-    # @param panel [Panel] panel object, which could not be rendered
-    def initialize(panel)
-      super("The specified panel '#{panel.id}' from dashboard '#{panel.dashboard.id} could not be rendered to an image.")
-    end
-  end
-
-  # Raised if no SQL query is specified in a {AbstractSqlQuery} object.
-  class MissingSqlQueryError < GrafanaError
-    def initialize
-      super('No SQL statement has been specified.')
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Grafana
+  # A top level alarm for all other errors in current module.
+  class GrafanaError < StandardError
+    def initialize(message)
+      super("GrafanaError: #{message} (#{self.class})")
+    end
+  end
+
+  # Raised if a given dashboard does not exist in a specific {Grafana} instance.
+  class DashboardDoesNotExistError < GrafanaError
+    # @param dashboard_uid [String] dashboard uid, which could not be found
+    def initialize(dashboard_uid)
+      super("The specified dashboard '#{dashboard_uid}' does not exist.")
+    end
+  end
+
+  # Raised if a given panel does not exist on a specific {Dashboard} in the current {Grafana} instance.
+  class PanelDoesNotExistError < GrafanaError
+    # @param panel_id [String] panel id, which could not be found on the dashboard
+    # @param dashboard [Dashboard] dashboard object on which the panel could not be found
+    def initialize(panel_id, dashboard)
+      super("The specified panel id '#{panel_id}' does not exist on the dashboard '#{dashboard.id}'.")
+    end
+  end
+
+  # Raised if a given query letter does not exist on a specific {Panel}.
+  class QueryLetterDoesNotExistError < GrafanaError
+    # @param query_letter [String] query letter name, which could not be found on the panel
+    # @param panel [Panel] panel object on which the query could not be found
+    def initialize(query_letter, panel)
+      super("The specified query '#{query_letter}' does not exist in the panel '#{panel.id}' "\
+        "in dashboard '#{panel.dashboard}'.")
+    end
+  end
+
+  # Raised if a given datasource does not exist in a specific {Grafana} instance.
+  class DatasourceDoesNotExistError < GrafanaError
+    # @param field [String] specifies, how the datasource has been searched, e.g. 'id' or 'name'
+    # @param datasource_identifier [String] identifier of the datasource, which could not be found,
+    #   e.g. the specifiy id or name
+    def initialize(field, datasource_identifier)
+      super("Datasource with #{field} '#{datasource_identifier}' does not exist.")
+    end
+  end
+
+  # Raised if a {Panel} could not be rendered as an image.
+  #
+  # Most likely this happens, because the image renderer is not configures properly in grafana,
+  # or the panel rendering ran into a timeout.
+  class ImageCouldNotBeRenderedError < GrafanaError
+    # @param panel [Panel] panel object, which could not be rendered
+    def initialize(panel)
+      super("The specified panel '#{panel.id}' from dashboard '#{panel.dashboard.id} could not be "\
+        'rendered to an image.')
+    end
+  end
+
+  # Raised if no SQL query is specified in a {AbstractSqlQuery} object.
+  class MissingSqlQueryError < GrafanaError
+    def initialize
+      super('No SQL statement has been specified.')
+    end
+  end
+
+  # Raised if a datasource shall be queried, which is not (yet) supported by the reporter
+  class DatasourceTypeNotSupportedError < GrafanaError
+    def initialize(name, type)
+      super("The configured datasource with name '#{name}' is of type '#{type}', which is currently "\
+            'not supported by ruby-grafana-reporter. It will only be usable in panel image queries.')
+    end
+  end
+
+  # Raised if a datasource shall be queried, which is not (yet) supported by the reporter
+  class InvalidDatasourceQueryProvidedError < GrafanaError
+    def initialize(query)
+      super("The datasource query provided, does not look like a grafana datasource target (received: #{query}).")
+    end
+  end
+end

data/lib/grafana/grafana.rb

@@ -1,131 +1,130 @@
-# Contains all objects for creating structured objects for interfacing grafana.
-#
-# The intention is, that these represent the business logic contained within grafana in an appropriate object model for the reporter to work with.
-#
-# For details, see also {https://grafana.com/docs/grafana/latest/http_api Grafana API}.
-module Grafana
-  # Main class for handling the interaction with one specific Grafana instance.
-  class Grafana
-    # @param base_uri [String] full URI pointing to the specific grafana instance without trailing slash, e.g. +https://localhost:3000+.
-    # @param key [String] API key for the grafana instance, if required
-    # @param opts [Hash] additional options.
-    #   Currently supporting +:logger+ and +:datasources+.
-    #   +:datasources+ need to be an Hash with datasource name as key and datasource id as value.
-    #   If not specified, the datasources will be queried from the grafana interface.
-    #   Specifying +:datasources+> here can be used, so that the interface can be used without grafana Admin privileges.
-    def initialize(base_uri, key = nil, opts = {})
-      @base_uri = base_uri
-      @key = key
-      @dashboards = {}
-      @logger = opts[:logger] || ::Logger.new(nil)
-      @datasources = opts[:datasources]
-    end
-
-    # Used to test a connection to the grafana instance.
-    #
-    # Running this function also determines, if the API configured here has Admin or NON-Admin privileges,
-    # or even fails on connecting to grafana.
-    #
-    # @return [String] +Admin+, +NON-Admin+ or +Failed+ is returned, depending on the test results
-    def test_connection
-      res = execute_http_request('/api/datasources')
-      if res.is_a?(Net::HTTPOK)
-        # we have admin rights
-        @logger.info('Reporter is running with Admin privileges on grafana.')
-        return 'Admin'
-      else
-        # check if we have lower rights
-        res = execute_http_request('/api/dashboards/home')
-        if res.is_a?(Net::HTTPOK)
-          @logger.warn('Reporter is running with NON-Admin privileges on grafana. Make sure that necessary datasources are specified in CONFIG_FILE, otherwise operation will fail')
-          return 'NON-Admin'
-        end
-      end
-
-      'Failed'
-    end
-
-    # Returns the ID of a datasource, which has been queried by the datasource name.
-    #
-    # @return [Integer] ID for the specified datasource name
-    def datasource_id(datasource_name)
-      id = datasources[datasource_name]
-      raise DatasourceDoesNotExistError.new('name', datasource_name) unless id
-
-      id
-    end
-
-    # Returns if the given datasource ID exists for the grafana instance.
-    #
-    # @return [Boolean] true if exists, false otherwise
-    def datasource_id_exists?(datasource_id)
-      datasources.value?(datasource_id)
-    end
-
-    # @param dashboard_uid [String] UID of the searched {Dashboard}
-    # @return [Dashboard] dashboard object, if it has been found
-    def dashboard(dashboard_uid)
-      return @dashboards[dashboard_uid] unless @dashboards[dashboard_uid].nil?
-
-      response = execute_http_request('/api/dashboards/uid/' + dashboard_uid)
-      model = JSON.parse(response.body)['dashboard']
-
-      raise DashboardDoesNotExistError, dashboard_uid if model.nil?
-
-      # cache dashboard for reuse
-      @dashboards[dashboard_uid] = Dashboard.new(model, self)
-
-      @dashboards[dashboard_uid]
-    end
-
-    # Runs a specific HTTP request against the current grafana instance.
-    #
-    # Default (can be overridden, by specifying the options Hash):
-    #   accept: 'application/json'
-    #   request: Net::HTTP::Get
-    #   content_type: 'application/json'
-    #
-    # @param relative_uri [String] relative URL with a leading slash, which shall be queried
-    # @param options [Hash] options, which shall be merged to the request.
-    # @param timeout [Integer] number of seconds to wait, before the http request is cancelled, defaults to 60 seconds
-    def execute_http_request(relative_uri, options = {}, timeout = nil)
-      uri = URI.parse(@base_uri + relative_uri)
-      default_options = { accept: 'application/json', request: Net::HTTP::Get, content_type: 'application/json' }
-      options = default_options.merge(options)
-
-      http = Net::HTTP.new(uri.host, uri.port)
-      if @base_uri =~ /^https/
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-      end
-      http.read_timeout = timeout.to_i if timeout
-
-      request = options[:request].new(uri.request_uri)
-      request['Accept'] = options[:accept]
-      request['Content-Type'] = options[:content_type]
-      request['Authorization'] = 'Bearer ' + @key unless @key.nil?
-      request.body = options[:body]
-
-      @logger.debug("Requesting #{relative_uri} with '#{options[:body]}' and timeout '#{http.read_timeout}'")
-      resp = http.request(request)
-      resp
-    end
-
-    private
-
-    def datasources
-      if @datasources.nil?
-        # load datasources from grafana directly, if allowed
-        response = execute_http_request('/api/datasources')
-        if response['message'].nil?
-          json = JSON.parse(response.body)
-          # only store needed values
-          @datasources = json.map { |item| [item['name'], item['id']] }.to_h
-        else
-          @datasources = {}
-        end
-      end
-      @datasources
-    end
-  end
-end
+# frozen_string_literal: true
+
+# Contains all objects for creating structured objects for interfacing grafana.
+#
+# The intention is, that these represent the business logic contained within grafana
+# in an appropriate object model for the reporter to work with.
+#
+# For details, see also {https://grafana.com/docs/grafana/latest/http_api Grafana API}.
+module Grafana
+  # Main class for handling the interaction with one specific Grafana instance.
+  class Grafana
+    # @param base_uri [String] full URI pointing to the specific grafana instance without
+    #   trailing slash, e.g. +https://localhost:3000+.
+    # @param key [String] API key for the grafana instance, if required
+    # @param opts [Hash] additional options.
+    #   Currently supporting +:logger+.
+    def initialize(base_uri, key = nil, opts = {})
+      @base_uri = base_uri
+      @key = key
+      @dashboards = {}
+      @logger = opts[:logger] || ::Logger.new(nil)
+
+      initialize_datasources unless @base_uri.empty?
+    end
+
+    # Used to test a connection to the grafana instance.
+    #
+    # Running this function also determines, if the API configured here has Admin or NON-Admin privileges,
+    # or even fails on connecting to grafana.
+    #
+    # @return [String] +Admin+, +NON-Admin+ or +Failed+ is returned, depending on the test results
+    def test_connection
+      if prepare_request({ relative_url: '/api/datasources' }).execute.is_a?(Net::HTTPOK)
+        # we have admin rights
+        @logger.warn('Reporter is running with Admin privileges on grafana. This is a potential security risk.')
+        return 'Admin'
+      end
+      # check if we have lower rights
+      return 'Failed' unless prepare_request({ relative_url: '/api/dashboards/home' }).execute.is_a?(Net::HTTPOK)
+
+      @logger.info('Reporter is running with NON-Admin privileges on grafana.')
+      'NON-Admin'
+    end
+
+    # Returns the datasource, which has been queried by the datasource name.
+    #
+    # @param datasource_name [String] name of the searched datasource
+    # @return [Datasource] Datasource for the specified datasource name
+    def datasource_by_name(datasource_name)
+      datasource_name = 'default' if datasource_name.to_s.empty?
+      raise DatasourceDoesNotExistError.new('name', datasource_name) unless @datasources[datasource_name]
+
+      @datasources[datasource_name]
+    end
+
+    # Returns the datasource, which has been queried by the datasource id.
+    #
+    # @param datasource_id [Integer] id of the searched datasource
+    # @return [Datasource] Datasource for the specified datasource id
+    def datasource_by_id(datasource_id)
+      datasource = @datasources.select { |_name, ds| ds.id == datasource_id.to_i }.values.first
+      raise DatasourceDoesNotExistError.new('id', datasource_id) unless datasource
+
+      datasource
+    end
+
+    # @return [Array] Array of dashboard uids within the current grafana object
+    def dashboard_ids
+      response = prepare_request({ relative_url: '/api/search' }).execute
+      return [] unless response.is_a?(Net::HTTPOK)
+
+      dashboards = JSON.parse(response.body)
+
+      dashboards.each do |dashboard|
+        @dashboards[dashboard['uid']] = nil unless @dashboards[dashboard['uid']]
+      end
+
+      @dashboards.keys
+    end
+
+    # @param dashboard_uid [String] UID of the searched {Dashboard}
+    # @return [Dashboard] dashboard object, if it has been found
+    def dashboard(dashboard_uid)
+      return @dashboards[dashboard_uid] unless @dashboards[dashboard_uid].nil?
+
+      response = prepare_request({ relative_url: "/api/dashboards/uid/#{dashboard_uid}" }).execute
+      raise DashboardDoesNotExistError, dashboard_uid unless response.is_a?(Net::HTTPOK)
+
+      # cache dashboard for reuse
+      model = JSON.parse(response.body)['dashboard']
+      @dashboards[dashboard_uid] = Dashboard.new(model, self)
+
+      @dashboards[dashboard_uid]
+    end
+
+    # Prepares a {WebRequest} object for the current {Grafana} instance, which may be enriched
+    # with further properties and can then run {WebRequest#execute}.
+    #
+    # @option options [Hash] :relative_url relative URL with a leading slash, which shall be queried
+    # @option options [Hash] :accept
+    # @option options [Hash] :body
+    # @option options [Hash] :content_type
+    # @return [WebRequest] webrequest prepared for execution
+    def prepare_request(options = {})
+      auth = @key ? { authorization: "Bearer #{@key}" } : {}
+      WebRequest.new(@base_uri, auth.merge({ logger: @logger }).merge(options))
+    end
+
+    private
+
+    def initialize_datasources
+      @datasources = {}
+
+      settings = prepare_request({ relative_url: '/api/frontend/settings' }).execute
+      return unless settings.is_a?(Net::HTTPOK)
+
+      json = JSON.parse(settings.body)
+      json['datasources'].select { |_k, v| v['id'].to_i.positive? }.each do |ds_name, ds_value|
+        begin
+          @datasources[ds_name] = AbstractDatasource.build_instance(ds_value)
+        rescue DatasourceTypeNotSupportedError => e
+          # an unsupported datasource type has been configured in the dashboard
+          # - no worries here
+          @logger.warn(e.message)
+        end
+      end
+      @datasources['default'] = @datasources[json['defaultDatasource']]
+    end
+  end
+end