fluent-plugin-prometheus 2.0.0 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3250eed2a2f1156410b9e67005f7e23fdb822111dd780690ce61ee4967db7cf
-  data.tar.gz: dd1d3aa0defd1ac16f7d4e6e75dd7b6b7c9caff11f9e16288dc9b787d8f3ef9e
+  metadata.gz: 21b4b3d81d41fadb057a133293f2629b39961faaadcb7caebbd885c10ed344d1
+  data.tar.gz: dbd8aa719306aa164f373c781f568b82bee27fc44bfc88e86c4ea5d31c5ce545
 SHA512:
-  metadata.gz: ed531d2e8e383f54f3ff68c695cb63c0a2922a17ced661a109e50c50546a571aeb45747cba079274b451f41bdd506737d43c035140e28db7e5a427a83a1126b9
-  data.tar.gz: 7fab4fb99f73a770f0a87d88341078f089e78fd865ba28aba4634d04dfa5b5baa7ab8e7b1942fdc5ef96f6306ef379d7da2335bc7856ea150cb69c8749635f94
+  metadata.gz: ca73efb455416a5e7c022793c17ae088cd685f5751e3497a501f9af880a5f9e970dd838c939d3b61e9145c92e2a0d3acff3d61fbde35a88c7f29e52b148de5c4
+  data.tar.gz: 9feaab5d5b45e6e9cb1bd48ea3bc47381db6c9cc806e4782fab18df21b093f4034ca8215202e32f64cd776ea695a385f195b3b02ab22679e8b3c01b97b2bd27c

data/.github/workflows/linux.yml

@@ -1,16 +1,24 @@
 name: linux
 on:
-  - push
-  - pull_request
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
 jobs:
   build:
     runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+        ruby: [ '3.1', '3.0', '2.7', '2.6' ]
         os:
           - ubuntu-latest
+        experimental: [false]
+        include:
+          - ruby: head
+            os: ubuntu-latest
+            experimental: true
     name: Ruby ${{ matrix.ruby }} unit testing on ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2

data/ChangeLog

@@ -1,3 +1,15 @@
+Release 2.0.3 - 2022/05/06
+
+	* in_prometheus_output_monitor: Fix a bug where output_status_num_errors metric is missing
+
+Release 2.0.2 - 2021/08/02
+
+	* in_prometheus_output_monitor: Follow Fluentd's core metrics mechanism
+
+Release 2.0.1 - 2021/04/08
+
+	* out_prometheus: Allow for lookup by symbol as well as string
+
 Release 2.0.0 - 2021/02/18
 
 	* Update prometheus-client dependency to 2.1.0 or later

data/fluent-plugin-prometheus.gemspec

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

@@ -133,18 +133,26 @@ module Fluent::Plugin
 
       monitor_info = {
         # buffer metrics
-        'buffer_total_queued_size' => @metrics[:buffer_total_queued_size],
-        'buffer_stage_length' => @metrics[:buffer_stage_length],
-        'buffer_stage_byte_size' => @metrics[:buffer_stage_byte_size],
-        'buffer_queue_length' => @metrics[:buffer_queue_length],
-        'buffer_queue_byte_size' => @metrics[:buffer_queue_byte_size],
-        'buffer_available_buffer_space_ratios' => @metrics[:buffer_available_buffer_space_ratios],
-        'buffer_newest_timekey' => @metrics[:buffer_newest_timekey],
-        'buffer_oldest_timekey' => @metrics[:buffer_oldest_timekey],
+        'buffer_total_queued_size' => [@metrics[:buffer_total_queued_size]],
+        'buffer_stage_length' => [@metrics[:buffer_stage_length]],
+        'buffer_stage_byte_size' => [@metrics[:buffer_stage_byte_size]],
+        'buffer_queue_length' => [@metrics[:buffer_queue_length]],
+        'buffer_queue_byte_size' => [@metrics[:buffer_queue_byte_size]],
+        'buffer_available_buffer_space_ratios' => [@metrics[:buffer_available_buffer_space_ratios]],
+        'buffer_newest_timekey' => [@metrics[:buffer_newest_timekey]],
+        'buffer_oldest_timekey' => [@metrics[:buffer_oldest_timekey]],
 
         # output metrics
-        'retry_count' => @metrics[:retry_counts],
+        'retry_count' => [@metrics[:retry_counts], @metrics[:num_errors]],
+        # Needed since Fluentd v1.14 due to metrics extensions.
+        'write_count' => [@metrics[:write_count]],
+        'emit_count' => [@metrics[:emit_count]],
+        'emit_records' => [@metrics[:emit_records]],
+        'rollback_count' => [@metrics[:rollback_count]],
+        'flush_time_count' => [@metrics[:flush_time_count]],
+        'slow_flush_count' => [@metrics[:slow_flush_count]],
       }
+      # No needed for Fluentd v1.14 but leave as-is for backward compatibility.
       instance_vars_info = {
         num_errors: @metrics[:num_errors],
         write_count: @metrics[:write_count],
@@ -158,12 +166,14 @@ module Fluent::Plugin
       agent_info.each do |info|
         label = labels(info)
 
-        monitor_info.each do |name, metric|
-          if info[name]
-            if metric.is_a?(::Prometheus::Client::Gauge)
-              metric.set(info[name], labels: label)
-            elsif metric.is_a?(::Prometheus::Client::Counter)
-              metric.increment(by: info[name] - metric.get(labels: label), labels: label)
+        monitor_info.each do |name, metrics|
+          metrics.each do |metric|
+            if info[name]
+              if metric.is_a?(::Prometheus::Client::Gauge)
+                metric.set(info[name], labels: label)
+              elsif metric.is_a?(::Prometheus::Client::Counter)
+                metric.increment(by: info[name] - metric.get(labels: label), labels: label)
+              end
             end
           end
         end

data/lib/fluent/plugin/prometheus.rb

@@ -85,6 +85,18 @@ module Fluent
         Fluent::Plugin::Prometheus::ExpandBuilder.new(log: log)
       end
 
+      def stringify_keys(hash_to_stringify)
+        # Adapted from: https://www.jvt.me/posts/2019/09/07/ruby-hash-keys-string-symbol/
+        hash_to_stringify.map do |k,v|
+          value_or_hash = if v.instance_of? Hash
+                            stringify_keys(v)
+                          else
+                            v
+                          end
+          [k.to_s, value_or_hash]
+        end.to_h
+      end
+
       def configure(conf)
         super
         @placeholder_values = {}
@@ -99,6 +111,7 @@ module Fluent
           'worker_id' => fluentd_worker_id,
         }
 
+        record = stringify_keys(record)
         placeholders = record.merge(@placeholder_values[tag])
         expander = @placeholder_expander_builder.build(placeholders)
         metrics.each do |metric|
@@ -119,6 +132,7 @@ module Fluent
         }
 
         es.each do |time, record|
+          record = stringify_keys(record)
           placeholders = record.merge(placeholder_values)
           expander = @placeholder_expander_builder.build(placeholders)
           metrics.each do |metric|

data/spec/fluent/plugin/out_prometheus_spec.rb

@@ -40,4 +40,29 @@ describe Fluent::Plugin::PrometheusOutput do
 
     it_behaves_like 'instruments record'
   end
+
+  describe '#run with symbolized keys' do
+    let(:message) { {:foo => 100, :bar => 100, :baz => 100, :qux => 10} }
+
+    context 'simple config' do
+      let(:config) {
+        BASE_CONFIG + %(
+          <metric>
+            name simple
+            type counter
+            desc Something foo.
+            key foo
+          </metric>
+        )
+      }
+
+      it 'adds a new counter metric' do
+        expect(registry.metrics.map(&:name)).not_to eq([:simple])
+        driver.run(default_tag: tag) { driver.feed(event_time, message) }
+        expect(registry.metrics.map(&:name)).to eq([:simple])
+      end
+    end
+
+    it_behaves_like 'instruments record'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-prometheus
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.3
 platform: ruby
 authors:
 - Masahiro Sano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2022-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: A fluent plugin that collects metrics and exposes for Prometheus.