fluent-plugin-prometheus 2.0.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21b4b3d81d41fadb057a133293f2629b39961faaadcb7caebbd885c10ed344d1
-  data.tar.gz: dbd8aa719306aa164f373c781f568b82bee27fc44bfc88e86c4ea5d31c5ce545
+  metadata.gz: c42edc59b51fa5a911f51e5c174f71dc573c99068379d3ee8ba7d2d710dbcbb5
+  data.tar.gz: 32206e06e3c6a6a9b19f6b93583af0c416ae76dc707a1a2dbefe0b54975a936b
 SHA512:
-  metadata.gz: ca73efb455416a5e7c022793c17ae088cd685f5751e3497a501f9af880a5f9e970dd838c939d3b61e9145c92e2a0d3acff3d61fbde35a88c7f29e52b148de5c4
-  data.tar.gz: 9feaab5d5b45e6e9cb1bd48ea3bc47381db6c9cc806e4782fab18df21b093f4034ca8215202e32f64cd776ea695a385f195b3b02ab22679e8b3c01b97b2bd27c
+  metadata.gz: 178009b03c28bf7dde6207cbf7f99c1bcdd8e787669630646f937eed5249b8d8fc17443ec08777620caafbc2498ceb13d753db45aea0a86d9b309a396078bf44
+  data.tar.gz: 3051330dbb989c965054f6171f9db9c00775d5642d7d4210da909c2501cca7c66a68b5e319385e81d579a0cdf389d7362873e95b6d5f4bc3fe84ed1004d70071

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/linux.yml

@@ -11,17 +11,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.1', '3.0', '2.7', '2.6' ]
+        ruby: [ '3.3', '3.2', '3.1', '3.0', '2.7' ]
         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
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -29,6 +25,5 @@ jobs:
       env:
         CI: true
       run: |
-        gem install bundler rake
         bundle install --jobs 4 --retry 3
         bundle exec rake spec

data/ChangeLog

@@ -1,3 +1,12 @@
+Release 2.2.0 - 2024/08/02
+
+	* in_prometheus: Add gzip support (Add a new parameter `content_encoding gzip`)
+
+Release 2.1.0 - 2023/06/15
+
+	* Add `initialized` and `initlabels` parameters to `<metric>` element
+	* in_prometheus_tail_monitor: Add file open/closed/rotation metrics
+
 Release 2.0.3 - 2022/05/06
 
 	* in_prometheus_output_monitor: Fix a bug where output_status_num_errors metric is missing

data/README.md

@@ -63,6 +63,7 @@ More configuration parameters:
 - `port`: listen port (default: 24231)
 - `metrics_path`: metrics HTTP endpoint (default: /metrics)
 - `aggregated_metrics_path`: metrics HTTP endpoint (default: /aggregated_metrics)
+- `content_encoding`: encoding format for the exposed metrics (default: identity). Supported formats are {identity, gzip}
 
 When using multiple workers, each worker binds to port + `fluent_worker_id`.
 To scrape metrics from all workers at once, you can access http://localhost:24231/aggregated_metrics.
@@ -162,10 +163,11 @@ This plugin uses internal class of Fluentd, so it's easy to break.
 
 #### Exposed metrics
 
-- `fluentd_tail_file_position`
-    - Current bytes which plugin reads from the file
-- `fluentd_tail_file_inode`
-    - inode of the file
+- `fluentd_tail_file_position`: Current bytes which plugin reads from the file
+- `fluentd_tail_file_inode`: inode of the file
+- `fluentd_tail_file_closed`: Number of closed files
+- `fluentd_tail_file_opened`: Number of opened files
+- `fluentd_tail_file_rotated`: Number of rotated files
 
 Default labels:
 
@@ -286,7 +288,9 @@ For details of each metric type, see [Prometheus documentation](http://prometheu
 - `type`: metric type (required)
 - `desc`: description of this metric (required)
 - `key`: key name of record for instrumentation (**optional**)
+- `initialized`: boolean controlling initilization of metric (**optional**). See [Metric initialization](#metric-initialization)
 - `<labels>`: additional labels for this metric (optional). See [Labels](#labels)
+- `<initlabels>`: labels to use for initialization of ReccordAccessors/Placeholder labels (**optional**). See [Metric initialization](#metric-initialization)
 
 If key is empty, the metric values is treated as 1, so the counter increments by 1 on each record regardless of contents of the record.
 
@@ -310,7 +314,9 @@ If key is empty, the metric values is treated as 1, so the counter increments by
 - `type`: metric type (required)
 - `desc`: description of metric (required)
 - `key`: key name of record for instrumentation (required)
+- `initialized`: boolean controlling initilization of metric (**optional**). See [Metric initialization](#metric-initialization)
 - `<labels>`: additional labels for this metric (optional). See [Labels](#labels)
+- `<initlabels>`: labels to use for initialization of ReccordAccessors/Placeholder labels (**optional**). See [Metric initialization](#metric-initialization)
 
 ### summary type
 
@@ -332,7 +338,9 @@ If key is empty, the metric values is treated as 1, so the counter increments by
 - `type`: metric type (required)
 - `desc`: description of metric (required)
 - `key`: key name of record for instrumentation (required)
+- `initialized`: boolean controlling initilization of metric (**optional**). See [Metric initialization](#metric-initialization)
 - `<labels>`: additional labels for this metric (optional). See [Labels](#labels)
+- `<initlabels>`: labels to use for initialization of ReccordAccessors/Placeholder labels (**optional**). See [Metric initialization](#metric-initialization)
 
 ### histogram type
 
@@ -355,8 +363,10 @@ If key is empty, the metric values is treated as 1, so the counter increments by
 - `type`: metric type (required)
 - `desc`: description of metric (required)
 - `key`: key name of record for instrumentation (required)
+- `initialized`: boolean controlling initilization of metric (**optional**). See [Metric initialization](#metric-initialization)
 - `buckets`: buckets of record for instrumentation (optional)
 - `<labels>`: additional labels for this metric (optional). See [Labels](#labels)
+- `<initlabels>`: labels to use for initialization of ReccordAccessors/Placeholder labels (**optional**). See [Metric initialization](#metric-initialization)
 
 ## Labels
 
@@ -395,6 +405,53 @@ Reserved placeholders are:
   - where `tagsize` is the size of tag which is splitted with `.` (when tag is `1.2.3`, then `tagsize` is 3)
   - only available in Prometheus output/filter plugin
 
+### Metric initialization
+
+You can configure if a metric should be initialized to its zero value before receiving any event. To do so you just need to specify `initialized true`.
+
+```
+<metric>
+  name message_bar_counter
+  type counter
+  desc The total number of bar in message.
+  key bar
+  initialized true
+  <labels>
+    foo bar
+  </labels>
+</metric>
+```
+
+If your labels contains ReccordAccessors or Placeholders, you must use `<initlabels>` to specify the values your ReccordAccessors/Placeholders will take. This feature is useful only if your Placeholders/ReccordAccessors contain deterministic values. Initialization will create as many zero value metrics as `<initlabels>` blocks you defined.
+Potential reserved placeholders `${hostname}` and `${worker_id}`, as well as static labels, are automatically added and should not be specified in `<initlabels>` configuration.
+
+```
+<metric>
+  name message_bar_counter
+  type counter
+  desc The total number of bar in message.
+  key bar
+  initialized true
+  <labels>
+    key $.foo
+    tag ${tag}
+    foo bar
+    worker_id ${worker_id}
+  </labels>
+  <initlabels>
+    key foo1
+    tag tag1
+  </initlabels>
+  <initlabels>
+    key foo2
+    tag tag2
+  </initlabels>
+</metric>
+<labels>
+  hostname ${hostname}
+</labels>
+```
+
 ### top-level labels and labels inside metric
 
 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.
@@ -436,7 +493,7 @@ In this case, `message_foo_counter` has `tag`, `hostname`, `key` and `data_type`
 Checkout repository and setup.
 
 ```
-$ git clone git://github.com/fluent/fluent-plugin-prometheus
+$ git clone git://github.com/fluent/fluent-plugin-prometheus.git
 $ cd fluent-plugin-prometheus
 $ bundle install --path vendor/bundle
 ```

data/fluent-plugin-prometheus.gemspec

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

@@ -3,6 +3,7 @@ require 'fluent/plugin/prometheus'
 require 'fluent/plugin/prometheus_metrics'
 require 'net/http'
 require 'openssl'
+require 'zlib'
 
 module Fluent::Plugin
   class PrometheusInput < Fluent::Plugin::Input
@@ -32,6 +33,9 @@ module Fluent::Plugin
       config_param :extra_conf, :hash, default: nil, symbolize_keys: true, deprecated: 'See http helper config'
     end
 
+    desc 'Content encoding of the exposed metrics, Currently supported encoding is identity, gzip. Ref: https://prometheus.io/docs/instrumenting/exposition_formats/#basic-info'
+    config_param :content_encoding, :enum, list: [:identity, :gzip], default: :identity
+
     def initialize
       super
       @registry = ::Prometheus::Client.registry
@@ -184,7 +188,7 @@ module Fluent::Plugin
     end
 
     def all_metrics
-      [200, { 'Content-Type' => ::Prometheus::Client::Formats::Text::CONTENT_TYPE }, ::Prometheus::Client::Formats::Text.marshal(@registry)]
+      response(::Prometheus::Client::Formats::Text.marshal(@registry))
     rescue => e
       [500, { 'Content-Type' => 'text/plain' }, e.to_s]
     end
@@ -197,8 +201,7 @@ module Fluent::Plugin
           full_result.add_metrics(resp.body)
         end
       end
-
-      [200, { 'Content-Type' => ::Prometheus::Client::Formats::Text::CONTENT_TYPE }, full_result.get_metrics]
+      response(full_result.get_metrics)
     rescue => e
       [500, { 'Content-Type' => 'text/plain' }, e.to_s]
     end
@@ -226,5 +229,18 @@ module Fluent::Plugin
         yield(http)
       end
     end
+
+    def response(metrics)
+      body = nil
+      case @content_encoding
+      when :gzip
+        gzip = Zlib::GzipWriter.new(StringIO.new)
+        gzip << metrics
+        body = gzip.close.string
+      when :identity
+        body = metrics
+      end
+      [200, { 'Content-Type' => ::Prometheus::Client::Formats::Text::CONTENT_TYPE, 'Content-Encoding' => @content_encoding.to_s }, body]
+    end
   end
 end

data/lib/fluent/plugin/in_prometheus_output_monitor.rb

@@ -77,7 +77,7 @@ module Fluent::Plugin
           :fluentd_output_status_buffer_queue_length,
           'Current length of queue buffers.'),
         buffer_queue_byte_size: get_gauge(
-          :fluentd_output_status_queue_byte_size,
+          :fluentd_output_status_buffer_queue_byte_size,
           'Current total size of queue buffers.'),
         buffer_available_buffer_space_ratios: get_gauge(
           :fluentd_output_status_buffer_available_space_ratio,

data/lib/fluent/plugin/in_prometheus_tail_monitor.rb

@@ -51,6 +51,15 @@ module Fluent::Plugin
         inode: get_gauge(
           :fluentd_tail_file_inode,
           'Current inode of file.'),
+        closed_file_metrics: get_gauge(
+          :fluentd_tail_file_closed,
+          'Number of files closed.'),
+        opened_file_metrics: get_gauge(
+          :fluentd_tail_file_opened,
+          'Number of files opened.'),
+        rotated_file_metrics: get_gauge(
+          :fluentd_tail_file_rotated,
+          'Number of files rotated.'),
       }
       timer_execute(:in_prometheus_tail_monitor, @interval, &method(:update_monitor_info))
     end
@@ -72,9 +81,15 @@ module Fluent::Plugin
           # Access to internal variable of internal class...
           # Very fragile implementation
           pe = watcher.instance_variable_get(:@pe)
+          monitor_info = watcher.instance_variable_get(:@metrics)
           label = labels(info, watcher.path)
           @metrics[:inode].set(pe.read_inode, labels: label)
           @metrics[:position].set(pe.read_pos, labels: label)
+          unless monitor_info.nil?
+            @metrics[:closed_file_metrics].set(monitor_info.closed.get, labels: label)
+            @metrics[:opened_file_metrics].set(monitor_info.opened.get, labels: label)
+            @metrics[:rotated_file_metrics].set(monitor_info.rotated.get, labels: label)
+          end
         end
       end
     end

data/lib/fluent/plugin/prometheus.rb

@@ -56,6 +56,69 @@ module Fluent
         base_labels
       end
 
+      def self.parse_initlabels_elements(conf, base_labels)
+        base_initlabels = []
+
+        # We first treat the special case of RecordAccessors and Placeholders labels if any declared
+        conf.elements.select { |e| e.name == 'initlabels' }.each { |block|
+          initlabels = {}
+
+          block.each do |key, value|
+            if not base_labels.has_key? key.to_sym
+              raise ConfigError, "Key #{key} in <initlabels> is non existent in <labels> for metric #{conf['name']}"
+            end
+
+            if value.start_with?('$.') || value.start_with?('$[') || value.start_with?('${')
+              raise ConfigError, "Cannot use RecordAccessor or placeholder #{value} (key #{key}) in a <initlabels> in metric #{conf['name']}"
+            end
+
+            base_label_value = base_labels[key.to_sym]
+
+            if !(base_label_value.class == Fluent::PluginHelper::RecordAccessor::Accessor) && ! (base_label_value.start_with?('${') )
+              raise ConfigError, "Cannot set <initlabels> on non RecordAccessor/Placeholder key #{key} (value #{value}) in metric #{conf['name']}"
+            end
+
+            if base_label_value == '${worker_id}' || base_label_value == '${hostname}'
+              raise ConfigError, "Cannot set <initlabels> on reserved placeholder #{base_label_value} for key #{key} in metric #{conf['name']}"
+            end
+            
+            initlabels[key.to_sym] = value
+          end
+
+          # Now adding all labels that are not RecordAccessor nor Placeholder labels as is
+          base_labels.each do |key, value|
+            if base_labels[key.to_sym].class != Fluent::PluginHelper::RecordAccessor::Accessor
+              if value == '${worker_id}'
+                # We retrieve fluentd_worker_id this way to not overcomplicate the code
+                initlabels[key.to_sym] = (ENV['SERVERENGINE_WORKER_ID'] || 0).to_i
+              elsif value == '${hostname}'
+                initlabels[key.to_sym] = Socket.gethostname
+              elsif !(value.start_with?('${'))
+                initlabels[key.to_sym] = value
+              end
+            end
+          end
+
+          base_initlabels << initlabels
+        }
+
+        # Testing for RecordAccessor/Placeholder labels missing a declaration in <initlabels> blocks
+        base_labels.each do |key, value|
+          if value.class == Fluent::PluginHelper::RecordAccessor::Accessor || value.start_with?('${')
+            if not base_initlabels.map(&:keys).flatten.include? (key.to_sym)
+                raise ConfigError, "RecordAccessor/Placeholder key #{key} with value #{value} has not been set in a <initlabels> for initialized metric #{conf['name']}"
+            end
+          end
+        end
+
+        if base_initlabels.length == 0
+          # There were no RecordAccessor nor Placeholder labels, we blunty retrieve the static base_labels
+          base_initlabels << base_labels
+        end
+
+        base_initlabels
+      end
+
       def self.parse_metrics_elements(conf, registry, labels = {})
         metrics = []
         conf.elements.select { |element|
@@ -162,9 +225,27 @@ module Fluent
           @name = element['name']
           @key = element['key']
           @desc = element['desc']
-
+          element['initialized'].nil? ? @initialized = false : @initialized = element['initialized'] == 'true'
+          
           @base_labels = Fluent::Plugin::Prometheus.parse_labels_elements(element)
           @base_labels = labels.merge(@base_labels)
+
+          if @initialized
+            @base_initlabels = Fluent::Plugin::Prometheus.parse_initlabels_elements(element, @base_labels)
+          end
+        end
+
+        def self.init_label_set(metric, base_initlabels, base_labels)
+          base_initlabels.each { |initlabels|
+            # Should never happen, but handy test should code evolution break current implementation
+            if initlabels.keys.sort != base_labels.keys.sort
+              raise ConfigError, "initlabels for metric #{metric.name} must have the same signature than labels " \
+                                "(initlabels given: #{initlabels.keys} vs." \
+                                " expected from labels: #{base_labels.keys})"
+            end
+
+            metric.init_label_set(initlabels)
+          }
         end
 
         def labels(record, expander)
@@ -206,6 +287,10 @@ module Fluent
           rescue ::Prometheus::Client::Registry::AlreadyRegisteredError
             @gauge = Fluent::Plugin::Prometheus::Metric.get(registry, element['name'].to_sym, :gauge, element['desc'])
           end
+
+          if @initialized
+            Fluent::Plugin::Prometheus::Metric.init_label_set(@gauge, @base_initlabels, @base_labels)
+          end
         end
 
         def instrument(record, expander)
@@ -228,6 +313,10 @@ module Fluent
           rescue ::Prometheus::Client::Registry::AlreadyRegisteredError
             @counter = Fluent::Plugin::Prometheus::Metric.get(registry, element['name'].to_sym, :counter, element['desc'])
           end
+
+          if @initialized
+            Fluent::Plugin::Prometheus::Metric.init_label_set(@counter, @base_initlabels, @base_labels)
+          end
         end
 
         def instrument(record, expander)
@@ -259,6 +348,10 @@ module Fluent
           rescue ::Prometheus::Client::Registry::AlreadyRegisteredError
             @summary = Fluent::Plugin::Prometheus::Metric.get(registry, element['name'].to_sym, :summary, element['desc'])
           end
+
+          if @initialized
+            Fluent::Plugin::Prometheus::Metric.init_label_set(@summary, @base_initlabels, @base_labels)
+          end
         end
 
         def instrument(record, expander)
@@ -292,6 +385,10 @@ module Fluent
           rescue ::Prometheus::Client::Registry::AlreadyRegisteredError
             @histogram = Fluent::Plugin::Prometheus::Metric.get(registry, element['name'].to_sym, :histogram, element['desc'])
           end
+
+          if @initialized
+            Fluent::Plugin::Prometheus::Metric.init_label_set(@histogram, @base_initlabels, @base_labels)
+          end
         end
 
         def instrument(record, expander)

data/spec/fluent/plugin/in_prometheus_spec.rb

@@ -3,6 +3,7 @@ require 'fluent/plugin/in_prometheus'
 require 'fluent/test/driver/input'
 
 require 'net/http'
+require 'zlib'
 
 describe Fluent::Plugin::PrometheusInput do
   CONFIG = %[
@@ -45,6 +46,24 @@ describe Fluent::Plugin::PrometheusInput do
         expect(driver.instance.metrics_path).to eq('/_test')
       end
     end
+
+    describe 'content_encoding_identity' do
+      let(:config) { CONFIG + %[
+    content_encoding identity
+] }
+      it 'should be configurable' do
+        expect(driver.instance.content_encoding).to eq(:identity)
+      end
+    end
+
+    describe 'content_encoding_gzip' do
+      let(:config) { CONFIG + %[
+    content_encoding gzip
+] }
+      it 'should be configurable' do
+        expect(driver.instance.content_encoding).to eq(:gzip)
+      end
+    end
   end
 
   describe '#start' do
@@ -197,12 +216,49 @@ describe Fluent::Plugin::PrometheusInput do
         end
       end
     end
+
+    context 'response content_encoding identity' do
+      let(:config) { LOCAL_CONFIG + %[
+        content_encoding identity
+  ] }
+      it 'exposes metric' do
+        driver.run(timeout: 1) do
+          registry = driver.instance.instance_variable_get(:@registry)
+          registry.counter(:test,docstring: "Testing metrics") unless registry.exist?(:test)
+          Net::HTTP.start("127.0.0.1", port) do |http|
+            req = Net::HTTP::Get.new("/metrics")
+            req['accept-encoding'] = nil
+            res = http.request(req)
+            expect(res.body).to include("test Testing metrics")
+          end
+        end
+      end
+    end
+
+    context 'response content_encoding gzip' do
+      let(:config) { LOCAL_CONFIG + %[
+        content_encoding gzip
+  ] }
+      it 'exposes metric' do
+        driver.run(timeout: 1) do
+          registry = driver.instance.instance_variable_get(:@registry)
+          registry.counter(:test,docstring: "Testing metrics") unless registry.exist?(:test)
+          Net::HTTP.start("127.0.0.1", port) do |http|
+            req = Net::HTTP::Get.new("/metrics")
+            req['accept-encoding'] = nil
+            res = http.request(req)
+            gzip = Zlib::GzipReader.new(StringIO.new(res.body.to_s))
+            expect(gzip.read).to include("test Testing metrics")
+          end
+        end
+      end
+    end
   end
 
   describe '#run_multi_workers' do
     context '/metrics' do
       Fluent::SystemConfig.overwrite_system_config('workers' => 4) do
-        let(:config) { CONFIG + %[
+        let(:config) { FULL_CONFIG + %[
           port #{port - 2}
         ] }
 

data/spec/fluent/plugin/out_prometheus_spec.rb

@@ -16,6 +16,10 @@ describe Fluent::Plugin::PrometheusOutput do
     it_behaves_like 'output configuration'
   end
 
+  describe '#testinitlabels' do
+    it_behaves_like 'initalized metrics'
+  end
+  
   describe '#run' do
     let(:message) { {"foo" => 100, "bar" => 100, "baz" => 100, "qux" => 10} }
 

data/spec/fluent/plugin/shared.rb

@@ -27,6 +27,7 @@ FULL_CONFIG = BASE_CONFIG + %[
     type gauge
     desc Something bar.
     key bar
+    initialized true
     <labels>
       key foo2
     </labels>
@@ -36,6 +37,7 @@ FULL_CONFIG = BASE_CONFIG + %[
     type summary
     desc Something baz.
     key baz
+    initialized true
     <labels>
       key foo3
     </labels>
@@ -46,6 +48,7 @@ FULL_CONFIG = BASE_CONFIG + %[
     desc Something qux.
     key qux
     buckets 0.1, 1, 5, 10
+    initialized true
     <labels>
       key foo4
     </labels>
@@ -62,12 +65,32 @@ FULL_CONFIG = BASE_CONFIG + %[
   <metric>
     name full_accessor2
     type counter
-    desc Something with accessor.
+    desc Something with accessor
     key $.foo
+    initialized true
     <labels>
       key foo6
     </labels>
   </metric>
+  <metric>
+    name full_accessor3
+    type counter
+    desc Something with accessor and several initialized metrics
+    initialized true
+    <labels>
+      key $.foo
+      key2 $.foo2
+      key3 footix
+    </labels>
+    <initlabels>
+      key foo6
+      key2 foo7
+    </initlabels>
+    <initlabels>
+      key foo8
+      key2 foo9
+    </initlabels>
+  </metric>
   <labels>
     test_key test_value
   </labels>
@@ -79,13 +102,20 @@ PLACEHOLDER_CONFIG = BASE_CONFIG + %[
     type counter
     desc Something foo.
     key foo
+    initialized true
     <labels>
       foo ${foo}
+      foo2 foo2
     </labels>
+    <initlabels>
+      tag tag
+      foo foo
+    </initlabels>
   </metric>
   <labels>
     tag ${tag}
     hostname ${hostname}
+    workerid ${worker_id}
   </labels>
 ]
 
@@ -150,6 +180,111 @@ shared_examples_for 'output configuration' do
     end
     it { expect { driver }.to raise_error(Fluent::ConfigError) }
   end
+
+
+  context 'with missing <initlabels>' do
+    let(:config) do
+      BASE_CONFIG + %[
+      <metric>
+        name simple_foo
+        type counter
+        desc Something foo but incorrect
+        key foo
+        initialized true
+        <labels>
+          key $.accessor
+        </labels>
+      </metric>
+      ]
+    end
+    it { expect { driver }.to raise_error(Fluent::ConfigError) }
+  end
+
+  context 'with RecordAccessor set in <initlabels>' do
+    let(:config) do
+      BASE_CONFIG + %[
+      <metric>
+        name simple_foo
+        type counter
+        desc Something foo but incorrect
+        key foo
+        initialized true
+        <labels>
+          key $.accessor
+        </labels>
+        <initlabels>
+          key $.accessor2
+        <initlabels>
+      </metric>
+      ]
+    end
+    it { expect { driver }.to raise_error(Fluent::ConfigError) }
+  end
+
+  context 'with PlaceHolder set in <initlabels>' do
+    let(:config) do
+      BASE_CONFIG + %[
+      <metric>
+        name simple_foo
+        type counter
+        desc Something foo but incorrect
+        key foo
+        initialized true
+        <labels>
+          key ${foo}
+        </labels>
+        <initlabels>
+          key ${foo}
+        <initlabels>
+      </metric>
+      ]
+    end
+    it { expect { driver }.to raise_error(Fluent::ConfigError) }
+  end
+
+  context 'with non RecordAccessor label set in <initlabels>' do
+    let(:config) do
+      BASE_CONFIG + %[
+      <metric>
+        name simple_foo
+        type counter
+        desc Something foo but incorrect
+        key foo
+        initialized true
+        <labels>
+          key $.accessor
+          key2 foo2
+        </labels>
+        <initlabels>
+          key foo
+          key2 foo2
+        <initlabels>
+      </metric>
+      ]
+    end
+    it { expect { driver }.to raise_error(Fluent::ConfigError) }
+  end
+
+  context 'with non-matching label keys set in <initlabels>' do
+    let(:config) do
+      BASE_CONFIG + %[
+      <metric>
+        name simple_foo
+        type counter
+        desc Something foo but incorrect
+        key foo
+        initialized true
+        <labels>
+          key $.accessor
+        </labels>
+        <initlabels>
+          key2 foo
+        <initlabels>
+      </metric>
+      ]
+    end
+    it { expect { driver }.to raise_error(Fluent::ConfigError) }
+  end
 end
 
 shared_examples_for 'instruments record' do
@@ -165,14 +300,16 @@ shared_examples_for 'instruments record' do
     let(:histogram) { registry.get(:full_qux) }
     let(:summary_with_accessor) { registry.get(:full_accessor1) }
     let(:counter_with_accessor) { registry.get(:full_accessor2) }
+    let(:counter_with_two_accessors) { registry.get(:full_accessor3) }
 
     it 'adds all metrics' do
-      expect(registry.metrics.map(&:name)).to eq(%i[full_foo full_bar full_baz full_qux full_accessor1 full_accessor2])
+      expect(registry.metrics.map(&:name)).to eq(%i[full_foo full_bar full_baz full_qux full_accessor1 full_accessor2 full_accessor3])
       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(counter_with_two_accessors).to be_kind_of(::Prometheus::Client::Metric)
       expect(histogram).to be_kind_of(::Prometheus::Client::Metric)
     end
 
@@ -180,6 +317,7 @@ shared_examples_for 'instruments record' do
       expect(counter.type).to eq(:counter)
       expect(counter.get(labels: {test_key: 'test_value', key: 'foo1'})).to be_kind_of(Numeric)
       expect(counter_with_accessor.get(labels: {test_key: 'test_value', key: 'foo6'})).to be_kind_of(Numeric)
+      expect(counter_with_two_accessors.get(labels: {test_key: 'test_value', key: 'foo6', key2: 'foo7', key3: 'footix'})).to be_kind_of(Numeric)
     end
 
     it 'instruments gauge metric' do
@@ -246,3 +384,66 @@ shared_examples_for 'instruments record' do
     end
   end
 end
+
+shared_examples_for 'initalized metrics' do
+  before do
+    driver.run(default_tag: tag)
+  end
+
+  context 'full config' do
+    let(:config) { FULL_CONFIG }
+    let(:counter) { registry.get(:full_foo) }
+    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) }
+    let(:counter_with_two_accessors) { registry.get(:full_accessor3) }
+  
+    it 'adds all metrics' do
+      expect(registry.metrics.map(&:name)).to eq(%i[full_foo full_bar full_baz full_qux full_accessor1 full_accessor2 full_accessor3])
+      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(counter_with_two_accessors).to be_kind_of(::Prometheus::Client::Metric)
+      expect(histogram).to be_kind_of(::Prometheus::Client::Metric)
+    end
+
+    it 'tests uninitialized metrics' do
+      expect(counter.values).to eq({})
+      expect(summary_with_accessor.values).to eq({})
+    end
+
+    it 'tests initialized metrics' do
+      expect(gauge.values).to eq({{:key=>"foo2", :test_key=>"test_value"}=>0.0})
+      expect(summary.values).to eq({:key=>"foo3", :test_key=>"test_value"}=>{"count"=>0.0, "sum"=>0.0})
+      expect(histogram.values).to eq({:key=>"foo4", :test_key=>"test_value"} => {"+Inf"=>0.0, "0.1"=>0.0, "1"=>0.0, "10"=>0.0, "5"=>0.0, "sum"=>0.0})
+      expect(counter_with_accessor.values).to eq({{:key=>"foo6", :test_key=>"test_value"}=>0.0})
+      expect(counter_with_two_accessors.values).to eq({{:key=>"foo6", :key2=>"foo7", :key3=>"footix", :test_key=>"test_value"}=>0.0, {:key=>"foo8", :key2=>"foo9", :key3=>"footix", :test_key=>"test_value"}=>0.0})
+    end
+  end
+
+  context 'placeholder config' do
+    let(:config) { PLACEHOLDER_CONFIG }
+    let(:counter) { registry.get(:placeholder_foo) }
+
+    it 'expands placeholders with record values' do
+      expect(registry.metrics.map(&:name)).to eq([:placeholder_foo])
+      expect(counter).to be_kind_of(::Prometheus::Client::Metric)
+
+      key, _ = counter.values.find {|k,v| v ==  0.0 }
+      expect(key).to be_kind_of(Hash)
+      expect(key[:foo]).to eq("foo")
+      expect(key[:foo2]).to eq("foo2")
+      expect(key[:hostname]).to be_kind_of(String)
+      expect(key[:hostname]).not_to eq("${hostname}")
+      expect(key[:hostname]).not_to be_empty
+      expect(key[:workerid]).to be_kind_of(String)
+      expect(key[:workerid]).not_to eq("${worker_id}")
+      expect(key[:workerid]).not_to be_empty
+      expect(key[:tag]).to eq("tag")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-prometheus
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Masahiro Sano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -107,10 +107,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/linux.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ChangeLog
 - Gemfile
 - LICENSE

data/.travis.yml

@@ -1,14 +0,0 @@
-language: ruby
-
-rvm:
-  - "2.4.7"
-  - "2.5"
-  - "2.6"
-
-gemfile:
-  - Gemfile
-
-script:
-  - bundle exec rake spec
-
-sudo: false