mackerel-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3069a1328fe22ade45d038f43f84e0d284d31147
-  data.tar.gz: 358f4acb097b4bf6184ed740555916f4875b5aee
+  metadata.gz: 8223df7347ec3ad38411bc07a47ee281dfa903ce
+  data.tar.gz: 455e08dfe09c1f13d97ae24798cfa24faa3738b3
 SHA512:
-  metadata.gz: 22f6985dd1027bb676ae5ef310a32d35f619b2624d95069b411d051952e3410c109a19415ab65b09964a38fe83996ee3944b451540d5f4e169dd3ca2bbac67fd
-  data.tar.gz: 673b03abd2573c2aecc583412c3c89678974bf1d0436fda32ac5101b3c02710d93e7c4d8bd131899f967e4dbfd0e87f9e8b1906467cefd2c46a7eaac1609b7fd
+  metadata.gz: 5cb671cf7f4de85fdd7581441192f0dc0126bbe6114647b1120d4dd80f1c71393af0ad1163d55d5d416bc000f960908b8f551f0606dd0de0a4317ec3496ab927
+  data.tar.gz: eaeec9170583fd338b270b4a7f5587219278ed8ac8af7f86c5298a4253b40d01a76f30a9598ad1a50fae2f7cbff45d5acc7870a02031bc522ef2aadf6dc5d601

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/example/01_invitation.rb

@@ -0,0 +1,12 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+pp mc.get_organization()
+pp mc.post_invitation(ENV['EMAIL'], "viewer")
+#pp mc.revoke_invitation(ENV['EMAIL'])
+pp user = mc.get_users()
+pp mc.delete_user(user.id) unless user.any?

data/example/02_dashboard.rb

@@ -0,0 +1,29 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+
+# make a dashboard
+title = "Dashboard Example"
+markdown = "
+# Inform to labors
+
+Working time is eight hour.
+May day is May 1st.
+"
+urlPath = "DashboardExample"
+pp mc.post_dashboard(title, markdown, urlPath)
+
+# Update the dashboard
+new_title = "That Song"
+pp dashboards = mc.get_dashboards
+target_dashboard = dashboards.select{|d| d.urlPath =~ /#{urlPath}/ }.first
+mc.get_dashboard(target_dashboard.id)
+pp mc.update_dashboard(target_dashboard.id, new_title, markdown, urlPath)
+
+# Delete the dashboard
+pp mc.delete_dashboard(target_dashboard.id)
+

data/example/03_host.rb

@@ -0,0 +1,97 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+
+# Regist two hosts
+pp mc.post_host({
+  'name' => 'web001',
+  'meta' => {
+    'agent-name' => 'mackerel-agent/0.6.1',
+    'agent-revision' => 'bc2f9f6',
+    'agent-version'  => '0.6.1',
+  },
+  'type' => 'unknown',
+  'status' => 'working',
+  'memo' => 'test web host',
+  'isRetired' => false,
+  'createdAt' => '1401291970',
+  'roleFullnames' => [
+    'mackerel:web'
+  ],
+  'interfaces' => [{
+      "ipAddress"   => "10.1.1.1",
+      "macAddress"  => "08:00:27:ce:08:3d",
+      "name"        => "eth0"
+  }]
+})
+pp mc.post_host({
+  'name' => 'db001',
+  'meta' => {
+    'agent-name' => 'mackerel-agent/0.6.1',
+    'agent-revision' => 'bc2f9f6',
+    'agent-version'  => '0.6.1',
+  },
+  'type' => 'unknown',
+  'status' => 'working',
+  'memo' => 'test db host',
+  'isRetired' => false,
+  'createdAt' => '1401291976',
+  'roleFullnames' => [
+    'mackerel:db'
+  ],
+  'interfaces' => [{
+      "ipAddress"   => "10.0.0.1",
+      "macAddress"  => "08:00:27:ce:08:3d",
+      "name"        => "eth0"
+  }]
+})
+
+# get information of host
+pp hosts = mc.get_hosts
+target_host = hosts.first
+pp mc.get_host(target_host.id)
+pp mc.get_host_metric_names(target_host.id)
+
+# add host metadata 
+namespace = "Scenario3"
+pp mc.update_metadata(target_host.id, namespace, "metadata test")
+pp metadata = mc.list_metadata(target_host.id)
+pp mc.get_metadata(target_host.id, namespace)
+pp mc.delete_metadata(target_host.id, namespace)
+
+# Update the role and the status
+pp mc.update_host_roles(target_host.id, [ "mackerel:web" ])
+pp mc.update_host_status(target_host.id, 'poweroff')
+
+# Update the host
+pp mc.update_host(target_host.id,{
+  'name' => 'db001',
+  'meta' => {
+    'agent-name' => 'mackerel-agent/0.6.1',
+    'agent-revision' => 'bc2f9f6',
+    'agent-version'  => '0.6.1',
+  },
+  'type' => 'unknown',
+  'status' => 'working',
+  'memo' => 'test host',
+  'isRetired' => false,
+  'createdAt' => '1401291976',
+  'id' => target_host.id,
+  'roleFullnames' => [
+    'mackerel:db'
+  ],
+  'interfaces' => [{
+      "ipAddress"   => "10.0.0.1",
+      "macAddress"  => "08:00:27:ce:08:3d",
+      "name"        => "eth0"
+  }]
+})
+
+# retire the host
+pp mc.retire_host(target_host.id)
+
+

data/example/04_metrics.rb

@@ -0,0 +1,44 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+
+host = mc.get_hosts.first
+current_time = Time.now.to_i
+rand = Random.new(current_time.to_i)
+
+
+pp mc.get_service_metric_names("mackerel")
+
+
+pp mc.get_host_metrics(host.id, "loadavg5", current_time - 6000, current_time)
+pp mc.get_latest_metrics([host.id], ["loadavg5"])
+pp mc.post_metrics([{
+  hostId: host.id,
+  name: "custom.host_metrics.example",
+  time: current_time,
+  value: rand.rand(20)
+}])
+
+pp mc.define_graphs([
+  {
+      "name" => "custom.define_graph",
+      "displayName" => "defined_graph",
+      "unit" => "percentage",
+      "metrics" => [
+         { "name" => "custom.define_graph.example", "displayName" => "Example", "isStacked" => false}
+      ]
+  }
+])
+
+pp mc.post_service_metrics("mackerel", [{
+  name: "custom.define_graph.example",
+  time: current_time,
+  value: rand.rand(20)
+}])
+
+pp mc.get_service_metrics("mackerel", "custom.define_graph.example", current_time - 6000, current_time)
+

data/example/05_service_role.rb

@@ -0,0 +1,10 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+
+pp mc.get_services
+pp mc.get_roles("mackerel")

data/example/06_annotation.rb

@@ -0,0 +1,26 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+
+current_time = Time.now.to_i
+service = "mackerel"
+pp mc.post_graph_annotation({
+  title: "First Annotation",
+  description: "Scenario Test Annotation",
+  from: current_time - 6000,
+  to: current_time - 60,
+  service: service
+})
+pp annotation = mc.get_graph_annotations(service, current_time - 6000, current_time).first
+pp mc.update_graph_annotation(annotation.id, {
+  title: "Second Annotation",
+  description: "Scenario Test Annotation",
+  from: current_time - 6000,
+  to: current_time - 60,
+  service: service
+})
+pp mc.delete_graph_annotation(annotation.id)

data/example/07_monitoring.rb

@@ -0,0 +1,100 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+rand = Random.new(Time.now.to_i)
+current_time = Time.now.to_i
+
+host = mc.get_hosts.first
+pp mc.post_monitoring_check_report({
+  reports: [
+    {
+      name: "check-report-test",
+      status: "OK",
+      message: "YOKERO!",
+      occurredAt: current_time,
+      source: {
+        type: "host",
+        hostId: host.id
+      }
+    }
+  ]
+})
+
+pp mc.post_monitor({
+  type: "host",
+  name: "custom.define_graph.example",
+  memo: "This is monitor test.",
+  duration: 3,
+  metric: "custom.define_graph.example",
+  operator: ">",
+  warning: 30.0,
+  critical: 40.0,
+  notificationInterval: 60
+})
+pp monitor = mc.get_monitors.first
+
+pp mc.update_monitor(monitor.id , {
+  type: "host",
+  name: "custom.define_graph.example",
+  memo: "This is monitor test.",
+  duration: 1,
+  metric: "custom.define_graph.example",
+  operator: ">",
+  warning: 5.0,
+  critical: 10.0,
+  notificationInterval: 60
+})
+
+
+pp channels = mc.get_channels().first
+
+pp notification_group = mc.post_notification_group(
+{
+  name: "Example notification group",
+  notificationLevel: "all",
+  childNotificationGroupIds: [],
+  childChannelIds: [
+    channels.id
+  ],
+  monitors: [
+    {
+      id: monitor.id,
+      skipDefault: false
+    }
+  ],
+  services: [
+    {
+      name: "mackerel"
+    }
+  ]
+}
+)
+
+pp mc.update_notification_group(notification_group.id,{
+  name: "Example notification group(updated)",
+  notificationLevel: "all",
+  childNotificationGroupIds: [],
+  childChannelIds: [
+    channels.id
+  ],
+  monitors: [
+    {
+      id: monitor.id,
+      skipDefault: false
+    }
+  ],
+  services: [
+    {
+      name: "mackerel"
+    }
+  ]
+}
+)
+
+pp mc.get_notification_groups()
+mc.delete_notification_group(notification_group.id)
+mc.delete_monitor(monitor.id)

data/example/08_alert.rb

@@ -0,0 +1,10 @@
+require 'mackerel-client'
+require 'dotenv'
+require 'pp'
+require 'time'
+
+Dotenv.load
+mc = Mackerel::Client.new(:mackerel_api_key => ENV['MACKEREL_APIKEY'])
+pp alert = mc.get_alerts().first
+pp mc.close_alert(alert.id,"Scenario Test") unless alert.nil?
+

data/example/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+gem "dotenv"
+gem "json"
+gem "mackerel-client", path: '../'
+gem "pry"

data/lib/mackerel/alert.rb

@@ -0,0 +1,48 @@
+module Mackerel
+
+  class Alert
+    attr_accessor :id, :status, :monitorId, :type, :hostId, :value, :message, :reason, :openedAt, :closedAt
+
+    def initialize(args = {})
+      @id                              = args["id"]
+      @status                          = args["status"]
+      @monitorId                       = args["monitorId"]
+      @type                            = args["type"]
+      @hostId                          = args["hostId"]
+      @value                           = args["value"]
+      @message                         = args["message"]
+      @reason                          = args["reason"]
+      @openedAt                        = args["openedAt"]
+      @closedAt                        = args["closedAt"]
+    end
+
+    def to_h
+      instance_variables.flat_map do |name|
+        respond_to?(name[1..-1]) ? [name[1..-1]] : []
+      end.each_with_object({}) do |name, hash|
+        hash[name] = public_send(name)
+      end.delete_if { |key, val| val == nil }
+    end
+
+    def to_json(options = nil)
+      return to_h.to_json(options)
+    end
+  end
+
+  module REST
+    module Alert
+      def get_alerts()
+        command = ApiCommand.new(:get, "/api/v0/alerts", @api_key)
+        data = command.execute(client)
+        data["alerts"].map { |a| Mackerel::Alert.new(a) }
+      end
+
+      def close_alert(alertId, reason)
+        command = ApiCommand.new(:post, "/api/v0/alerts/#{alertId}/close", @api_key)
+        command.body = { reason: reason.to_s }.to_json
+        data = command.execute(client)
+        Mackerel::Alert.new(data)
+      end
+    end
+  end
+end

data/lib/mackerel/annotation.rb

@@ -0,0 +1,61 @@
+module Mackerel
+
+  class Annotation
+    attr_accessor :id, :service, :from, :to, :description, :title, :roles
+    def initialize(args = {})
+      @id                              = args["id"]
+      @service                         = args["service"]
+      @from                            = args["from"]
+      @to                              = args["to"]
+      @description                     = args["description"]
+      @title                           = args["title"]
+      @roles                           = args["roles"]
+    end
+
+    def to_h
+      instance_variables.flat_map do |name|
+        respond_to?(name[1..-1]) ? [name[1..-1]] : []
+      end.each_with_object({}) do |name, hash|
+        hash[name] = public_send(name)
+      end.delete_if { |key, val| val == nil }
+    end
+
+    def to_json(options = nil)
+      return to_h.to_json(options)
+    end
+
+  end
+
+  module REST
+    module Annotation
+      def post_graph_annotation(annotation)
+        command = ApiCommand.new(:post, '/api/v0/graph-annotations', @api_key)
+        command.body = annotation.to_json
+        data = command.execute(client)
+        Mackerel::Annotation.new(data)
+      end
+
+      def get_graph_annotations(service, from, to)
+        command = ApiCommand.new(:get, '/api/v0/graph-annotations', @api_key)
+        command.params['service'] = service
+        command.params['from'] = from
+        command.params['to'] = to
+        data = command.execute(client)
+        data['graphAnnotations'].map{|a| Mackerel::Annotation.new(a)}
+      end
+
+      def update_graph_annotation(annotation_id, annotation)
+        command = ApiCommand.new(:put, "/api/v0/graph-annotations/#{annotation_id}", @api_key)
+        command.body = annotation.to_json
+        data = command.execute(client)
+        Mackerel::Annotation.new(data)
+      end
+
+      def delete_graph_annotation(annotation_id)
+        command = ApiCommand.new(:delete, "/api/v0/graph-annotations/#{annotation_id}", @api_key)
+        data = command.execute(client)
+        Mackerel::Annotation.new(data)
+      end
+    end
+  end
+end

data/lib/mackerel/api_command.rb

@@ -0,0 +1,67 @@
+require 'cgi'
+require 'pp'
+
+module Mackerel
+  class ApiCommand
+    METHODS = [:get, :delete, :put, :post]
+    JSON_CONTENT_TYPE = 'application/json'
+
+    attr_accessor :headers, :body, :params, :query
+
+    def initialize(method, path, api_key)
+      @path = path
+      @method = method
+      @api_key = api_key
+
+      @headers = {}
+      @body = ''
+      @params = {}
+      @query = {}
+    end
+
+    def execute(client)
+      return unless METHODS.include?(@method)
+
+      request_path = @path
+      request_path << "?#{make_escaped_query}" if @query.any?
+
+      client_method = client.method(@method)
+      response = client_method.call(request_path) do |req|
+        req.headers = @headers
+        req.headers['x-api-key'] = @api_key
+        req.headers['Content-Type'] ||= JSON_CONTENT_TYPE
+        req.params = @params
+        req.body = @body
+      end
+      check_status(response.status)
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def check_status(status)
+      case status
+      when 200...300
+        nil
+      when 400
+        message ="Invalid parameter"
+        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
+      when 403
+        message ="Not authorized"
+        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
+      when 404
+        message ="Resource not found"
+        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
+      when 409
+        message ="Already exists"
+        raise "#{@method.upcase} #{@path} failed: #{status} #{message}"
+      end
+    end
+
+    def make_escaped_query
+      @query.map{|k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"}.join("&")
+    end
+
+  end
+end

data/lib/mackerel/channel.rb

@@ -0,0 +1,32 @@
+module Mackerel
+  class Channel
+    attr_accessor :id, :name, :type
+    def initialize(args = {})
+      @id                 = args["id"]
+      @name               = args["name"]
+      @type               = args["type"]
+    end
+
+    def to_h
+      instance_variables.flat_map do |name|
+        respond_to?(name[1..-1]) ? [name[1..-1]] : []
+      end.each_with_object({}) do |name, hash|
+        hash[name] = public_send(name)
+      end.delete_if { |key, val| val == nil }
+    end
+
+    def to_json(options = nil)
+      return to_h.to_json(options)
+    end
+  end
+
+  module REST
+    module Channel
+      def get_channels()
+        command = ApiCommand.new(:get, '/api/v0/channels', @api_key)
+        data = command.execute(client)
+        data['channels'].map{|d| Mackerel::Channel.new(d) }
+      end
+    end
+  end
+end