fluent-plugin-prometheus 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64ed448a556ffbc5fda04297363a53663dc2acff960d358bb24b07e227b99b3a
-  data.tar.gz: 2ad3f13b35c60b0fad6664831e9d4edcacfcf963a3a819c658aad761bc64af2f
+  metadata.gz: 274c9ef3f67ca084c8b46d6a24ca97ce8313d2ade4409426dc2bb664ec227f31
+  data.tar.gz: 1c3cc72e17e834cf5144315086856bc8a8394a1a893771f7521e0a0fd4adf73f
 SHA512:
-  metadata.gz: cb6b43bf8e18dea2ff324a1a75738b51513c652ca3afdea8bf941f5d56e0b44028d19726daef5ee704070597e243e0c5262db1edaf6027adb3f1a2f6baf3c76a
-  data.tar.gz: 0dd07480d6a1a4db6345e14727f932b1c2ce09ce9683f01f4fe4c3e008c608742ef47a68aca27371f182dc1b8cd995420bef3a4d666abe6ff0ec6ed218513916
+  metadata.gz: 791e3bf0e513d98d32f0bb8a0f936e305f373ae2706fd9ad6bd3cdd12eb9adcd288d811ea3bcc9eb06c50b7eb583ec5edda3fb52751f7def52252c1174780407
+  data.tar.gz: 2aa16a95bedb91f4f04bac51a8fe96ee540aefe13532429d12803f97f0537e9fd3c10bb54a37c8145f8a58fe0e06e7975d7e99e1a8addb686eb12311ab9951c5

data/README.md

@@ -42,8 +42,8 @@ See [sample configuration](./misc/fluentd_sample.conf), or try [tutorial](#try-p
 
 ### prometheus input plugin
 
-You have to configure this plugin to expose metrics collected by other promtheus plugins.
-This plugin provides a metrics HTTP endpoint to be scraped by a prometheus server on 24231/tcp(default).
+You have to configure this plugin to expose metrics collected by other Prometheus plugins.
+This plugin provides a metrics HTTP endpoint to be scraped by a Prometheus server on 24231/tcp(default).
 
 With following configuration, you can access http://localhost:24231/metrics on a server where fluentd running.
 
@@ -56,7 +56,7 @@ With following configuration, you can access http://localhost:24231/metrics on a
 More configuration parameters:
 
 - `bind`: binding interface (default: '0.0.0.0')
-- `port`: listen port (defaut: 24231)
+- `port`: listen port (default: 24231)
 - `metrics_path`: metrics HTTP endpoint (default: /metrics)
 
 When using multiple workers, each worker binds to port + `fluent_worker_id`.
@@ -224,6 +224,8 @@ In output plugin style:
 
 With above configuration, the plugin collects a metric named `message_foo_counter` from key `foo` of each records.
 
+You can access nested keys 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 `$[`.
+
 See Supported Metric Type and Labels for more configuration parameters.
 
 ## Supported Metric Types
@@ -350,12 +352,12 @@ Reserved placeholders are:
 - `${hostname}`: hostname
 - `${worker_id}`: fluent worker id
 - `${tag}`: tag name
-  - only availabe in prometheus output/filter plugin
+  - only available in Prometheus output/filter plugin
 
 
 ### top-level labels and labels inside metric
 
-Prometheus output/filter plugin can have multiple metric section. Top-level labels section spcifies labels for all metrics. Labels section insede metric section specifis labels for the metric. Both are specified, labels are merged.
+Prometheus output/filter plugin can have multiple metric section. Top-level labels section specifies labels for all metrics. Labels section inside metric section specifies labels for the metric. Both are specified, labels are merged.
 
 ```
 <filter message>
@@ -399,7 +401,7 @@ $ cd fluent-plugin-prometheus
 $ bundle install --path vendor/bundle
 ```
 
-Download pre-compiled prometheus binary and start it. It listens on 9090.
+Download pre-compiled Prometheus binary and start it. It listens on 9090.
 
 ```
 $ wget https://github.com/prometheus/prometheus/releases/download/v1.5.2/prometheus-1.5.2.linux-amd64.tar.gz -O - | tar zxf -

data/fluent-plugin-prometheus.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-prometheus"
-  spec.version       = "1.2.1"
+  spec.version       = "1.3.0"
   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/prometheus.rb

@@ -36,6 +36,10 @@ module Fluent
         conf.elements.select { |element|
           element.name == 'metric'
         }.each { |element|
+          if element.has_key?('key') && (element['key'].start_with?('$.') || element['key'].start_with?('$['))
+            value = element['key']
+            element['key'] = PluginHelper::RecordAccessor::Accessor.new(value)
+          end
           case element['type']
           when 'summary'
             metrics << Fluent::Plugin::Prometheus::Summary.new(element, registry, labels)
@@ -147,8 +151,13 @@ module Fluent
         end
 
         def instrument(record, expander, placeholders)
-          if record[@key]
-            @gauge.set(labels(record, expander, placeholders), record[@key])
+          if @key.is_a?(String)
+            value = record[@key]
+          else
+            value = @key.call(record)
+          end
+          if value
+            @gauge.set(labels(record, expander, placeholders), value)
           end
         end
       end
@@ -165,7 +174,13 @@ module Fluent
 
         def instrument(record, expander, placeholders)
           # use record value of the key if key is specified, otherwise just increment
-          value = @key ? record[@key] : 1
+          if @key.nil?
+            value = 1
+          elsif @key.is_a?(String)
+            value = record[@key]
+          else
+            value = @key.call(record)
+          end
 
           # ignore if record value is nil
           return if value.nil?
@@ -189,8 +204,13 @@ module Fluent
         end
 
         def instrument(record, expander, placeholders)
-          if record[@key]
-            @summary.observe(labels(record, expander, placeholders), record[@key])
+          if @key.is_a?(String)
+            value = record[@key]
+          else
+            value = @key.call(record)
+          end
+          if value
+            @summary.observe(labels(record, expander, placeholders), value)
           end
         end
       end
@@ -217,8 +237,13 @@ module Fluent
         end
 
         def instrument(record, expander, placeholders)
-          if record[@key]
-            @histogram.observe(labels(record, expander, placeholders), record[@key])
+          if @key.is_a?(String)
+            value = record[@key]
+          else
+            value = @key.call(record)
+          end
+          if value
+            @histogram.observe(labels(record, expander, placeholders), value)
           end
         end
       end

data/spec/fluent/plugin/shared.rb

@@ -52,6 +52,24 @@ FULL_CONFIG = BASE_CONFIG + %[
       key foo4
     </labels>
   </metric>
+  <metric>
+    name full_accessor1
+    type summary
+    desc Something with accessor.
+    key $.foo
+    <labels>
+      key foo5
+    </labels>
+  </metric>
+  <metric>
+    name full_accessor2
+    type counter
+    desc Something with accessor.
+    key $.foo
+    <labels>
+      key foo6
+    </labels>
+  </metric>
   <labels>
     test_key test_value
   </labels>
@@ -110,6 +128,8 @@ shared_context 'full_config' do
   let(:gauge) { registry.get(:full_bar) }
   let(:summary) { registry.get(:full_baz) }
   let(:histogram) { registry.get(:full_qux) }
+  let(:summary_with_accessor) { registry.get(:full_accessor1) }
+  let(:counter_with_accessor) { registry.get(:full_accessor2) }
 end
 
 shared_context 'placeholder_config' do
@@ -192,15 +212,20 @@ shared_examples_for 'instruments record' do
       expect(registry.metrics.map(&:name)).to include(:full_foo)
       expect(registry.metrics.map(&:name)).to include(:full_bar)
       expect(registry.metrics.map(&:name)).to include(:full_baz)
+      expect(registry.metrics.map(&:name)).to include(:full_accessor1)
+      expect(registry.metrics.map(&:name)).to include(:full_accessor2)
       expect(counter).to be_kind_of(::Prometheus::Client::Metric)
       expect(gauge).to be_kind_of(::Prometheus::Client::Metric)
       expect(summary).to be_kind_of(::Prometheus::Client::Metric)
+      expect(summary_with_accessor).to be_kind_of(::Prometheus::Client::Metric)
+      expect(counter_with_accessor).to be_kind_of(::Prometheus::Client::Metric)
       expect(histogram).to be_kind_of(::Prometheus::Client::Metric)
     end
 
     it 'instruments counter metric' do
       expect(counter.type).to eq(:counter)
       expect(counter.get({test_key: 'test_value', key: 'foo1'})).to be_kind_of(Numeric)
+      expect(counter_with_accessor.get({test_key: 'test_value', key: 'foo6'})).to be_kind_of(Numeric)
     end
 
     it 'instruments gauge metric' do
@@ -212,6 +237,7 @@ shared_examples_for 'instruments record' do
       expect(summary.type).to eq(:summary)
       expect(summary.get({test_key: 'test_value', key: 'foo3'})).to be_kind_of(Hash)
       expect(summary.get({test_key: 'test_value', key: 'foo3'})[0.99]).to eq(100)
+      expect(summary_with_accessor.get({test_key: 'test_value', key: 'foo5'})[0.99]).to eq(100)
     end
 
     it 'instruments histogram metric' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-prometheus
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Masahiro Sano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-10 00:00:00.000000000 Z
+date: 2019-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd