azure-loganalytics-datacollector-api 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6b8a3ab05139f664f5b86e7a9f08b7e5cb2f2adb6b638df9a9cef9328b23aed
-  data.tar.gz: eb5623f23e94faf5a79f7b595f3b9f5fe1b2dccacf75eb19e59c1c2a4b846800
+  metadata.gz: c4cec423d59632c9e791ddcc953fc3cfc9b6a22886d1a0fa32ff24611b7ee107
+  data.tar.gz: c8dcf1beb62710c24ef30d0b52f44b316c218efd1668999d0eb077707a2f9f6d
 SHA512:
-  metadata.gz: dad33a98f56baee3a6e16ed74683678168bafe62f55aef976c0818159be20affc99126aa1ef1c9369f935cc56342c43d19817f51b74e4f74c37475f5405c2ca1
-  data.tar.gz: 6d166eca78143d143cf3a4875dd9eeb5e4e7742ab8e889800e1f6501f17f21a9a3a5308c1b438f50557cd28f742f6b211fc36fd92c6d6b25a18606e9de8e3699
+  metadata.gz: 2a4343fa994ff46da725a6c03ef00c4973cddd5275d1afe93a8152e92026284e649b553002968d9c9e6d690ccbe06016a165eb42aeb7701d102aaa97e3ac00e8
+  data.tar.gz: 2adfe7e4cebe468be3c6bb548fec657ef6ed292a068376ca46a3b2cc27fa504ae3fd62d4a7c1acd64be801dc8da12ea107f4c394ad232246378fcca7b682c786

data/ChangeLog.md

@@ -1,3 +1,6 @@
+## 0.2.0
+* Support setting the x-ms-AzureResourceId Header - [issue #8](https://github.com/yokawasa/azure-log-analytics-data-collector/issues/8)
+
 ## 0.1.6
 * fix CVE-2020-8130 - [issue #7](https://github.com/yokawasa/azure-log-analytics-data-collector/issues/7)
 

data/README.md

@@ -1,5 +1,7 @@
 # azure-log-analytics-data-collector Ruby Client
-Azure Log Analytics Data Collector API Ruby Client
+
+[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.
+
 
 ## Installation
 ```bash
@@ -78,7 +80,51 @@ else
 end
 ```
 
-### Sample3 - use proxy to access the API
+### Sample3 - With time_generated_field and azure_resource_id option
+Supported setting azure_resource_id option from version [0.2.0](https://github.com/yokawasa/azure-log-analytics-data-collector/releases/tag/v0.2.0)
+```ruby
+require "azure/loganalytics/datacollectorapi/client"
+
+customer_id = '<Customer ID aka WorkspaceID String>'
+shared_key = '<The primary or the secondary Connected Sources client authentication key>'
+log_type = "MyCustomLog"
+
+posting_records = []
+record1= {
+  :string => "MyText1",
+  :boolean => true,
+  :number => 100,
+  :timegen => "2017-11-23T11:13:35.576Z" # YYYY-MM-DDThh:mm:ssZ
+}
+record2= {
+  :string => "MyText2",
+  :boolean => false,
+  :number => 200,
+  :timegen => "2017-11-23T12:13:35.576Z" # YYYY-MM-DDThh:mm:ssZ
+}
+posting_records.push(record1)
+posting_records.push(record2)
+
+time_generated_field = "timegen"
+
+# Azure Resource ID
+# [Azure Resource ID Format]
+# /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+azure_resource_id ="/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/otherResourceGroup/providers/Microsoft.Storage/storageAccounts/examplestorage"
+
+client=Azure::Loganalytics::Datacollectorapi::Client::new( customer_id, shared_key)
+res = client.post_data(log_type, posting_records, time_generated_field, azure_resource_id)
+puts res
+puts "res code=#{res.code}"
+
+if Azure::Loganalytics::Datacollectorapi::Client.is_success(res)
+  puts "operation was succeeded!"
+else
+  puts "operation was failured!"
+end
+```
+
+### Sample4 - use proxy to access the API
 ```ruby
 require "azure/loganalytics/datacollectorapi/client"
 
@@ -114,4 +160,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/yokawa
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/SampleCodes.md

@@ -0,0 +1,12 @@
+# Sample codes for azure-log-analytics-data-collector
+ [Azure Log Analytics HTTP Data Collecotr API](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api) Client libraries
+
+## Client libraries and Sample code
+
+| Language | Source Code | Project URL | 
+| ------------- | ------------- |------------- |
+| Ruby     | This repository | [Rubygem Package](https://rubygems.org/gems/azure-loganalytics-datacollector-api) |
+| Python     |  [Source code](https://github.com/yokawasa/azure-log-analytics-data-collector-python) | [Python Package](https://pypi.python.org/pypi/azure-log-analytics-data-collector-api) |
+| PHP     |  [Source code](https://github.com/yokawasa/azure-log-analytics-data-collector-php) | NONE |
+| CSharp   |  [Sample Code](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api#sample-requests) | NONE |
+| PowerShell  | [Sample Code](https://docs.microsoft.com/en-us/azure/log-analytics/log-analytics-data-collector-api#sample-requests) | NONE |

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

@@ -8,7 +8,7 @@ module Azure
 
       class Client
 
-        def initialize (customer_id, shared_key,endpoint ='ods.opinsights.azure.com')
+        def initialize (customer_id, shared_key, endpoint ='ods.opinsights.azure.com')
           require 'rest-client'
           require 'json'
           require 'openssl'
@@ -18,9 +18,10 @@ module Azure
           @customer_id = customer_id
           @shared_key = shared_key
           @endpoint = endpoint
+          @default_azure_resource_id = ''
         end
 
-        def post_data(log_type, json_records, record_timestamp ='')
+        def post_data(log_type, json_records, record_timestamp ='', azure_resource_id ='' )
           raise ConfigError, 'no log_type' if log_type.empty?
           raise ConfigError, 'log_type must be only alpha characters' if not is_alpha(log_type)
           raise ConfigError, 'no json_records' if json_records.empty?
@@ -35,6 +36,7 @@ module Azure
               'Authorization' => sig,
               'Log-Type' => log_type,
               'x-ms-date' => date,
+              'x-ms-AzureResourceId' => azure_resource_id.empty? ? @default_azure_resource_id : azure_resource_id,
               'time-generated-field' => record_timestamp
           }
 
@@ -45,6 +47,10 @@ module Azure
         def set_proxy(proxy='')
           RestClient.proxy = proxy.empty? ? ENV['http_proxy'] : proxy
         end
+        
+        def set_default_azure_resoruce_id(azure_resource_id)
+          @default_azure_resource_id = azure_resource_id
+        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.1.6"
+      VERSION = "0.2.0"
     end
   end
 end

data/spec/azure/loganalytics/datacollectorapi/client_spec.rb

@@ -9,11 +9,11 @@ describe Azure::Loganalytics::Datacollectorapi::Client do
   #  expect(false).to eq(true)
   #end
 
-  it "posting data to datacollector api" do
-    customer_id = '<Customer ID aka WorkspaceID String>'
-    shared_key =  '<Primary Key String>'
-    log_type = "MyCustomLog"
+  customer_id = '<Customer ID aka WorkspaceID String>'
+  shared_key =  '<Primary Key String>'
+  log_type = "MyCustomLog"
 
+  it "posting data to datacollector api" do
     json_records = []
     record1= {
       :string => "MyText1",
@@ -33,4 +33,53 @@ describe Azure::Loganalytics::Datacollectorapi::Client do
     expect(Azure::Loganalytics::Datacollectorapi::Client.is_success(res)).to eq(true)
   end
 
+  it "posting data to datacollector api with time-generated-field" do
+    json_records = []
+    record1= {
+      :string => "MyText1",
+      :boolean => true,
+      :number => 100,
+      :timegen => "2020-05-05T11:13:35.576Z" # YYYY-MM-DDThh:mm:ssZ
+    }
+    record2= {
+      :string => "MyText2",
+      :boolean => false,
+      :number => 200,
+      :timegen => "2020-05-05T12:13:35.576Z" # YYYY-MM-DDThh:mm:ssZ
+    }
+    json_records.push(record1)
+    json_records.push(record2)
+
+    time_generated_field = "timegen"
+    client=Azure::Loganalytics::Datacollectorapi::Client::new( customer_id, shared_key)
+    res = client.post_data(log_type, json_records, time_generated_field)
+    expect(Azure::Loganalytics::Datacollectorapi::Client.is_success(res)).to eq(true)
+  end
+
+  it "posting data to datacollector api with azure-resource-id" do
+    json_records = []
+    record1= {
+      :string => "MyText1",
+      :boolean => true,
+      :number => 100
+    }
+    record2= {
+      :string => "MyText2",
+      :boolean => false,
+      :number => 200
+    }
+    json_records.push(record1)
+    json_records.push(record2)
+
+    time_generated_field = ""
+    # Azure Resource ID
+    # https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/template-functions-resource#resourceid
+    # /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+    azure_resource_id ="/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/otherResourceGroup/providers/Microsoft.Storage/storageAccounts/examplestorage"
+
+    client=Azure::Loganalytics::Datacollectorapi::Client::new( customer_id, shared_key)
+    res = client.post_data(log_type, json_records, time_generated_field, azure_resource_id)
+    expect(Azure::Loganalytics::Datacollectorapi::Client.is_success(res)).to eq(true)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: azure-loganalytics-datacollector-api
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Yoichi Kawasaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-18 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -68,6 +68,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- SampleCodes.md
 - azure-loganalytics-datacollector-api.gemspec
 - bin/console
 - bin/setup
@@ -94,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Azure Log Analytics Data Collector API Ruby Client