mms-api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed084e5a96495658bf4b5775abe035e50e6c7091
-  data.tar.gz: 55a19c53ad7c459788093069dafd2f8a49e3e2a3
+  metadata.gz: fa0051f575f3a3ae3a361221591a57fca40256b9
+  data.tar.gz: acda37863edf79ad4929c758dcf2cb60b5f7efef
 SHA512:
-  metadata.gz: 55c9e5339e3d37247a7c85331f16240b5ba20c1a5bcaa13cb853c27687035fe4cc7c29a36bdc7f94211e008d8e728e85ebd2295058175de498af9cf0080c0a65
-  data.tar.gz: c178e0e010081f87eee5372db173fddd4df21523dac70baa3bdd0c5d00e0da559846739eb671f04b65280b4b1c50a6dba1d6368775cc8bd70c2736db21ea80f4
+  metadata.gz: f48f1b2cf25beef5d7b13e1361764548f4d77889cf2c7c9b7dea3462520386b72a5f8d2fa75a0115d89b6c2729e4bf089232a843ebdac924b246517642324949
+  data.tar.gz: 931ed08d4581148c0d4e191188524f9051af12b5b0b1df8ba33507a2124eb140c86e0992729cc48e61c77591db3d9ae31f4cb0cd375c65ba15b0f9a51b13ca99

data/README.md

@@ -12,14 +12,16 @@ API coverage
 ------------
 The MMS Public API follows the principles of the REST architectural style to expose a number of internal resources which enable programmatic access to [MMS’s features](http://mms.mongodb.com/help/reference/api/). Current implementation support only a few of API features.
 
-|Resource     |Get All |Get One |Create |Update |Delete |
-|:------------|:------:|:------:|:-----:|:-----:|:-----:|
-|Groups       | +      | +      |       |       |       |
-|Hosts        | +      | +      |       |       |       |
-|Clusters     | +      | +      |       |       |       |
-|Snapshots    | +      | +      |       |       |       |
-|Alerts       | +      | +      |       |       |       |
-|Restore Jobs | +      | +      | +     |       |       |
+|Resource       |Get All |Get One |Create |Update |Delete |
+|:--------------|:------:|:------:|:-----:|:-----:|:-----:|
+|Groups         | +      | +      |       |       |       |
+|Hosts          | +      | +      |       |       |       |
+|Clusters       | +      | +      |       |       |       |
+|Snapshots      | +      | +      |       |       |       |
+|Alerts         | +      | +      |       |       |       |
+|Restore Jobs   | +      | +      | +     |       |       |
+|Backup Configs | +      | +      |       |       |       |
+|Metrics        | +      | +      |       |       |       |
 
 Library usage
 -------------
@@ -73,6 +75,28 @@ group = MMS::Resource::Group.find(client, 'group_id')
 hosts = group.hosts
 ```
 
+#### Metrics
+
+(Not available via CLI)
+
+You can list the available metrics on each host. The list contains the resource type MMS::Resource::Metric. This can be used to see which performance metrics the host has.
+
+In order to get the metric's data points you'll need to call the specific function.
+
+Note - you can send a hash containing query parameter. With no input it uses MMS default.
+
+The return value of the data points is the hash described in MMS's API reference docs.
+```ruby
+client = new MMS::Client.new('username', 'api_key')
+host = MMS::Resource::Host.find(client, 'group_id', 'host_id')
+metrics = host.metrics
+options = {"granularity" => "HOUR", "period" => "P1DT12H" }
+metrics.each do |m|
+  puts m.data_points(options)
+end
+```
+In case of hardware or database metrics, the return value will be an array that each value contains the data points for the relevant device or database.
+
 Cli usage
 ---------
 

data/lib/mms.rb

@@ -24,6 +24,8 @@ module MMS
   require 'mms/resource/snapshot_schedule'
   require 'mms/resource/restore_job'
   require 'mms/resource/alert'
+  require 'mms/resource/backup_config'
+  require 'mms/resource/metric'
 
   require 'mms/cli'
 end

data/lib/mms/agent.rb

@@ -80,8 +80,8 @@ module MMS
       if type_value.length == 24
         find_group(group_id).cluster(cluster_id).snapshot(type_value).create_restorejob
       elsif datetime = (type_value == 'now' ? DateTime.now : DateTime.parse(type_value))
-        raise('Invalid datetime. Correct `YYYY-MM-RRTH:m:s`') if datetime.nil?
-        datetime_string = [[datetime.year, datetime.day, datetime.month].join('-'), 'T', [datetime.hour, datetime.minute, datetime.second].join(':'), 'Z'].join
+        raise('Invalid datetime. Correct `YYYY-MM-RRTH:m:sZ`') if datetime.nil?
+        datetime_string = [[datetime.year, datetime.month, datetime.day].join('-'), 'T', [datetime.hour, datetime.minute, datetime.second].join(':'), 'Z'].join
         find_group(group_id).cluster(cluster_id).create_restorejob(datetime_string)
       end
     end

data/lib/mms/resource/backup_config.rb

@@ -0,0 +1,65 @@
+require 'date'
+
+module MMS
+
+  class Resource::BackupConfig < Resource
+
+    attr_accessor :cluster_id
+    attr_accessor :excluded_namespaces
+    attr_accessor :group_id
+    attr_accessor :links
+    attr_accessor :status_name
+
+    # @return [TrueClass, FalseClass]
+    def is_active
+      'STARTED'.eql? @status_name
+    end
+
+    # @return [String, NilClass]
+    def cluster_name
+      cluster.name if is_cluster
+    end
+
+    # @return [MMS::Resource::Cluster]
+    def cluster
+      MMS::Resource::Cluster.find(@client, @data['groupId'], @data['clusterId'])
+    end
+
+    def table_row
+      [cluster.group.name, cluster.name, @id, @excluded_namespaces, @group_id, @links, @status_name, @cluster_id]
+    end
+
+    def table_section
+      rows = []
+      rows << table_row
+      rows << :separator
+      rows
+    end
+
+    def self.table_header
+      ['Group', 'Cluster', 'BackupId', 'Excluded namespaces', 'Group Id', 'Links', 'Status name', 'Cluster id']
+    end
+
+    # @param [MMS::Client] client
+    # @param [String] group_id
+    # @param [String] cluster_id
+    def self._find(client, group_id, cluster_id)
+      client.get('/groups/' + group_id + '/backupConfigs/' + cluster_id)
+    end
+
+    private
+
+    def _from_hash(data)
+      @cluster_id = data['clusterId']
+      @excluded_namespaces = data['excludedNamespaces']
+      @group_id = data['groupId']
+      @links = data['links']
+      @status_name = data['statusName']
+    end
+
+    def _to_hash
+      @data
+    end
+
+  end
+end

data/lib/mms/resource/cluster.rb

@@ -21,7 +21,7 @@ module MMS
     end
 
     def snapshot(id)
-      MMS::Resource::Snapshot.find(@client, group.id, @id, id)
+      MMS::Resource::Snapshot.find(@client, group.id, @id, nil, id)
     end
 
     def snapshots(page = 1, limit = 1000)

data/lib/mms/resource/group.rb

@@ -12,6 +12,7 @@ module MMS
 
     def initialize
       @clusters = []
+      @backup_configs = []
     end
 
     # @param [Integer] page
@@ -73,6 +74,19 @@ module MMS
       MMS::Resource::Cluster.find(@client, @id, id)
     end
 
+    def backup_configs
+      if @backup_configs.empty?
+        @client.get('/groups/' + @id + '/backupConfigs').each do |backup_config|
+          bc = MMS::Resource::BackupConfig.new
+          bc.set_client(@client)
+          bc.set_data(backup_config)
+
+          @backup_configs.push bc
+        end
+      end
+      @backup_configs
+    end
+
     # @param [String] id
     # @return [MMS::Resource::Snapshot, NilClass]
     def find_snapshot(id)
@@ -85,6 +99,16 @@ module MMS
           # Snapshot is not available on this cluster. Skip it!
         end
       end
+      if snapshot.nil?
+        hosts.each do |host|
+          begin
+            snapshot = host.snapshot(id)
+            break unless snapshot.nil?
+          rescue MMS::ApiError => e
+            # Snapshot is not available on this host. Skip it!
+          end
+        end
+      end
       snapshot
     end
 

data/lib/mms/resource/host.rb

@@ -17,11 +17,32 @@ module MMS
     attr_accessor :profiler_enabled
     attr_accessor :logs_enabled
 
+    def initialize
+      @metric_list = []
+    end
+
     # @return [MMS::Resource::Group]
     def group
       MMS::Resource::Group.find(@client, @data['groupId'])
     end
 
+    def snapshot(id)
+      MMS::Resource::Snapshot.find(@client, group.id, nil, @id, id)
+    end
+
+    def snapshots(page = 1, limit = 1000)
+      if @snapshots.empty?
+        @client.get('/groups/' + group.id + '/hosts/' + @id + '/snapshots?pageNum=' + page.to_s + '&itemsPerPage=' + limit.to_s).each do |snapshot|
+          s = MMS::Resource::Snapshot.new
+          s.set_client(@client)
+          s.set_data(snapshot)
+
+          @snapshots.push s
+        end
+      end
+      @snapshots
+    end
+
     def table_row
       [group.name, @type_name, @name, @ip_address, @port, @last_ping, @alerts_enabled, @id, @shard_name, @replicaset_name]
     end
@@ -37,10 +58,25 @@ module MMS
     # @param [MMS::Client] client
     # @param [String] group_id
     # @param [String] id
+    # @returns [Hash]
     def self._find(client, group_id, id)
       client.get('/groups/' + group_id + '/hosts/' + id)
     end
 
+    # @returns [Array<MMS::Resource::Metric>]
+    def metrics
+      if @metric_list.empty?
+        @client.get('/groups/' + group.id + '/hosts/' + @id + '/metrics').each do |metric|
+          m = MMS::Resource::Metric.new
+          m.set_client(@client)
+          m.set_data(metric)
+
+          @metric_list.push m
+        end
+      end
+      @metric_list
+    end
+
     private
 
     def _from_hash(data)

data/lib/mms/resource/metric.rb

@@ -0,0 +1,63 @@
+module MMS
+
+  class Resource::Metric < Resource
+
+    attr_accessor :name
+    attr_accessor :units
+    attr_accessor :granularity
+    attr_accessor :data_points
+
+    def host
+      MMS::Resource::Host.find(@client, @data['groupId'], @data['hostId'])
+    end
+
+    # @param [Hash] options
+    # @returns [Array<Hash>]
+    def data_points(options = {})
+      series = []
+      metric_data = get_metric_data(options)
+      if !metric_data.is_a?(Array)
+        series << metric_data
+      else
+        metric_data.each do |m|
+          d_name = (m['deviceName'] || '') + (m['databaseName'] || '')
+          series << get_metric_data(options, d_name)
+        end
+      end
+      series
+    end
+
+    # @param [MMS::Client] client
+    # @param [String] group_id
+    # @param [String] host_id
+    # @param [String] metric_name
+    # @returns [Hash]
+    def self._find(client, group_id, host_id, metric_name)
+      client.get('/groups/' + group_id + '/hosts/' + host_id + '/metrics/' + metric_name)
+    end
+
+    private
+
+    # @param [Hash] options
+    # @param [String] name
+    # @returns [Hash]
+    def get_metric_data(options = {}, d_name = '')
+      params = options.map { |k, v| "#{k}=#{v}" }.join('&')
+      ret = client.get("/groups/#{@data['groupId']}/hosts/#{@data['hostId']}/metrics/#{@data['metricName']}/#{d_name}?#{params}")
+      ret.delete("links")
+      ret
+    end
+
+    def _from_hash(data)
+      @name = data['metricName']
+      @units = data['units']
+      @granularity = data['granularity']
+      @data_points = data['dataPoints']
+      data.delete('links')
+    end
+
+    def _to_hash
+      @data
+    end
+  end
+end

data/lib/mms/resource/restore_job.rb

@@ -22,15 +22,24 @@ module MMS
 
     attr_accessor :cluster_id
     attr_accessor :group_id
+    attr_accessor :host_id
 
     # @return [MMS::Resource::Cluster]
     def cluster
       MMS::Resource::Cluster.find(@client, @group_id, @cluster_id)
     end
 
+    def host
+      MMS::Resource::Host.find(@client, @group_id, @host_id)
+    end
+
+    def has_host?
+      !@host_id.nil?
+    end
+
     # @return [MMS::Resource::Snapshot, NilClass]
     def snapshot
-      @snapshot ||= cluster.group.find_snapshot(@snapshot_id)
+      has_host? ? host.snapshot(@snapshot_id) : cluster.snapshot(@snapshot_id)
     end
 
     def table_row
@@ -53,22 +62,16 @@ module MMS
       ['Timestamp / RestoreId', 'SnapshotId / Cluster / Group', 'Name (created)', 'Status', 'Point in time', 'Delivery', 'Restore status']
     end
 
-    def self._find(client, group_id, cluster_id, id)
-      begin
-        client.get('/groups/' + group_id + '/clusters/' + cluster_id + '/restoreJobs/' + id)
-      rescue MMS::ApiError => e
-        # workaround for https://jira.mongodb.org/browse/DOCS-5017
-        self._find_from_list(client, group_id, cluster_id, id)
-      end
+    def self._find(client, group_id, cluster_id, host_id, id)
+      host_id.nil? ? self._find_by_cluster(client, group_id, cluster_id, id) : self._find_by_host(client, group_id, host_id, id)
     end
 
-    def self._find_from_list(client, group_id, cluster_id, id)
-      cluster = MMS::Resource::Cluster.find(client, group_id, cluster_id)
-
-      job = cluster.restorejobs.find { |restorejob| restorejob.id == id }
-      raise("Cannot find RestoreJob id `#{id}`") if job.nil?
+    def self._find_by_host(client, group_id, host_id, id)
+      client.get('/groups/' + group_id + '/hosts/' + host_id + '/restoreJobs/' + id)
+    end
 
-      job.data
+    def self._find_by_cluster(client, group_id, cluster_id, id)
+      client.get('/groups/' + group_id + '/clusters/' + cluster_id + '/restoreJobs/' + id)
     end
 
     private
@@ -85,6 +88,7 @@ module MMS
       @name = DateTime.parse(@created).strftime("%Y-%m-%d %H:%M:%S")
       @cluster_id = data['clusterId']
       @group_id = data['groupId']
+      @host_id = data['hostId']
     end
 
     def _to_hash

data/lib/mms/resource/snapshot.rb

@@ -20,12 +20,12 @@ module MMS
 
     # @return [TrueClass, FalseClass]
     def is_config
-      @parts.length == 1 and @parts.first['typeName'] == 'CONFIG_SERVER'
+      @parts.length == 1 and @parts.first['typeName'] == 'REPLICA_SET' and !@parts.first['hostId'].nil?
     end
 
     # @return [TrueClass, FalseClass]
     def is_replica
-      @parts.length == 1 and @parts.first['typeName'] == 'REPLICA_SET'
+      @parts.length == 1 and @parts.first['typeName'] == 'REPLICA_SET' and !@parts.first['clusterId'].nil?
     end
 
     # @return [String, NilClass]
@@ -101,10 +101,18 @@ module MMS
     # @param [String] cluster_id
     # @param [String] id
     # @return [MMS::Resource::Snapshot]
-    def self._find(client, group_id, cluster_id, id)
+    def self._find(client, group_id, cluster_id, host_id, id)
+      host_id.nil? ? self._find_by_cluster(client, group_id, cluster_id, id) : self._find_by_host(client, group_id, host_id, id)
+    end
+
+    def self._find_by_cluster(client, group_id, cluster_id, id)
       client.get('/groups/' + group_id + '/clusters/' + cluster_id + '/snapshots/' + id.to_s)
     end
 
+    def self._find_by_host(client, group_id, host_id, id)
+      client.get('/groups/' + group_id + '/hosts/' + host_id + '/snapshots/' + id.to_s)
+    end
+
     private
 
     def _from_hash(data)

data/lib/mms/version.rb

@@ -1,3 +1,3 @@
 module MMS
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mms-api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Cargo Media
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http-digest_auth
@@ -115,9 +115,11 @@ files:
 - lib/mms/errors.rb
 - lib/mms/resource.rb
 - lib/mms/resource/alert.rb
+- lib/mms/resource/backup_config.rb
 - lib/mms/resource/cluster.rb
 - lib/mms/resource/group.rb
 - lib/mms/resource/host.rb
+- lib/mms/resource/metric.rb
 - lib/mms/resource/restore_job.rb
 - lib/mms/resource/snapshot.rb
 - lib/mms/resource/snapshot_schedule.rb