fluent-plugin-calyptia-monitoring 0.1.0.rc → 0.1.0.rc5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efc4e7d0b11c4581475feb8c18c52a7e4366d8ada239ae16db853dc36eb886fd
-  data.tar.gz: 5db76c13993681bab21c389ce6d5edf2c78e03b64540a409d4bc2791e26e6b29
+  metadata.gz: 45f4c392adfd8ddda9ee6c9387f0092472dec1a734274308de4ce6e325b5bc40
+  data.tar.gz: 0ba927c3eac167f867342ddfea86f885a2aa4c2f3ea099faa9dbad22fa4af9c1
 SHA512:
-  metadata.gz: e74b8aecb6b7b83dafcb999daabe7ebd64d607fb9352ca3dfa14161d612c2bf12a9c3fd6125979203d928f4b1d46676084f49c6299ce68e21f4f92fa2a73647f
-  data.tar.gz: 60137eaa0870327d7eb1c2485b04c0583558b375af3243ce3c11c94b6c70255d31cad86009d23e547f50dd578fd93b313a930575377c14b1cfdfcfeb01817c3f
+  metadata.gz: 3d147883bb7b483b9b141713e05e5c2ea63f8b69b7680acd0fa931e84c8c55028d6ba6a8a6876e898e1d72b9b3a446df1a5e2875f022c6d070a94f7c49930fa9
+  data.tar.gz: a9ccd6a159b2c6efdcf330cfa245b7b46b859bb5db476dc5e24e9dcecf9ee3a8439b7da28f0755176f1d52c42c7232230c9fca009e2032042a0b9cfcf28567db

data/README.md

@@ -1,8 +1,6 @@
 # fluent-plugin-calyptia-monitoring
 
-[Fluentd](https://fluentd.org/) input plugin to do something.
-
-TODO: write description for you plugin.
+[Fluentd](https://fluentd.org/) input plugin to ingest metrics into Calyptia Cloud.
 
 ## Installation
 
@@ -26,15 +24,65 @@ And then execute:
 $ bundle
 ```
 
-## Configuration
-
-You can generate configuration template:
-
+## Plugin helpers
+
+* [timer](https://docs.fluentd.org/v/1.0/plugin-helper-overview/api-plugin-helper-timer)
+* [storage](https://docs.fluentd.org/v/1.0/plugin-helper-overview/api-plugin-helper-storage)
+
+* See also: [Input Plugin Overview](https://docs.fluentd.org/v/1.0/input#overview)
+
+## Fluent::Plugin::CalyptiaMonitoringInput
+
+
+### \<cloud_monitoring\> section (required) (single)
+
+### Configuration
+
+|parameter|type|description|default|
+|---|---|---|---|
+|endpoint|string (optional)|The endpoint for Monitoring API HTTP request, e.g. http://example.com/api|`TBD`|
+|api_key|string (required)|The API KEY for Monitoring API HTTP request||
+|rate|time (optional)|Emit monitoring values interval. (minimum interval is 30 seconds.)|`30`|
+|pending_metrics_size|size (optional)|Setup pending metrics capacity size|`100`|
+
+### Example
+
+This plugin works well with [cmetrics Fluentd extension for metrics plugin](https://github.com/calyptia/fluent-plugin-metrics-cmetrics).
+
+And enabling RPC and configDump endpoint is required if sending Fluentd configuration:
+
+```aconf
+<system>
+# If users want to use multi workers feature which corresponds to logical number of CPUs, please comment out this line.
+#  workers "#{require 'etc'; Etc.nprocessors}"
+  enable_input_metrics true
+  # This record size measuring settings might impact for performance.
+  # Please be careful for high loaded environment to turn on.
+  enable_size_metrics true
+  <metrics>
+    @type cmetrics
+  </metrics>
+  rpc_endpoint 127.0.0.1:24444
+  enable_get_dump true
+</system>
+# And other configurations....
+
+## Fill YOUR_API_KEY with your Calyptia API KEY
+<source>
+  @type calyptia_monitoring
+  @id input_caplyptia_moniroting
+  <cloud_monitoring>
+    # endpoint http://development-environment-or-production.fqdn:5000
+    api_key YOUR_API_KEY
+    rate 30
+    pending_metrics_size 100 # Specify capacity for pending metrics
+  </cloud_monitoring>
+  <storage>
+    @type local
+    path /path/to/agent/accessible/directories/agent_states
+  </storage>
+</source>
 ```
-$ fluent-plugin-config-format input calyptia-monitoring
-```
-
-You can copy and paste generated documents here.
 
 ## Copyright
 

data/fluent-plugin-calyptia-monitoring.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-calyptia-monitoring"
-  spec.version = "0.1.0.rc"
+  spec.version = "0.1.0.rc5"
   spec.authors = ["Hiroshi Hatake"]
   spec.email   = ["hatake@calyptia.com"]
 
@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "test-unit", "~> 3.3"
   spec.add_runtime_dependency "fluentd", [">= 1.13.0", "< 2"]
-  spec.add_runtime_dependency "fluent-plugin-metrics-cmetrics", ">= 0.1.0.rc2"
+  spec.add_runtime_dependency "fluent-plugin-metrics-cmetrics", ">= 0.1.0.rc3"
 end

data/lib/fluent/plugin/calyptia_monitoring_ext.rb

@@ -19,9 +19,11 @@ module Fluent::Plugin
   class CalyptiaMonitoringExtInput < MonitorAgentInput
     CALYPTIA_PLUGIN_METRIC_INFO = {
       'emit_size' => ->(){
+        throw(:skip) if @emit_size_metrics.get.nil?
         @emit_size_metrics.cmetrics.to_msgpack
       },
       'emit_records' => ->(){
+        throw(:skip) if @emit_records_metrics.get.nil?
         @emit_records_metrics.cmetrics.to_msgpack
       },
       'retry_count' => ->(){

data/lib/fluent/plugin/calyptia_monitoring_machine_id.rb

@@ -53,7 +53,7 @@ module Fluent::Plugin
       require 'open3'
       o,_e, s = Open3.capture3 %q(ioreg -d2 -c IOPlatformExpertDevice | awk -F\" '/IOPlatformUUID/{print $(NF-1)}')
       unless s.success?
-        @log.warn "MachineID is not retrived from ioreg. Using UUID instead."
+        @log.info "MachineID is not retrived from ioreg. Using UUID instead."
         "#{SecureRandom.uuid}:#{@worker_id}"
       else
         # TODO: The prefix should be removed?
@@ -65,11 +65,11 @@ module Fluent::Plugin
       machine_id = ""
       begin
         machine_id = File.read(DBUS_MACHINE_ID_PATH).strip
-      rescue Errno::NOENT
+      rescue Errno::ENOENT
         machine_id = File.read(ETC_MACHINE_ID_PATH).strip rescue ""
       end
       if machine_id.empty?
-        @log.warn "MachineID is not retrived from #{DBUS_MACHINE_ID_PATH} or #{ETC_MACHINE_ID_PATH}. Using UUID instead."
+        @log.info "MachineID is not retrived from #{DBUS_MACHINE_ID_PATH} or #{ETC_MACHINE_ID_PATH}. Using UUID instead."
         "#{SecureRandom.uuid}:#{@worker_id}"
       else
         # TODO: The prefix should be removed?
@@ -85,7 +85,7 @@ module Fluent::Plugin
         machine_id = key.read("MachineGuid")[1] rescue ""
       end
       if machine_id.empty?
-        @log.warn "MachineID is not retrived from Registry. Using UUID instead."
+        @log.info "MachineID is not retrived from Registry. Using UUID instead."
         "#{SecureRandom.uuid}:#{@worker_id}"
       else
         # TODO: The prefix should be removed?

data/lib/fluent/plugin/in_calyptia_monitoring.rb

@@ -43,7 +43,7 @@ module Fluent
         400, # BadRequest
       ]
 
-      config_section :cloud_monitoring, multi: false do
+      config_section :cloud_monitoring, multi: false, required: true do
         desc 'The endpoint for Monitoring API HTTP request, e.g. http://example.com/api'
         config_param :endpoint, :string, default: "https://cloud-monitoring-api-dev.fluentbit.io"
         desc 'The API KEY for Monitoring API HTTP request'
@@ -222,8 +222,12 @@ module Fluent
             buffer += v
           end
         }
-        unless add_metrics(buffer)
-          log.warn "Sending metrics is failed. Trying to send pending buffers in the next interval: #{@cloud_monitoring.rate}, next sending time: #{Time.now + @cloud_monitoring.rate}"
+        if buffer.empty?
+          log.debug "No initialized metrics is found. Trying to send cmetrics on the next tick."
+        else
+          unless add_metrics(buffer)
+            log.warn "Sending metrics is failed. Trying to send pending buffers in the next interval: #{@cloud_monitoring.rate}, next sending time: #{Time.now + @cloud_monitoring.rate}"
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-calyptia-monitoring
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc
+  version: 0.1.0.rc5
 platform: ruby
 authors:
 - Hiroshi Hatake
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0.rc2
+        version: 0.1.0.rc3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0.rc2
+        version: 0.1.0.rc3
 description: Monitoring Fluentd via Calyptia Cloud
 email:
 - hatake@calyptia.com
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Monitoring Fluentd via Calyptia Cloud