fluent-plugin-cmetrics 0.1.0.rc → 0.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a99953b806c28c73bf3e734c2419e3ce5df8974e6bdd12a93d0e0d51096ceb
-  data.tar.gz: bfe77f7b81c5f10ce5657bd5ea24b30c29f2ebd9b62fe5d10f82988d06f2e85c
+  metadata.gz: aa5328239515010bccb7710e1600b97fbfadf5674140056c4fda9434b65302e5
+  data.tar.gz: 2d0dd9208b1a9babc353fefa5cf2ffc4ae67b24b7aa18f63e402a76287198059
 SHA512:
-  metadata.gz: 82b2b4e6bcc4f95c02e4eabfe000f6010f8e2ee07a7b7491057e30d39fc2bb9cc85555a3f7c9da0a60a901f2faba10882694ee1c08e8bf928614140302b330a6
-  data.tar.gz: ab04d2523a2ed3bec53859b419b0ac77d25fd27dfbc7462fa7ece07bb8b63cd0f8889cd89d027414b9713f2f3f30caad8d9a96eb3e0015cd6a324dc19b062bee
+  metadata.gz: 6eafe5b8ab643ab1b0f7e55d06fe7d5385321bf8689e8ed5d953f7fde04953b33acdff7a691d19be120a236253ae170a75ebef878025e291d83dfd3ce6a01d70
+  data.tar.gz: 5141e4794e95a066b951da679fb44f09fc61bc415ed6d960b16cb23eb2dbf2fa10692ce9aa29e2195e1ca55e63c5c9885e74aaf80d37e817594d742c6d87749b

data/README.md

@@ -1,8 +1,6 @@
 # fluent-plugin-cmetrics
 
-[Fluentd](https://fluentd.org/) parser plugin to do something.
-
-TODO: write description for you plugin.
+[Fluentd](https://fluentd.org/) plugin for cmetrics format handling.
 
 ## Installation
 
@@ -26,15 +24,30 @@ And then execute:
 $ bundle
 ```
 
-## Configuration
+## Plugin helpers
 
-You can generate configuration template:
+* [record_accessor](https://docs.fluentd.org/v/1.0/plugin-helper-overview/api-plugin-helper-record_accessor)
 
-```
-$ fluent-plugin-config-format parser cmetrics
-```
+* See also: [Filter Plugin Overview](https://docs.fluentd.org/v/1.0/filter#overview)
+
+## Fluent::Plugin::CMetricsParserFilter
+
+### cmetric_metric_key (string) (optional)
+
+cmetrics metric key
+
+Default value: `cmetrics`.
+
+### cmetric_labels_key (string) (optional)
+
+cmetrics labels key
+
+Default value: `labels`.
+
+### format_name_key_for_splunk_metric (bool) (optional)
+
+format name key for Splunk metrics
 
-You can copy and paste generated documents here.
 
 ## Copyright
 

data/fluent-plugin-cmetrics.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-cmetrics"
-  spec.version = "0.1.0.rc"
+  spec.version = "0.1.0.rc2"
   spec.authors = ["Hiroshi Hatake"]
   spec.email   = ["cosmo0920.oucc@gmail.com"]
 

data/lib/fluent/plugin/filter_cmetrics_parser.rb

@@ -27,17 +27,32 @@ module Fluent
       helpers :record_accessor
 
       desc "cmetrics metric key"
-      config_param :cmetric_metric_key, :string, default: "cmetric"
+      config_param :cmetrics_metric_key, :string, default: "cmetrics"
       desc "cmetrics labels key"
-      config_param :cmetric_labels_key, :string, default: "labels"
+      config_param :cmetrics_labels_key, :string, default: "labels"
       desc "format name key for Splunk metrics"
       config_param :format_name_key_for_splunk_metric, :bool, default: false
 
       def configure(conf)
         super
         @serde = ::CMetrics::Serde.new
-        @record_accessor = record_accessor_create(@cmetric_metric_key)
-        @labels_accessor = record_accessor_create(@cmetric_labels_key)
+        @record_accessor = record_accessor_create(@cmetrics_metric_key)
+        @labels_accessor = record_accessor_create(@cmetrics_labels_key)
+      end
+
+      def format_record_key_to_splunk_style(inner)
+        subsystem = inner.delete("subsystem")
+        labels_str = if labels = @labels_accessor.call(inner)
+                       labels_str = labels.map {|k,v|
+                         if k == "cpu"
+                           "id_#{v}"
+                         else
+                           "#{k}_#{v}"
+                         end
+                       }.join("_")
+                     end
+        name = inner.delete("name")
+        [subsystem, labels_str, name].compact.reject{|e| e.empty?}.join("_")
       end
 
       def filter_stream(tag, es)
@@ -50,10 +65,8 @@ module Fluent
               next if metric.empty?
 
               metric.each do |inner|
-                if @format_name_key_for_splunk_metric && labels = @labels_accessor.call(inner)
-                  name = inner.delete("name")
-                  labels_str = labels.map {|k,v| "#{k}_#{v}"}.join("_")
-                  inner["name"] = "#{labels_str}_#{name}"
+                if @format_name_key_for_splunk_metric
+                  inner["name"] = format_record_key_to_splunk_style(inner)
                 end
                 time = Time.at(inner.delete("timestamp"))
                 new_es.add(Fluent::EventTime.new(time.to_i, time.nsec), inner)

data/test/helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
 require "test-unit"
 require "fluent/test"
-require "fluent/test/driver/parser"
+require "fluent/test/driver/filter"
 require "fluent/test/helpers"
 
 Test::Unit::TestCase.include(Fluent::Test::Helpers)

data/test/plugin/test_filter_cmetrics_parser.rb

@@ -6,8 +6,35 @@ class CmetricsParserTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  test "failure" do
-    flunk
+  data("cpu" => ['{"namespace":"node","subsystem":"cpu","labels":{"cpu":"10","mode":"system"},"name":"seconds_total","description":"Seconds the CPUs spent in each mode.","value":13153.09}', "cpu_id_10_mode_system_seconds_total"],
+       "filefd" => ['{"namespace":"node","subsystem":"filefd","name":"maximum","description":"File descriptor statistics: maximum.","value":9.223372036854776e+18}', "filefd_maximum"],
+       "disk" => ['{"namespace":"node","subsystem":"disk","labels":{"device":"nvme0n1"},"name":"io_now","description":"The number of I/Os currently in progress.","value":0.0}', "disk_device_nvme0n1_io_now"],
+       "network" => ['{"namespace":"node","subsystem":"network","labels":{"device":"eth0"},"name":"transmit_bytes_total","description":"Network device statistic bytes.","value":997193.0}', "network_device_eth0_transmit_bytes_total"],
+      "none" => ['{"namespace":"node","subsystem":"","name":"load5","description":"5m load average.","value":0.94}', "load5"])
+  test "#format_record_key_to_splunk_style" do |(json_str, expected_format_key)|
+    json = Yajl.load(json_str)
+    d = create_driver(%[format_name_key_for_splunk_metric true])
+    assert_true d.instance.format_name_key_for_splunk_metric
+    assert_equal expected_format_key, d.instance.format_record_key_to_splunk_style(json)
+  end
+
+  sub_test_case "Actual filtering" do
+    setup do
+      @binary_path = File.join(File.dirname(__dir__), "fixtures", "cmetrics.bin")
+      @binary = File.read(@binary_path)
+    end
+
+    test "#filter_stream" do
+      d = create_driver(%[format_name_key_for_splunk_metric true])
+      time = event_time("2012-01-02 13:14:15")
+      record = {"cmetrics" => @binary}
+      d.run(default_tag: 'test') do
+        d.feed(time, record)
+      end
+      assert do
+        d.filtered.size > 0
+      end
+    end
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-cmetrics
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc
+  version: 0.1.0.rc2
 platform: ruby
 authors:
 - Hiroshi Hatake
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - Rakefile
 - fluent-plugin-cmetrics.gemspec
 - lib/fluent/plugin/filter_cmetrics_parser.rb
+- test/fixtures/cmetrics.bin
 - test/helper.rb
 - test/plugin/test_filter_cmetrics_parser.rb
 homepage: https://github.com/calyptia/fluent-plugin-cmetrics
@@ -121,10 +122,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Fluentd plugin for cmetrics format handling.
 test_files:
+- test/fixtures/cmetrics.bin
 - test/helper.rb
 - test/plugin/test_filter_cmetrics_parser.rb