azure-loganalytics-datacollector-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8452aaabdb1e4cadea593892598d3618d72d4dc268b73612a8072b98bb144a29
-  data.tar.gz: c095ecb8502f5afcc742e1cfa7da6c5b4d4f59522dab871323761a45ba6f4af3
+  metadata.gz: '0499f95d897bc46dae9b39636ac2dda0c9aa5750b70bc2703c0d3dc41bfa34f1'
+  data.tar.gz: 057401456546b8ac6b23e75bbc0e6c61a8a4c9ddb534f54508018011d3268d85
 SHA512:
-  metadata.gz: 710358fb3591f079e96ba0c4e26ba020ee5573dc3c27553883efa80dd62943a3dcde86c7e0dbb1d0ee5d1a20bdf28ea554be8fd2a7df64423088189492f07501
-  data.tar.gz: 523e5be5872c7450e8518835cf18e674043e5578e1b95588ea74070af40dce53418aaa455badeb2b156af9223e97228172bbb3af4e3ec8f4ea9ee2bef411eafd
+  metadata.gz: ed73c860640a73f1d0d0176e482361ebb30a082634410c44b7d540fc444b56e1a6548d1f81b43f10f5aef9967e1e8d17b63379c377250ed00b050157c29d4f79
+  data.tar.gz: 5bcb8d45153164a92ddeeaae37544d7722806c8726e2653d2f3fefa07e65f93f854e26e4e657cb9fef1d1d1c26d68d69daa963266b28cb62bfcaef1cbde42b29

data/ChangeLog.md

@@ -1,3 +1,9 @@
+## 0.4.0
+* restclient retries request on the following status code - [issue #10](https://github.com/yokawasa/azure-log-analytics-data-collector/issues/10)
+  * 429 - Too Many Requests
+  * 500 - Internal Server Error
+  * 503 -	Service Unavailable
+
 ## 0.3.0
 * Enhance log type validation: check not only alpha but also numeric, underscore, and character length (may not exceed 100) - [issue #11](https://github.com/yokawasa/azure-log-analytics-data-collector/issues/11)
 

data/README.md

@@ -3,6 +3,22 @@
 [Azure Log Analytics Data Collector API](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/data-collector-api) Client Libraries for Ruby. The repository was originally created for multiple programming languages, but it was refactored as a dedicated one for Ruby client. Python and PHP client libraries were moved to [azure-log-analytics-data-colloector-python](https://github.com/yokawasa/azure-log-analytics-data-collector-python) and [azure-log-analytics-data-colloector-php](https://github.com/yokawasa/azure-log-analytics-data-collector-php) respectively.
 
 
+## Retry policy
+
+The client internal leverage [rest-client] to send HTTP request to the API. The client library retries request using the rest-client on the following status code (which is [recommended action](https://docs.microsoft.com/en-us/azure/azure-monitor/platform/data-collector-api)).
+  * `429` - Too Many Requests
+  * `500` - Internal Server Error
+  * `503` -	Service Unavailable
+
+By default, the client library retres for a total of `3` times, sleeping `5 sec` between retries. The number of retries and sleeping time between retries can be changed with `set_retries` in the client class.
+
+```ruby
+  def set_retries(max_retries, retry_sleep_period)
+    @max_retries = max_retries
+    @retry_sleep_period = retry_sleep_period
+  end
+```
+
 ## Installation
 ```bash
 gem install azure-loganalytics-datacollector-api

data/lib/azure/loganalytics/datacollectorapi/client.rb

@@ -8,6 +8,9 @@ module Azure
 
       class Client
 
+        DEFAUT_MAX_RETRIES = 3.freeze
+        DEFAULT_RETRY_SLEEP_PERIOD = 5.freeze
+
         def initialize (customer_id, shared_key, endpoint ='ods.opinsights.azure.com')
           require 'rest-client'
           require 'json'
@@ -19,6 +22,9 @@ module Azure
           @shared_key = shared_key
           @endpoint = endpoint
           @default_azure_resource_id = ''
+
+          @max_retries = DEFAUT_MAX_RETRIES
+          @retry_sleep_period = DEFAULT_RETRY_SLEEP_PERIOD    
         end
 
         def post_data(log_type, json_records, record_timestamp ='', azure_resource_id ='' )
@@ -40,8 +46,21 @@ module Azure
               'time-generated-field' => record_timestamp
           }
 
-          res = RestClient.post( uri, body, headers)
-          res
+          retries = 0 
+          begin
+            res = RestClient.post( uri, body, headers)
+            res
+          rescue => e
+            c = e.response.code.to_i
+            if c == 429 || c == 500 || c==503
+              if retries < @max_retries
+                retries += 1
+                sleep(@retry_sleep_period)
+                retry 
+              end
+            end
+            raise e
+          end
         end
 
         def set_proxy(proxy='')
@@ -51,6 +70,11 @@ module Azure
         def set_default_azure_resoruce_id(azure_resource_id)
           @default_azure_resource_id = azure_resource_id
         end
+        
+        def set_retres(max_retries, retry_sleep_period)
+          @max_retries = max_retries
+          @retry_sleep_period = retry_sleep_period
+        end
 
         def self.is_success(res)
           return (res.code == 200) ? true : false

data/lib/azure/loganalytics/datacollectorapi/version.rb

@@ -1,7 +1,7 @@
 module Azure
   module Loganalytics
     module Datacollectorapi
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azure-loganalytics-datacollector-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Yoichi Kawasaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client