fluent-plugin-prometheus 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: da342f3a63fc1bb0e727eb1910c7b13734600dd2
-  data.tar.gz: 46ec363b48352bad9e781695d7358172f06fb5c0
+SHA256:
+  metadata.gz: 64ed448a556ffbc5fda04297363a53663dc2acff960d358bb24b07e227b99b3a
+  data.tar.gz: 2ad3f13b35c60b0fad6664831e9d4edcacfcf963a3a819c658aad761bc64af2f
 SHA512:
-  metadata.gz: 771b4c6ee4ded81623869e6339b1f3ce56913a0042e82eeef210cba9825e3f0a5b6a2c071a884b7d4ad54e0689eaa4654f916cf797db4de7514dea21de2d2ee0
-  data.tar.gz: ca7cc8da3dd94f4b3976901f471cb1238813210109e0e05932f58991d353c8bd289ba2633144a1094f41ec14164ab3a04557a0f20ad0f6c07a5d99ad3f53553c
+  metadata.gz: cb6b43bf8e18dea2ff324a1a75738b51513c652ca3afdea8bf941f5d56e0b44028d19726daef5ee704070597e243e0c5262db1edaf6027adb3f1a2f6baf3c76a
+  data.tar.gz: 0dd07480d6a1a4db6345e14727f932b1c2ce09ce9683f01f4fe4c3e008c608742ef47a68aca27371f182dc1b8cd995420bef3a4d666abe6ff0ec6ed218513916

data/README.md

@@ -339,9 +339,11 @@ You can add labels with static value or dynamic value from records. In `promethe
 
 All labels sections has same format. Each lines have key/value for label.
 
-You can use placeholder for label values. The placeholders will be expanded from records or reserved values. If you specify `${foo}`, it will be expanded by value of `foo` in record.
+You can access nested fields in records via dot or bracket notation (https://docs.fluentd.org/v1.0/articles/api-plugin-helper-record_accessor#syntax), for example: `$.kubernetes.namespace`, `$['key1'][0]['key2']`. The record accessor is enable only if the value starts with `$.` or `$[`. Other values are handled as raw string as is and may be expanded by placeholder described later.
 
-You can access nested fields in records via dot or bracket notation (https://docs.fluentd.org/v1.0/articles/api-plugin-helper-record_accessor#syntax), for example: `$.kubernetes.namespace`.
+You can use placeholder for label values. The placeholders will be expanded from reserved values and records.
+If you specify `${hostname}`, it will be expanded by value of a hostname where fluentd runs.
+The placeholder for records is deprecated. Use record accessor syntax instead.
 
 Reserved placeholders are:
 

data/fluent-plugin-prometheus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-prometheus"
-  spec.version       = "1.2.0"
+  spec.version       = "1.2.1"
   spec.authors       = ["Masahiro Sano"]
   spec.email         = ["sabottenda@gmail.com"]
   spec.summary       = %q{A fluent plugin that collects metrics and exposes for Prometheus.}

data/lib/fluent/plugin/in_prometheus_monitor.rb

@@ -27,7 +27,9 @@ module Fluent::Plugin
       placeholders = expander.prepare_placeholders({'hostname' => hostname, 'worker_id' => fluentd_worker_id})
       @base_labels = Fluent::Plugin::Prometheus.parse_labels_elements(conf)
       @base_labels.each do |key, value|
-        @base_labels[key] = expander.expand(value, placeholders)
+        if value.is_a?(String)
+          @base_labels[key] = expander.expand(value, placeholders)
+        end
       end
 
       if defined?(Fluent::Plugin) && defined?(Fluent::Plugin::MonitorAgentInput)

data/lib/fluent/plugin/prometheus.rb

@@ -18,7 +18,13 @@ module Fluent
           labels.first.each do |key, value|
             labels.first.has_key?(key)
 
-            base_labels[key.to_sym] = PluginHelper::RecordAccessor::Accessor.new(value)
+            # use RecordAccessor only for $. and $[ syntax
+            # otherwise use the value as is or expand the value by RecordTransformer for ${} syntax
+            if value.start_with?('$.') || value.start_with?('$[')
+              base_labels[key.to_sym] = PluginHelper::RecordAccessor::Accessor.new(value)
+            else
+              base_labels[key.to_sym] = value
+            end
           end
         end
 
@@ -102,8 +108,11 @@ module Fluent
         def labels(record, expander, placeholders)
           label = {}
           @base_labels.each do |k, v|
-            accessor_value = v.call(record)
-            label[k] = accessor_value.nil? ? expander.expand(v.keys, placeholders) : accessor_value
+            if v.is_a?(String)
+              label[k] = expander.expand(v, placeholders)
+            else
+              label[k] = v.call(record)
+            end
           end
           label
         end

data/spec/fluent/plugin/in_prometheus_monitor_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'fluent/plugin/in_prometheus_monitor'
+require 'fluent/test/driver/input'
+
+describe Fluent::Plugin::PrometheusMonitorInput do
+  MONITOR_CONFIG = %[
+  @type prometheus_monitor
+  <labels>
+    host ${hostname}
+    foo bar
+    no_effect1 $.foo.bar
+    no_effect2 $[0][1]
+  </labels>
+]
+
+  let(:config) { MONITOR_CONFIG }
+  let(:port) { 24231 }
+  let(:driver) { Fluent::Test::Driver::Input.new(Fluent::Plugin::PrometheusMonitorInput).configure(config) }
+
+  describe '#configure' do
+    it 'does not raise error' do
+      expect{driver}.not_to raise_error
+    end
+  end
+end

data/spec/fluent/plugin/shared.rb

@@ -73,6 +73,18 @@ PLACEHOLDER_CONFIG = BASE_CONFIG + %[
   </labels>
 ]
 
+ACCESSOR_CONFIG = BASE_CONFIG + %[
+  <metric>
+    name accessor_foo
+    type counter
+    desc Something foo.
+    key foo
+    <labels>
+      foo $.foo
+    </labels>
+  </metric>
+]
+
 COUNTER_WITHOUT_KEY_CONFIG = BASE_CONFIG + %[
   <metric>
     name without_key_foo
@@ -107,6 +119,13 @@ shared_context 'placeholder_config' do
   let(:counter) { registry.get(name) }
 end
 
+shared_context 'accessor_config' do
+  let(:orig_name) { 'accessor_foo' }
+  let(:config) { ACCESSOR_CONFIG.gsub(orig_name, name.to_s) }
+  let(:name) { "#{orig_name}_#{gen_time_suffix}".to_sym }
+  let(:counter) { registry.get(name) }
+end
+
 shared_context 'counter_without_key_config' do
   let(:orig_name) { 'without_key_foo' }
   let(:config) { COUNTER_WITHOUT_KEY_CONFIG.gsub(orig_name, name.to_s) }
@@ -137,6 +156,11 @@ shared_examples_for 'output configuration' do
     it { expect{driver}.not_to raise_error }
   end
 
+  describe 'configure accessor configuration' do
+    include_context 'accessor_config'
+    it { expect{driver}.not_to raise_error }
+  end
+
   describe 'configure counter without key configuration' do
     include_context 'counter_without_key_config'
     it { expect{driver}.not_to raise_error }
@@ -217,6 +241,22 @@ shared_examples_for 'instruments record' do
     end
   end
 
+  context 'accessor config' do
+    include_context 'accessor_config'
+
+    before :each do
+      es
+    end
+
+    it 'expands accessor with record values' do
+      expect(registry.metrics.map(&:name)).to include(name)
+      expect(counter).to be_kind_of(::Prometheus::Client::Metric)
+      key, _ = counter.values.find {|k,v| v ==  100 }
+      expect(key).to be_kind_of(Hash)
+      expect(key[:foo]).to eq(100)
+    end
+  end
+
   context 'counter_without config' do
     include_context 'counter_without_key_config'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-prometheus
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Masahiro Sano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-01 00:00:00.000000000 Z
+date: 2018-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -127,6 +127,7 @@ files:
 - misc/prometheus.yaml
 - misc/prometheus_alerts.yaml
 - spec/fluent/plugin/filter_prometheus_spec.rb
+- spec/fluent/plugin/in_prometheus_monitor_spec.rb
 - spec/fluent/plugin/out_prometheus_spec.rb
 - spec/fluent/plugin/prometheus_spec.rb
 - spec/fluent/plugin/shared.rb
@@ -151,12 +152,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A fluent plugin that collects metrics and exposes for Prometheus.
 test_files:
 - spec/fluent/plugin/filter_prometheus_spec.rb
+- spec/fluent/plugin/in_prometheus_monitor_spec.rb
 - spec/fluent/plugin/out_prometheus_spec.rb
 - spec/fluent/plugin/prometheus_spec.rb
 - spec/fluent/plugin/shared.rb