fluent-plugin-stackdriver-monitoring 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de841f30d9480113027498e115279a23d3c29a3f
-  data.tar.gz: 744a9b0c65955678fc31e9e2bbcbd64bc8cfb98c
+  metadata.gz: 0152a3a88115ba576c4fcc2deff4acfc308e96e8
+  data.tar.gz: 3caa5074ce36b5063bfd3645ca74ab4dbd230719
 SHA512:
-  metadata.gz: a693d1e6cd876314ac24ee014c1d15748e895b52e5150d0c0b9e55bbf7c4a9e688886b74b46923763ae569f97c966f6dc7036d5c96c620d11064ae5e04f99196
-  data.tar.gz: 18fb5725f580a0607ffed34dcd313110fc22bbec45e4c234960e03fdc7fa420f605d65401aa36d296a300e8a3f94310efc8b8c2054d3fa6de3091227f0245c72
+  metadata.gz: c26c808d1bfc6bab1310e91f6605d495ad02ce1e9343f4287447db306ceab75f16c3daa4d9e5fb1345e9a395e6f1208803f01091f49c8a0847775d02ccd30d3b
+  data.tar.gz: de8ad272f8fc05772a52e01cade86e08f7dc232158a96cc458636e235bbf18235f642fb0461e1df97eeca263e0e8c34f59497812b6a6f8c3a4d4030fb2771668

data/README.md

@@ -41,10 +41,15 @@ Sample configuration is below.
     - Set name of descriptor. It must start with `custom.googleapis.com/`.
   - metric_kind(enum, required)
     - See [metric kind](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind).
-    - You can specify `GAUGE`, `DELTA` or `CUMULATIVE`.
+    - You can specify `GAUGE` or `CUMULATIVE`.
+    - Custom metric does not support `DELTA`. See [here](https://cloud.google.com/monitoring/api/v3/metrics?hl=en#metric-kinds).
   - value_type(enum, required)
     - See [value type](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#valuetype).
-    - You can specify `BOOL`, `INT64`, `DOUBLE` or `STRING`.
+    - You can specify `BOOL`, `INT64` or `DOUBLE` if metric_kind is `GAUGE`. And `INT64` or `DOUBLE` can be specified if metric_kind is `CUMULATIVE`.
+    - Custom metric does not support `MONEY` and `STRING`. See [here](https://cloud.google.com/monitoring/api/v3/metrics?hl=en#metric-kinds).
+  - time_interval(time, optional)
+    - This param is used as the difference between start time and end time.
+    - It must be greater than 0s if metric_kind is set to `CUMULATIVE`.
 
 ## TODO
 

data/fluent-plugin-stackdriver-monitoring.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.license     = 'MIT'
   gem.homepage    = 'https://github.com/mia-0032/fluent-plugin-stackdriver-monitoring'
   gem.summary     = gem.description
-  gem.version     = '0.0.2'
+  gem.version     = '0.0.3'
   gem.authors     = ['Yoshihiro MIYAI']
   gem.email       = 'msparrow17@gmail.com'
   gem.has_rdoc    = false

data/lib/fluent/plugin/out_stackdriver_monitoring.rb

@@ -12,8 +12,9 @@ module Fluent
     config_section :custom_metrics, required: true, multi: false do
       config_param :key, :string
       config_param :type, :string
-      config_param :metric_kind, :enum, list: [:GAUGE, :DELTA, :CUMULATIVE]
-      config_param :value_type, :enum, list: [:BOOL, :INT64, :DOUBLE, :STRING] # todo: implement :DISTRIBUTION, :MONEY
+      config_param :metric_kind, :enum, list: [:GAUGE, :CUMULATIVE]
+      config_param :value_type, :enum, list: [:BOOL, :INT64, :DOUBLE] # todo: implement :DISTRIBUTION
+      config_param :time_interval, :time, default: 0
     end
 
     TYPE_PREFIX = 'custom.googleapis.com/'.freeze
@@ -21,8 +22,17 @@ module Fluent
     def configure(conf)
       super
 
-      unless @custom_metrics.type.start_with? TYPE_PREFIX
-        raise "custom_metrics.type must start with \"#{TYPE_PREFIX}\""
+      unless is_custom_metric? @custom_metrics.type
+        raise Fluent::ConfigError.new "custom_metrics.type must start with \"#{TYPE_PREFIX}\""
+      end
+
+      if @custom_metrics.metric_kind == :CUMULATIVE
+        if @custom_metrics.time_interval == 0
+          raise Fluent::ConfigError.new 'time_interval must be greater than 0 if metric_kind is set to CUMULATIVE'
+        end
+        if @custom_metrics.value_type == :BOOL
+          raise Fluent::ConfigError.new 'custom metric does not support BOOL value type if metric_kind is set to CUMULATIVE'
+        end
       end
 
       @project_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path @project
@@ -46,7 +56,7 @@ module Fluent
         value = record[@custom_metrics.key]
 
         point = Google::Monitoring::V3::Point.new
-        point.interval = create_time_interval time
+        point.interval = create_time_interval time, @custom_metrics.time_interval
         point.value = create_typed_value value
         time_series.points.push point
 
@@ -57,6 +67,10 @@ module Fluent
     end
 
     private
+    def is_custom_metric?(metric_type)
+      metric_type.start_with? TYPE_PREFIX
+    end
+
     def create_metric_descriptor
       begin
         metric_descriptor = @metric_service_client.get_metric_descriptor(@metric_name)
@@ -89,9 +103,9 @@ module Fluent
       time_series
     end
 
-    def create_time_interval(time)
+    def create_time_interval(time, interval)
       time_interval = Google::Monitoring::V3::TimeInterval.new
-      time_interval.start_time = Google::Protobuf::Timestamp.new seconds: time
+      time_interval.start_time = Google::Protobuf::Timestamp.new seconds: (time - interval)
       time_interval.end_time = Google::Protobuf::Timestamp.new seconds: time
 
       time_interval
@@ -101,13 +115,11 @@ module Fluent
       typed_value = Google::Monitoring::V3::TypedValue.new
       case @metric_descriptor.value_type
       when :BOOL
-        typed_value.bool_value = value.to_bool
+        typed_value.bool_value = !!value
       when :INT64
         typed_value.int64_value = value.to_i
       when :DOUBLE
         typed_value.double_value = value.to_f
-      when :STRING
-        typed_value.string_value = value.to_s
       else
         raise 'Unknown value_type!'
       end

data/test/plugin/test_out_stackdriver_monitoring.rb

@@ -0,0 +1,77 @@
+require_relative '../test_helper'
+
+class StackdriverMonitoringOutputTest < Test::Unit::TestCase
+  CONFIG = %[
+    project project-test
+    <custom_metrics>
+      key hoge_key
+      type custom.googleapis.com/hoge_type
+      metric_kind GAUGE
+      value_type INT64
+    </custom_metrics>
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::StackdriverMonitoringOutput).configure(conf)
+  end
+
+  setup do
+    Fluent::Test.setup
+  end
+
+  sub_test_case 'configure' do
+    test 'values are configured' do
+      d = create_driver
+
+      assert_equal('project-test', d.instance.project)
+      assert_equal('hoge_key', d.instance.custom_metrics.key)
+      assert_equal('custom.googleapis.com/hoge_type', d.instance.custom_metrics.type)
+      assert_equal(:GAUGE, d.instance.custom_metrics.metric_kind)
+      assert_equal(:INT64, d.instance.custom_metrics.value_type)
+      assert_equal(0, d.instance.custom_metrics.time_interval)
+    end
+
+    test 'custom_metrics.type must start with custom.googleapis.com' do
+      assert_raises Fluent::ConfigError do
+        create_driver(%[
+          project project-test
+          <custom_metrics>
+            key hoge_key
+            type invalid_type
+            metric_kind GAUGE
+            value_type INT64
+          </custom_metrics>
+        ])
+      end
+    end
+
+    test 'time_interval must be greater than 0 if metric_kind is set to CUMULATIVE' do
+      assert_raises Fluent::ConfigError do
+        create_driver(%[
+          project project-test
+          <custom_metrics>
+            key hoge_key
+            type invalid_type
+            metric_kind CUMULATIVE
+            value_type INT64
+            time_interval 0s
+          </custom_metrics>
+        ])
+      end
+    end
+
+    test 'custom metric does not support BOOL value type if metric_kind is set to CUMULATIVE' do
+      assert_raises Fluent::ConfigError do
+        create_driver(%[
+          project project-test
+          <custom_metrics>
+            key hoge_key
+            type invalid_type
+            metric_kind CUMULATIVE
+            value_type BOOL
+          </custom_metrics>
+        ])
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require "test/unit/rr"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_stackdriver_monitoring'
+
+class Test::Unit::TestCase
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-stackdriver-monitoring
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Yoshihiro MIYAI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-02 00:00:00.000000000 Z
+date: 2017-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -115,6 +115,8 @@ files:
 - Rakefile
 - fluent-plugin-stackdriver-monitoring.gemspec
 - lib/fluent/plugin/out_stackdriver_monitoring.rb
+- test/plugin/test_out_stackdriver_monitoring.rb
+- test/test_helper.rb
 homepage: https://github.com/mia-0032/fluent-plugin-stackdriver-monitoring
 licenses:
 - MIT
@@ -139,4 +141,6 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Stackdriver Monitoring custom metrics output plugin for Fluentd
-test_files: []
+test_files:
+- test/plugin/test_out_stackdriver_monitoring.rb
+- test/test_helper.rb