fluent-plugin-prometheus 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366793cd93075c7e1d63cb2641d2654f5eef5304aaa1293bb9e1dabed7d93e2f
-  data.tar.gz: 4db5c9fc80dcf10b013239bfdb6e098b53bf26c34a135f944850c70d2a36b7d9
+  metadata.gz: c42edc59b51fa5a911f51e5c174f71dc573c99068379d3ee8ba7d2d710dbcbb5
+  data.tar.gz: 32206e06e3c6a6a9b19f6b93583af0c416ae76dc707a1a2dbefe0b54975a936b
 SHA512:
-  metadata.gz: 47de7cabc21f0365b8629714dbd7044e95346d5fb9ce13f7c830a8aeab66bd078769792e6af2ddf52bfc41be3b052f1f1ef912dc71d34c3db0dc94b283832238
-  data.tar.gz: 00c98825475166ae5f53e6bd85081766a38aa12b5ecddf079e0f1efcbb0eb729deacf996ee975893897aa2aeca84e35a741d23c2bf7e1f602c75876e08d317ee
+  metadata.gz: 178009b03c28bf7dde6207cbf7f99c1bcdd8e787669630646f937eed5249b8d8fc17443ec08777620caafbc2498ceb13d753db45aea0a86d9b309a396078bf44
+  data.tar.gz: 3051330dbb989c965054f6171f9db9c00775d5642d7d4210da909c2501cca7c66a68b5e319385e81d579a0cdf389d7362873e95b6d5f4bc3fe84ed1004d70071

data/.github/workflows/linux.yml

@@ -11,13 +11,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.2', '3.1', '3.0', '2.7' ]
+        ruby: [ '3.3', '3.2', '3.1', '3.0', '2.7' ]
         os:
           - ubuntu-latest
         experimental: [false]
     name: Ruby ${{ matrix.ruby }} unit testing on ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -25,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,7 @@
+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

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.
@@ -492,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.1.0"
+  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/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,6 +216,43 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-prometheus
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Masahiro Sano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-15 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd