fluent-plugin-kafka-status 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e63e584615aed1277ffa8ee1217164c55712252e0e89efe6f6a4344aa34afa71
+  data.tar.gz: 575723958151ac961ae4ce8a7494c69ea304599150c58434720fcce769a39020
+SHA512:
+  metadata.gz: f76cc5ebf49a79d656313d1c360ae52eebeba0e38d94b06621b357310548189308b51d462f17daa8e5af51e224d05e6f346002237819c1c92ae84a1b857dcb3b
+  data.tar.gz: e25bfdeac65df107dab55993e6dbf245477badf06794bedc3a1cf89f893e1da4f514a695429b54a6f84000514e5bfd61d977d02615daaf924194b9c549752274

data/.gitignore

@@ -0,0 +1,3 @@
+# tmp files
+/tmp
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,33 @@
+require:
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 140
+
+# Metrics/AbcSize:
+#   Max: 40
+
+Metrics/BlockLength:
+  Exclude:
+    - fluent-plugin-kafka-status.gemspec
+    - test/**/*.rb
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*.rb
+    - lib/fluent/plugin/in_ssl_check.rb
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - test/**/*.rb
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-kafka-status (0.2.0)
+      fluentd (>= 0.14.10, < 2)
+      ruby-kafka (>= 1.3.0, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bigdecimal (3.1.6)
+    bump (0.10.0)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.3)
+    cool.io (1.8.0)
+    digest-crc (0.6.5)
+      rake (>= 12.0.0, < 14.0.0)
+    dry-configurable (1.1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.1)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-schema (1.13.3)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-core (~> 1.0, < 2)
+      dry-initializer (~> 3.0)
+      dry-logic (>= 1.4, < 2)
+      dry-types (>= 1.7, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.2)
+      bigdecimal (~> 3.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    fluentd (1.16.3)
+      bundler
+      cool.io (>= 1.4.5, < 2.0.0)
+      http_parser.rb (>= 0.5.1, < 0.9.0)
+      msgpack (>= 1.3.1, < 2.0.0)
+      serverengine (>= 2.3.2, < 3.0.0)
+      sigdump (~> 0.2.5)
+      strptime (>= 0.2.4, < 1.0.0)
+      tzinfo (>= 1.0, < 3.0)
+      tzinfo-data (~> 1.0)
+      webrick (~> 1.4)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.8.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    msgpack (1.7.2)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    power_assert (2.0.3)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    reek (6.3.0)
+      dry-schema (~> 1.13.0)
+      parser (~> 3.3.0)
+      rainbow (>= 2.0, < 4.0)
+      rexml (~> 3.1)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rubocop (1.60.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-kafka (1.5.0)
+      digest-crc
+    ruby-progressbar (1.13.0)
+    serverengine (2.3.2)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.5)
+    strptime (0.2.5)
+    test-unit (3.6.1)
+      power_assert
+    timecop (0.9.8)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2024.1)
+      tzinfo (>= 1.0.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    yajl-ruby (1.4.3)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bump (~> 0.10.0)
+  bundler (~> 2.5.6)
+  byebug (~> 11.1, >= 11.1.3)
+  fluent-plugin-kafka-status!
+  rake (~> 13.1.0)
+  reek (~> 6.1, >= 6.1.4)
+  rubocop (~> 1.56)
+  rubocop-rake (~> 0.6.0)
+  test-unit (~> 3.6.1)
+  timecop (~> 0.9.6)
+
+BUNDLED WITH
+   2.5.6

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,63 @@
+# fluent-plugin-kafka-status
+
+[Fluentd](https://fluentd.org/) input plugin for *kafka* status.
+
+
+## plugins
+
+### in - kafka_status
+
+Poll kafka cluster status.
+
+#### configuration
+
+Example:
+
+``` conf
+<source>
+  @type kafka_status
+  tag kafka_status
+</source>
+```
+
+Options are:
+* tag: Tag to emit events on
+* brokers: list of borkers <host>:<port>,...
+* connect_timeout: timeout for connecting to brokers
+* ssl_ca_cert: CA cert to use for SSL connection
+* ssl_client_cert: client cert for the SSL connection
+* ssl_client_cert_key: client key for the SSL connection
+* ssl_verify_hostname: verify certificate hostname
+* interval: interval between execution
+* timestamp_format: iso, epochmillis timestamp format (iso)
+* event_prefix: metric event prefix for extra dimension
+
+#### output
+
+Generated metrics are :
+
+
+
+## Installation
+
+Manual install, by executing:
+
+    $ gem install fluent-plugin-kafka-status
+
+Add to Gemfile with:
+
+    $ bundle add fluent-plugin-kafka-status
+
+
+## Compatibility
+
+should work with:
+- ruby >= 2.4.0
+- ruby-kafka >= 1.3.0
+
+
+## Copyright
+
+* Copyright(c) 2024- Thomas Tych
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs.push('lib', 'test')
+  t.test_files = FileList['test/**/test_*.rb', 'test/**/*_test.rb',]
+  t.verbose = true
+  t.warning = true
+end
+
+require 'rubocop/rake_task'
+
+require 'bump/tasks'
+
+task default: %i[test rubocop]

data/fluent-plugin-kafka-status.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = 'fluent-plugin-kafka-status'
+  spec.version = '0.2.0'
+  spec.authors = ['Thomas Tych']
+  spec.email   = ['thomas.tych@gmail.com']
+
+  spec.summary       = 'fluentd plugin to extract status from kafka cluster'
+  spec.homepage      = 'https://gitlab.com/ttych/fluent-plugin-kafka-status'
+  spec.license       = 'Apache-2.0'
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  _, files = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bump', '~> 0.10.0'
+  spec.add_development_dependency 'bundler', '~> 2.5.6'
+  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
+  spec.add_development_dependency 'rake', '~> 13.1.0'
+  spec.add_development_dependency 'reek', '~> 6.1', '>= 6.1.4'
+  spec.add_development_dependency 'rubocop', '~> 1.56'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'test-unit', '~> 3.6.1'
+  spec.add_development_dependency 'timecop', '~> 0.9.6'
+
+  spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
+  spec.add_runtime_dependency 'ruby-kafka', ['>= 1.3.0', '< 2']
+end

data/lib/fluent/plugin/in_kafka_status.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+#
+# Copyright 2024- Thomas Tych
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'fluent/plugin/input'
+
+require 'kafka'
+
+require_relative 'kafka_status_utils'
+require_relative 'time_ext'
+
+module Fluent
+  module Plugin
+    class KafkaStatusInput < Fluent::Plugin::Input
+      NAME = 'kafka_status'
+      Fluent::Plugin.register_input(NAME, self)
+
+      include Fluent::Plugin::KafkaStatusUtils
+
+      helpers :event_emitter, :timer
+
+      DEFAULT_TAG = NAME
+      DEFAULT_BROKERS = ['localhost:9092']
+      DEFAULT_CLIENT_ID = "fluentd:#{NAME}"
+      DEFAULT_INTERVAL = 3600
+      DEFAULT_TIMESTAMP_FORMAT = :iso
+      DEFAULT_EVENT_PREFIX = ''
+      MAX_RETRIES = 3
+
+      config_param :tag, :string, default: DEFAULT_TAG,
+                                  desc: 'tag to emit status events on'
+      config_param :brokers, :array, value_type: :string, default: DEFAULT_BROKERS,
+                                     desc: 'kafka brokers: <host>:<port>,...'
+      config_param :client_id, :string, default: DEFAULT_CLIENT_ID,
+                                        desc: 'user agent like identifier for kafka connection'
+      config_param :connect_timeout, :integer, default: nil,
+                                               desc: 'timeout for connection to brokers'
+
+      config_param :ssl_ca_cert, :string, default: nil,
+                                          desc: 'a PEM encoded CA cert for SSL connection'
+      config_param :ssl_client_cert, :string, default: nil,
+                                              desc: 'a PEM encoded client cert for SSL connection'
+      config_param :ssl_client_cert_key, :string, default: nil,
+                                                  desc: 'a PEM encoded client cert key for SSL connection'
+      config_param :ssl_verify_hostname, :bool, default: true,
+                                                desc: 'whether hostname of certificate should be verified or not'
+
+      config_param :interval, :time, default: DEFAULT_INTERVAL,
+                                     desc: 'interval for the plugin execution'
+
+      config_param :timestamp_format, :enum, list: %i[iso epochmillis], default: DEFAULT_TIMESTAMP_FORMAT,
+                                             desc: 'timestamp format'
+      config_param :event_prefix, :string, default: DEFAULT_EVENT_PREFIX,
+                                           desc: 'Event prefix'
+
+      def initialize
+        super
+
+        @kafka = nil
+      end
+
+      def configure(conf)
+        super
+
+        raise Fluent::ConfigError, 'tag should not be empty' if tag.nil? || tag.empty?
+        raise Fluent::ConfigError, 'No brokers specified. Need one broker at least.' if brokers.empty?
+        raise Fluent::ConfigError, 'ssl_ca_cert should be a file.' if ssl_ca_cert && !File.file?(ssl_ca_cert)
+
+        raise Fluent::ConfigError, 'ssl_client_cert should be a file.' if ssl_client_cert && !File.file?(ssl_client_cert)
+        raise Fluent::ConfigError, 'ssl_client_cert_key should be a file.' if ssl_client_cert_key && !File.file?(ssl_client_cert_key)
+      end
+
+      def start
+        super
+
+        timer_execute(:kafka_status_first, 1, repeat: false, &method(:kafka_status)) if interval > 60
+
+        timer_execute(:kafka_status, interval, repeat: true, &method(:kafka_status))
+      end
+
+      def shutdown
+        super
+        close_kafka
+      end
+
+      def kafka_status
+        events = []
+        events += events_for_topics
+        events += events_for_cluster_brokers
+        time = Fluent::Engine.now
+        events.each { |event| router.emit(tag, time, event) }
+      end
+
+      ### metric 1 - active topic
+      # family: topic
+      # name: active
+      # value: 1
+      # tags_topic: <topic>
+      ### metric 2 - partitions_count
+      # family: topic
+      # name: configured_partitions_count
+      # value: X
+      # tags_topic: <topic>
+      ### metric 3 - replica_count
+      # family: topic
+      # name: replica_count
+      # value: count
+      # tags_topic: <topic>
+      def events_for_topics
+        kafka do |kafka|
+          events = []
+          timestamp = Time.now.utc.send("to_#{timestamp_format}")
+          kafka.topics.each do |topic|
+            events
+              .append({ 'timestamp' => timestamp,
+                        'metric_family' => 'topic',
+                        'metric_name' => 'active',
+                        'metric_value' => 1,
+                        "#{event_prefix}topic" => topic })
+              .append({ 'timestamp' => timestamp,
+                        'metric_family' => 'topic',
+                        'metric_name' => 'configured_partitions_count',
+                        'metric_value' => kafka.partitions_for(topic),
+                        "#{event_prefix}topic" => topic })
+              .append({ 'timestamp' => timestamp,
+                        'metric_family' => 'topic',
+                        'metric_name' => 'replica_count',
+                        'metric_value' => kafka.replica_count_for(topic),
+                        "#{event_prefix}topic" => topic })
+          end
+          events
+        end
+      end
+
+      ### metric 4 - brokers_count
+      # family: cluster
+      # name: brokers_count
+      # value: count
+      # ???
+      ### metric 5 - broker_active
+      # family: cluster
+      # name: broker_active
+      # value: 1
+      # tags_member_host: <host>
+      # ???
+      def events_for_cluster_brokers
+        kafka do |kafka|
+          events = []
+          timestamp = Time.now.utc.send("to_#{timestamp_format}")
+          brokers = kafka.brokers
+          events.append({
+                          'timestamp' => timestamp,
+                          'metric_family' => 'cluster',
+                          'metric_name' => 'brokers_count',
+                          'metric_value' => brokers.size
+                        })
+          brokers.each do |broker|
+            events.append({
+                            'timestamp' => timestamp,
+                            'metric_family' => 'cluster',
+                            'metric_name' => 'broker_active',
+                            'metric_value' => 1,
+                            'tags_member_host' => broker.host
+                          })
+          end
+          events
+        end
+      end
+
+      def kafka(max_retries = MAX_RETRIES)
+        retry_count = 0
+        begin
+          @kafka ||= new_kafka
+          yield @kafka if block_given?
+        rescue StandardError => e
+          log.error "exception with kafka connection: #{e}"
+          raise e if (retry_count += 1) > max_retries
+
+          close_kafka
+          sleep 30
+          retry
+        end
+      end
+
+      def new_kafka
+        kafka = Kafka.new(
+          seed_brokers: brokers,
+          client_id: @client_id,
+          connect_timeout: connect_timeout,
+          ssl_ca_cert: read_file(ssl_ca_cert),
+          ssl_client_cert: read_file(ssl_client_cert),
+          ssl_client_cert_key: read_file(ssl_client_cert_key),
+          ssl_ca_certs_from_system: !!ssl_ca_cert,
+          ssl_verify_hostname: ssl_verify_hostname
+        )
+        log.info "initialized kafka producer: #{@client_id}"
+        kafka
+      end
+
+      def close_kafka
+        @kafka&.close
+        @kafka = nil
+      rescue StandardError
+      end
+    end
+  end
+end

data/lib/fluent/plugin/kafka_status_utils.rb

@@ -0,0 +1,12 @@
+## frozen_string_literal: true
+
+module Fluent
+  module Plugin
+    module KafkaStatusUtils
+      def read_file(path)
+        return nil if path.nil?
+        File.read(path)
+      end
+    end
+  end
+end

data/lib/fluent/plugin/time_ext.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# extensions for Time class
+#   provides formater
+#   - to epoch millisecond format
+#   - to iso format with millisecond
+class Time
+  def to_epochmillis
+    (to_f * 1000).to_i
+  end
+
+  def to_iso
+    iso8601(3)
+  end
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-kafka-status
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Thomas Tych
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.6
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.56'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description:
+email:
+- thomas.tych@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-kafka-status.gemspec
+- lib/fluent/plugin/in_kafka_status.rb
+- lib/fluent/plugin/kafka_status_utils.rb
+- lib/fluent/plugin/time_ext.rb
+homepage: https://gitlab.com/ttych/fluent-plugin-kafka-status
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: fluentd plugin to extract status from kafka cluster
+test_files: []