fluent-plugin-prometheus 2.2.1 → 2.3.0

data/spec/fluent/plugin/shared.rb

@@ -289,7 +289,12 @@ end
 
 shared_examples_for 'instruments record' do
   before do
-    driver.run(default_tag: tag) { driver.feed(event_time, message) }
+    # Should not shut down driver because it will be used in subsequent tests.
+    driver.run(default_tag: tag, shutdown: false) { driver.feed(event_time, message) }
+  end
+
+  after do
+    driver.instance_shutdown
   end
 
   context 'full config' do
@@ -385,6 +390,113 @@ shared_examples_for 'instruments record' do
   end
 end
 
+shared_examples_for 'limits label expansion' do
+  # the limit is enforced by the shared Metric class, but each plugin reaches
+  # it through its own path (instrument_single vs instrument), so both are run
+  # against these examples
+  def limited_config(options)
+    BASE_CONFIG + options + %[
+      <metric>
+        name limited
+        type counter
+        desc Something foo.
+        key foo
+        <labels>
+          path $.path
+        </labels>
+      </metric>
+    ]
+  end
+
+  def drop_logs
+    driver.logs.select { |log| log.include?('dropped a label set') }
+  end
+
+  def dropped_label_sets
+    registry.metrics.find { |metric| metric.name == :fluentd_prometheus_dropped_label_sets_total }
+  end
+
+  let(:counter) { registry.get(:limited) }
+
+  context 'without any limit configured' do
+    let(:config) { limited_config('') }
+
+    it 'is unlimited by default' do
+      expect(driver.instance.max_series_per_metric).to eq(0)
+    end
+
+    it 'keeps every label set' do
+      driver.run(default_tag: tag) do
+        driver.feed(event_time, {'foo' => 1, 'path' => '/a'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/b'})
+      end
+
+      expect(counter.values.keys).to eq([{path: '/a'}, {path: '/b'}])
+      expect(drop_logs).to be_empty
+      # nothing was dropped, so the counter is not even registered
+      expect(dropped_label_sets).to be_nil
+    end
+  end
+
+  context 'with max_series_per_metric' do
+    let(:config) { limited_config(%[max_series_per_metric 1\n]) }
+
+    it 'drops a new label set once the limit is reached' do
+      driver.run(default_tag: tag) do
+        driver.feed(event_time, {'foo' => 1, 'path' => '/a'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/b'})
+      end
+
+      expect(counter.values.keys).to eq([{path: '/a'}])
+    end
+
+    it 'keeps instrumenting a known label set after the limit is reached' do
+      driver.run(default_tag: tag) do
+        driver.feed(event_time, {'foo' => 1, 'path' => '/a'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/b'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/a'})
+      end
+
+      expect(counter.get(labels: {path: '/a'})).to eq(2)
+    end
+
+    it 'does not consume the limit by a label set which failed to be instrumented' do
+      driver.run(default_tag: tag) do
+        # a non numeric value is refused before the label set is reserved
+        driver.feed(event_time, {'foo' => 'not a number', 'path' => '/a'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/b'})
+      end
+
+      expect(driver.error_events.size).to eq(1)
+      expect(counter.values.keys).to eq([{path: '/b'}])
+      expect(drop_logs).to be_empty
+    end
+
+    it 'counts every dropped record, while the log is throttled' do
+      driver.run(default_tag: tag) do
+        driver.feed(event_time, {'foo' => 1, 'path' => '/a'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/b'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/c'})
+      end
+
+      expect(dropped_label_sets.values).to eq({{name: 'limited'} => 2.0})
+      expect(drop_logs.size).to eq(1)
+    end
+
+    # the same label set is refused again and again, and each record which
+    # brought it is lost
+    it 'counts a label set which is dropped more than once every time' do
+      driver.run(default_tag: tag) do
+        driver.feed(event_time, {'foo' => 1, 'path' => '/a'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/b'})
+        driver.feed(event_time, {'foo' => 1, 'path' => '/b'})
+      end
+
+      expect(dropped_label_sets.values).to eq({{name: 'limited'} => 2.0})
+    end
+  end
+end
+
 shared_examples_for 'initalized metrics' do
   before do
     driver.run(default_tag: tag)

data/spec/spec_helper.rb

@@ -8,3 +8,21 @@ Test::Unit::AutoRunner.need_auto_run = false
 
 Fluent::Test.setup
 include Fluent::Test::Helpers
+
+def ipv6_enabled?
+  require 'socket'
+
+  begin
+    # Try to actually bind to an IPv6 address to verify it works
+    sock = Socket.new(Socket::AF_INET6, Socket::SOCK_STREAM, 0)
+    sock.bind(Socket.sockaddr_in(0, '::1'))
+    sock.close
+    
+    # Also test that we can resolve IPv6 addresses
+    # This is needed because some systems can bind but can't connect
+    Socket.getaddrinfo('::1', nil, Socket::AF_INET6)
+    true
+  rescue Errno::EADDRNOTAVAIL, Errno::EAFNOSUPPORT, SocketError
+    false
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-prometheus
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Masahiro Sano
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -107,7 +106,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.yaml"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.yaml"
 - ".github/dependabot.yml"
+- ".github/workflows/add-to-project.yml"
 - ".github/workflows/linux.yml"
 - ".gitignore"
 - ".rspec"
@@ -125,6 +128,7 @@ files:
 - lib/fluent/plugin/in_prometheus_tail_monitor.rb
 - lib/fluent/plugin/out_prometheus.rb
 - lib/fluent/plugin/prometheus.rb
+- lib/fluent/plugin/prometheus/log_throttle.rb
 - lib/fluent/plugin/prometheus/placeholder_expander.rb
 - lib/fluent/plugin/prometheus_metrics.rb
 - misc/fluentd_sample.conf
@@ -136,7 +140,9 @@ files:
 - spec/fluent/plugin/in_prometheus_spec.rb
 - spec/fluent/plugin/in_prometheus_tail_monitor_spec.rb
 - spec/fluent/plugin/out_prometheus_spec.rb
+- spec/fluent/plugin/prometheus/log_throttle_spec.rb
 - spec/fluent/plugin/prometheus/placeholder_expander_spec.rb
+- spec/fluent/plugin/prometheus/series_limit_spec.rb
 - spec/fluent/plugin/prometheus_metrics_spec.rb
 - spec/fluent/plugin/shared.rb
 - spec/spec_helper.rb
@@ -144,7 +150,6 @@ homepage: https://github.com/fluent/fluent-plugin-prometheus
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -159,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A fluent plugin that collects metrics and exposes for Prometheus.
 test_files:
@@ -169,7 +173,9 @@ test_files:
 - spec/fluent/plugin/in_prometheus_spec.rb
 - spec/fluent/plugin/in_prometheus_tail_monitor_spec.rb
 - spec/fluent/plugin/out_prometheus_spec.rb
+- spec/fluent/plugin/prometheus/log_throttle_spec.rb
 - spec/fluent/plugin/prometheus/placeholder_expander_spec.rb
+- spec/fluent/plugin/prometheus/series_limit_spec.rb
 - spec/fluent/plugin/prometheus_metrics_spec.rb
 - spec/fluent/plugin/shared.rb
 - spec/spec_helper.rb