grafana 0.8.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bcc9d3c645a3c12b1cc31d23c9f123b10369be5b
-  data.tar.gz: 8f99154dd21e93476cd6a3163e32550ecdd2816a
+SHA256:
+  metadata.gz: ee4ecb6c21184aee321f81b9d5a5681524da6cac47b736756e8b3b1a4c091eed
+  data.tar.gz: 267e82424dad92727eace6b546f2fd436235e51af5b471c806833e4eb3186efe
 SHA512:
-  metadata.gz: abef29e0ae13c67c3cfcf09a5f79a9c7f16a850b8eb7cecb023ae9ded603d49d335dd7069b696d9493efbc60dff0fdcb9a8534b8563979d4689b10ce388b0374
-  data.tar.gz: 560de8458cf0d3ef08cdfff425be1d3a7c435846df193931fbe1cf2bca1eedb6dda9b738d47952f27d3fdab26e48fef8cc543ffdc66b3037cdda3ed5bd104288
+  metadata.gz: 97d4a3aa5740c1992cf706fec3deae4690db5c68f05eb334b828dea74d6173fde86fbb3a53c2afe562d5a299e13a2c5450d4e27bcdf7dae96a146a8b3f2cb770
+  data.tar.gz: 5c231dad3f4552d8176b8b0a5653284b3792ec1058c958674a625e99b790d9e51f93eb240ca5f500c94e2cbff23159b2933fac13723cdaa0518b8f808f31176a

data/README.md

@@ -26,11 +26,16 @@ TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake rake` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`,
+which will create a git tag for the version,
+push git commits and tags and push the `.gem` file to [rubygems.org](https://rubygems.org/gems/grafana).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grafana.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bodsch/grafana.
 

data/lib/_logging.rb_

@@ -0,0 +1,55 @@
+
+require 'logger'
+
+# -------------------------------------------------------------------------------------------------
+
+module Logging
+
+  def logger
+    @logger ||= Logging.logger_for( self.class.name )
+  end
+
+  # Use a hash class-ivar to cache a unique Logger per class:
+  @loggers = {}
+
+  class << self
+
+    def logger_for( classname )
+      @loggers[classname] ||= configure_logger_for( classname )
+    end
+
+    def configure_logger_for( classname )
+
+      log_level = ENV.fetch('LOG_LEVEL', 'INFO' )
+      level = log_level.dup
+
+      # DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
+      log_level = case level.upcase
+        when 'DEBUG'
+          Logger::DEBUG   # Low-level information for developers.
+        when 'INFO'
+          Logger::INFO    # Generic (useful) information about system operation.
+        when 'WARN'
+          Logger::WARN    # A warning.
+        when 'ERROR'
+          Logger::ERROR   # A handleable error condition.
+        when 'FATAL'
+          Logger::FATAL   # An unhandleable error that results in a program crash.
+        else
+          Logger::UNKNOWN  # An unknown message that should always be logged.
+        end
+
+      $stdout.sync           = true
+      logger                 = Logger.new($stdout)
+      logger.level           = log_level
+      logger.datetime_format = "%Y-%m-%d %H:%M:%S %z"
+      logger.formatter       = proc do |severity, datetime, progname, msg|
+        "[#{datetime.strftime( logger.datetime_format )}] #{severity.ljust(5)}  #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end
+
+# -------------------------------------------------------------------------------------------------

data/lib/grafana.rb

@@ -1,5 +1,5 @@
 
-require_relative 'logging'
+# require_relative 'logging'
 require_relative 'monkey_patches.rb'
 require_relative 'grafana/client.rb'
 

data/lib/grafana/admin.rb

@@ -142,7 +142,8 @@ module Grafana
     #
     def delete_user( user_id )
 
-      raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an User name) or an Integer (for an User Id), given \'%s\'', user_id.class.to_s)) if( user_id.is_a?(String) && user_id.is_a?(Integer) )
+      raise ArgumentError.new(format('wrong type. user \'user_id\' must be an String (for an User name) or an Integer (for an User Id), given \'%s\'', user_id.class.to_s))  \
+        if( user_id.is_a?(String) && user_id.is_a?(Integer) )
       raise ArgumentError.new('missing \'user_id\'') if( user_id.size.zero? )
 
       if(user_id.is_a?(String))

data/lib/grafana/alerts.rb

@@ -1,38 +1,362 @@
 
 module Grafana
 
-  # http://docs.grafana.org/http_api/alerting/
+  # You can use the Alerting API to get information about alerts and their states but this API cannot be used to modify the alert.
+  # To create new alerts or modify them you need to update the dashboard json that contains the alerts.
+  #
+  # This API can also be used to create, update and delete alert notifications.
+  #
+  # original API Documentation can be found under: http://docs.grafana.org/http_api/alerting/
   #
   module Alerts
 
     # Get alerts
+    #
+    # These parameters are used as querystring parameters. For example:
+    #
+    # @param [Hash] params
+    # @option params [Mixed] dashboard_id alerts for a specified dashboard.
+    # @option params [Integer] panel_id alerts for a specified panel on a dashboard.
+    # @option params [Integer] limit (10) response to x number of alerts.
+    # @option params [Integer] state (ALL,no_data, paused, alerting, ok, pending)
+    # @option params [Array] alerts with one or more of the following alert states: 'ALL', 'no_data', 'paused', 'alerting', 'ok', 'pending'.
+    ## To specify multiple states use the following format: ?state=paused&state=alerting
+    #
+    # @return [Array]
     # GET /api/alerts/
+    # curl -H 'Content-Type: application/json;charset=UTF-8' 'http://admin:admin@127.0.0.1:3030/api/alerts'
     #
+    def alerts( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+#       raise ArgumentError.new('missing \'params\'') if( params.size.zero? )
+
+      dashboard_id = validate( params, required: false, var: 'dashboard_id' )
+      panel_id     = validate( params, required: false, var: 'panel_id', type: Integer )
+      limit        = validate( params, required: false, var: 'limit', type: Integer )
+      alert_array  = validate( params, required: false, var: 'alerts', type: Array )
+      valid_alerts = %w[ALL no_data paused alerting ok pending].sort
+
+      unless( alert_array.nil? )
+        alert_array  = alert_array.sort
+#         valid   = alert_array & valid_alerts
+        invalid = alert_array - valid_alerts
+
+        raise ArgumentError.new(format('wrong alerts type. only %s allowed, given \'%s\'', valid_alerts.join(', '), alert_array.join(', '))) if( invalid.count != 0 )
+      end
+
+      if( dashboard_id.is_a?(String) )
+
+        dashboard = search_dashboards( query: dashboard_id )
+
+        return { 'status' => 404, 'message' => format( 'No Dashboard \'%s\' found', dashboard_id) } if( dashboard.nil? || dashboard.dig('status').to_i != 200 )
+
+        dashboard = dashboard.dig('message').first unless( dashboard.nil? && dashboard.dig('status').to_i == 200 )
+        dashboard_id = dashboard.dig('id') unless( dashboard.nil? )
+
+        return { 'status' => 404, 'message' => format( 'No Dashboard \'%s\' found', dashboard_id) } if( dashboard_id.nil? )
+      end
+
+      api     = []
+      api << format( 'dashboardId=%s', dashboard_id ) unless( dashboard_id.nil? )
+      api << format( 'panelId=%s', panel_id ) unless( panel_id.nil? )
+      api << format( 'limit=%s', limit ) unless( limit.nil? )
+
+      unless( alert_array.nil? )
+        alert_array = alert_array.join( '&state=' ) if( alert_array.is_a?( Array ) )
+        api << format( 'state=%s', alert_array )
+      end
+      api = api.join( '&' )
+
+      endpoint = format( '/api/alerts/?%s' , api )
+
+      @logger.debug("Attempting to search for alerts (GET #{endpoint})") if @debug
+
+      get( endpoint )
+    end
+
     # Get one alert
-    # GET /api/alerts/:id
     #
-    def alerts( id = nil ); end
+    # @param [Mixed] alert_id Alertname (String) or Alertid (Integer)
+    #
+    # @example
+    #    alert( 1 )
+    #    alert( 'foo' )
+    #
+    # @return [Hash]
+    #
+    # curl -H 'Content-Type: application/json;charset=UTF-8' 'http://admin:admin@127.0.0.1:3030/api/alerts/1'
+    #
+    def alert( alert_id )
 
-    # Pause alert
-    # POST /api/alerts/:id/pause
-    def alert_pause( id ); end
+      if( alert_id.is_a?(String) && alert_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'alert_id\' must be an String (for an Alert name) or an Integer (for an Alert Id), given \'%s\'', alert_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'alert_id\'') if( alert_id.size.zero? )
+
+#       if(alert_id.is_a?(String))
+#         data = alerts( alerts: 'all' ).select { |_k,v| v['name'] == alert_id }
+#         alert_id = data.keys.first if( data )
+#       end
+
+#       puts alert_id
+      # GET /api/alerts/:id
+
+      endpoint = format( '/api/alerts/%d' , alert_id )
+
+#       puts endpoint
+
+      @logger.debug("Attempting get alert id #{alert_id} (GET #{endpoint})") if @debug
+
+      get( endpoint )
+    end
+
+
+    # Pause single alert
+    #
+    # @param [Mixed] alert_id Alertname (String) or Alertid (Integer)
+    #
+    # @example
+    #    alert_pause( 1 )
+    #    alert_pause( 'foo' )
+    #
+    # @return [Hash]
+    #
+    def alert_pause( alert_id )
+
+      if( alert_id.is_a?(String) && alert_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. \'alert_id\' must be an String (for an Alert name) or an Integer (for an Alert Id), given \'%s\'', alert_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'alert_id\'') if( alert_id.size.zero? )
+
+      if( alert_id.is_a?(String) )
+        data = alerts( alerts: 'all' ).select { |_k,v| v['name'] == alert_id }
+        alert_id = data.keys.first if( data )
+      end
+
+      endpoint = format( '/api/alerts/%d/pause', alert_id )
+
+      @logger.debug("Attempting pause alert id #{alert_id} (POST #{endpoint})") if @debug
+
+      # POST /api/alerts/:id/pause
+#       puts alert_id
+      post( endpoint )
+    end
 
     # Get alert notifications
-    # GET /api/alert-notifications
-    def alert_notifications; end
+    #
+    # @example
+    #    alert_notifications
+    #
+    # @return [Hash]
+    #
+    def alert_notifications
+      logger.debug('Getting alert notifications') if @debug
+      get('/api/alert-notifications')
+    end
+
+
+
+
+
 
     # Create alert notification
-    # POST /api/alert-notifications
-    def create_alert_notification( oarams ); end
+    #
+    # @param [Hash] params
+    # @option params [String] name short description - required
+    # @option params [String] type one of 'slack', 'pagerduty','email','webhook','kafka','hipchat',
+    #                               'victorops','sensu','opsgenie','threema','pushover','telegram','line','prometheus-alertmanager' - required
+    # @option params [Boolean] default (false)
+    # @option params [Hash] settings
+    #
+    # @example
+    #    params = {
+    #      name: 'new alert notification',
+    #      type:  'email',
+    #      default: false,
+    #      settings: {
+    #        addresses: 'carl@grafana.com;dev@grafana.com'
+    #      }
+    #    }
+    #    create_alert_notification( params )
+    #
+    # @return [Hash]
+    #
+    def create_alert_notification( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
+
+      # TODO
+      # type are 'email'
+      # and the other possible values?
+      name     = validate( params, required: true, var: 'name', type: String )
+      type     = validate( params, required: true, var: 'type', type: String ) || 'email'
+      default  = validate( params, required: false, var: 'default', type: Boolean ) || false
+      settings = validate( params, required: false, var: 'settings', type: Hash )
+
+      unless( type.nil? )
+        valid_types = %w[slack pagerduty email webhook kafka hipchat victorops sensu opsgenie threema pushover telegram line prometheus-alertmanager]
+        raise ArgumentError.new(format('wrong notification type. only %s allowed, given \%s\'', valid_types.join(', '), type)) if( valid_types.include?(type.downcase) == false )
+      end
+
+      # TODO
+      # check if the alert 'name' already created
+      return { 'status' => 404, 'message' => format( 'alert notification \'%s\' alread exists', name) } if( alert_notification?(name) )
+
+#       data = alert_notifications
+#       data = data.dig('message').first unless( data.nil? && data.dig('status').to_i == 200 )
+#       data = data.select { |k| k['name'] == name }
+#       return { 'status' => 404, 'message' => format( 'alert notification \'%s\' alread exists', name) } if( data )
+
+      payload = {
+        name: name,
+        type: type,
+        isDefault: default,
+        settings: settings
+      }
+      payload.reject!{ |_k, v| v.nil? }
+
+      endpoint = '/api/alert-notifications'
+
+#       puts endpoint
+#       puts payload
+
+      post(endpoint, payload.to_json)
+    end
 
     # Update alert notification
-    # PUT /api/alert-notifications/1
-    def update_alert_notification( params ); end
+    #
+    # @param [Hash] params
+    # @param [Mixed] alert_id Alertname (String) or Alertid (Integer) to change
+    # @option params [String] name short description - required
+    # @option params [String] type ('email') - required
+    # @option params [Boolean] default (false)
+    # @option params [Hash] settings
+    #
+    # @example
+    #    params = {
+    #      alert_id: 1
+    #      name: 'new alert notification',
+    #      type:  'email',
+    #      default: false,
+    #      settings: {
+    #        addresses: 'carl@grafana.com;dev@grafana.com'
+    #      }
+    #    }
+    #    update_alert_notification( params )
+    #
+    #    params = {
+    #      alert_id: 'new alert notification'
+    #      name: 'new alert notification',
+    #      type:  'email',
+    #      default: false,
+    #      settings: {
+    #       addresses: 'carl@grafana.com;dev@grafana.com'
+    #      }
+    #    }
+    #    update_alert_notification( params )
+    #
+    # @return [Hash]
+    #
+    def update_alert_notification( params )
+
+      raise ArgumentError.new(format('wrong type. \'params\' must be an Hash, given \'%s\'', params.class.to_s)) unless( params.is_a?(Hash) )
+      raise ArgumentError.new('missing params') if( params.size.zero? )
+
+      # TODO
+      # type are 'email'
+      # and the other possible values?
+      alert_id = validate( params, required: true, var: 'alert_id' )
+      name     = validate( params, required: true, var: 'name', type: String )
+      type     = validate( params, required: true, var: 'type', type: String ) || 'email'
+      default  = validate( params, required: false, var: 'default', type: Boolean ) || false
+      settings = validate( params, required: false, var: 'settings', type: Hash )
+
+      unless( type.nil? )
+        valid_types = %w[slack pagerduty email webhook kafka hipchat victorops sensu opsgenie threema pushover telegram line prometheus-alertmanager]
+        raise ArgumentError.new(format('wrong notification type. only %s allowed, given \%s\'', valid_types.join(', '), type)) if( valid_types.include?(type.downcase) == false )
+      end
+
+      if( alert_id.is_a?(String) && alert_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. user \'alert_id\' must be an String (for an Alertname) or an Integer (for an Alert Id), given \'%s\'', alert_id.class.to_s))
+      end
+
+      alert_id = alert_notification_id(alert_id)
+      return { 'status' => 404, 'message' => format( 'alert notification \'%s\' not exists', name) } if( alert_id.nil? )
+
+      payload = {
+        id: alert_id,
+        name: name,
+        type: type,
+        isDefault: default,
+        settings: settings
+      }
+      payload.reject!{ |_k, v| v.nil? }
+
+      endpoint = format( '/api/alert-notifications/%d', alert_id )
+
+      put(endpoint, payload.to_json)
+    end
 
     # Delete alert notification
-    # DELETE /api/alert-notifications/:notificationId
-    def delete_alert_notification( id ); end
+    #
+    # @param [Mixed] alert_id Alertname (String) or Alertid (Integer)
+    #
+    # @example
+    #    delete_alert_notification( 1 )
+    #    delete_alert_notification( 'foo' )
+    #
+    # @return [Hash]
+    #
+    def delete_alert_notification( alert_id )
+
+      if( alert_id.is_a?(String) && alert_id.is_a?(Integer) )
+        raise ArgumentError.new(format('wrong type. user \'alert_id\' must be an String (for an Alert name) or an Integer (for an Alert Id), given \'%s\'', alert_id.class.to_s))
+      end
+      raise ArgumentError.new('missing \'alert_id\'') if( alert_id.size.zero? )
+
+      id = alert_notification_id(alert_id)
+      return { 'status' => 404, 'message' => format( 'alert notification \'%s\' not exists', alert_id) } if( id.nil? )
+
+      endpoint = format('/api/alert-notifications/%d', alert_id )
+      logger.debug( "Deleting alert id #{alert_id} (DELETE #{endpoint})" ) if @debug
+
+      delete( endpoint )
+    end
+
+
+    private
+    def alert_notification?( alert_id )
+
+      id = alert_notification_id(alert_id)
+
+      return true unless( id.nil? )
+
+      false
+    end
+
+    def alert_notification_id( alert_id )
+
+      data = alert_notifications
+      data = data.dig('message') unless( data.nil? && data.dig('status').to_i == 200 )
+
+      map = {}
+      data.each do |d|
+        map[d.dig('id')] = d.dig('name').downcase.split.join('_')
+      end
+
+      id = map.select { |key,_value| key == alert_id } if( map && alert_id.is_a?(Integer) )
+      id = map.select { |_key,value| value == alert_id.downcase.split.join('_') } if( map && alert_id.is_a?(String) )
+
+      id = id.keys.first unless(id.nil?)
+
+      return id if( id.is_a?(Integer) )
+
+      nil
+    end
 
   end
 
 end
+