fluent-plugin-elasticsearch-stats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dd73194ef81df48fccec9c76d2b3e7815fbd83736d5a545ad27c58d0a764e5e
+  data.tar.gz: 806fbd6806d9b6c952e1c9807b528fedd64e27b612a41cd4ffe3b82c09cf9b82
+SHA512:
+  metadata.gz: d3d4f1ce520a02d3e85e1d1c58289556891321da7f27e6f7898dc65d828b99426d8b2a97867830d367cecffcb8fd01f555a6ded4bf725007382cf294dc48e0a3
+  data.tar.gz: 6ad75d6fa0c3476bde72ccf8bd5e6526c3080464491c57e5742d8b9f222091fe4c4cf3b09bd873ea9a4180f9b4b2548e149152ad8c6445b533ff4e616a71455a

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,13 @@
+# You can override the included template(s) by including variable overrides
+# SAST customization: https://docs.gitlab.com/ee/user/application_security/sast/#customizing-the-sast-settings
+# Secret Detection customization: https://docs.gitlab.com/ee/user/application_security/secret_detection/#customizing-settings
+# Dependency Scanning customization: https://docs.gitlab.com/ee/user/application_security/dependency_scanning/#customizing-the-dependency-scanning-settings
+# Container Scanning customization: https://docs.gitlab.com/ee/user/application_security/container_scanning/#customizing-the-container-scanning-settings
+# Note that environment variables can be set in several places
+# See https://docs.gitlab.com/ee/ci/variables/#cicd-variable-precedence
+stages:
+- test
+sast:
+  stage: test
+include:
+- template: Security/SAST.gitlab-ci.yml

data/.rubocop.yml

@@ -0,0 +1,36 @@
+require:
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+# Metrics/AbcSize:
+#   Max: 40
+
+Metrics/BlockLength:
+  Exclude:
+    - fluent-plugin-elasticsearch-stats.gemspec
+    - test/**/*.rb
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*.rb
+    - lib/fluent/plugin/in_elasticsearch_stats.rb
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - test/**/*.rb
+
+Metrics/ParameterLists:
+  Exclude: []
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,139 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-elasticsearch-stats (0.1.0)
+      faraday (~> 2.9)
+      fluentd (>= 0.14.10, < 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)
+    docile (1.4.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)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    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)
+    net-http (0.4.1)
+      uri
+    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-progressbar (1.13.0)
+    serverengine (2.3.2)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    strptime (0.2.5)
+    test-unit (3.6.2)
+      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)
+    uri (0.13.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-elasticsearch-stats!
+  rake (~> 13.1.0)
+  reek (~> 6.1, >= 6.1.4)
+  rubocop (~> 1.56)
+  rubocop-rake (~> 0.6.0)
+  simplecov (~> 0.22.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,120 @@
+# fluent-plugin-elasticsearch-stats
+
+[Fluentd](https://fluentd.org/) input plugin to fetch stats on elasticsearch.
+
+It uses the elasticsearch following endpoints:
+
+- **Cluster Heath** through **/_cluster/health?level=indices**
+- **Cluster Stats** through **/_cluster/stats**
+- **Node Stats** through **/_nodes/stats** or **/_nodes/_local/stats**
+- **Indices Stats** through **/_all/_stats**
+- **Shard Stats** through **/_all/_stats?level=shards**
+- **Dangling** through **/_dangling**
+
+
+## plugins
+
+### in - elasticsearch-stats
+
+Fetch stats with elasticsearch, and convert stats to metrics.
+
+Example of config
+
+``` text
+<source>
+  @type elasticsearch_stats
+
+  tag elastic.metrics
+
+  cluster_health true
+  cluster_stats false
+  nodes_stats false
+</source>
+```
+
+#### global options
+
+| setting                | type               | default                           | description                                                         |
+|------------------------|--------------------|-----------------------------------|---------------------------------------------------------------------|
+| tag                    |                    | elasticsearch_stats               | tag to emit events on                                               |
+| urls                   |                    | ["http://localhost:9200"]         | list of urls to poll                                                |
+| timeout                | second             | 10                                | timeout for each call                                               |
+| username               |                    |                                   | username for basic authentication                                   |
+| password               |                    |                                   | password for basic authentication                                   |
+| user_agent             |                    | fluent-plugin-elasticsearch-stats | user agent for http request                                         |
+| ca_file                | file               |                                   | CA cert file to use for request                                     |
+| verify_ssl             | true\|false        | true                              | option to verify certificate/host                                   |
+|                        |                    |                                   |                                                                     |
+| interval               | second             | 300                               | interval for probe execution                                        |
+|                        |                    |                                   |                                                                     |
+| metric_prefix          |                    |                                   | prefix for metric fields                                            |
+| metadata_prefix        |                    |                                   | prefix for metadata fields                                          |
+| timestamp_format       | iso\|epochmillis   | iso                               | event timestamp format                                              |
+| event_name_separator   |                    | /                                 | event name separator                                                |
+|                        |                    |                                   |                                                                     |
+| index_base_pattern     | regexp             |                                   | base index pattern to generate aggregated index metrics             |
+| index_base_replacement | regexp replacement | \1                                | base index pattern replacement to generate aggregated index metrics |
+
+#### cluster health options
+
+Events from **[/_cluster/health?level=indices](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html)**.
+
+| setting              | type             | default | description                                    |
+|----------------------|------------------|---------|------------------------------------------------|
+| cluster_health       | true\|false      | true    | enable cluster health events collect           |
+| cluster_health_level | cluster\|indices | cluster | details level of the health information        |
+| cluster_health_local | true\|false      | false   | retrieves information from the local node only |
+
+#### cluster stats options
+
+Events from **/_cluster/stats**.
+
+| setting                        | type        | default | description                                |
+|--------------------------------|-------------|---------|--------------------------------------------|
+| cluster_stats                  | true\|false | false   | enable cluster stats events collect        |
+
+#### nodes stats options
+
+Events from **/_nodes/stats**.
+
+| setting             | type                                                                 | default | description                       |
+|---------------------|----------------------------------------------------------------------|---------|-----------------------------------|
+| nodes_stats         | true\|false                                                          | true    | enable node stats events collect  |
+| nodes_stats_level   | node\|indices                                                        | node    | details level for the nodes stats |
+| nodes_stats_metrics | indices, os, process, jvm, thread_pool, fs, transport, http, breaker | []      |                                   |
+
+#### indices stats options
+
+Events from **/_all/_stats**.
+
+| setting                         | type                     | default  | description                         |
+|---------------------------------|--------------------------|----------|-------------------------------------|
+| indices_stats                   | true\|false              | true     | enable indices stats events collect |
+| indices_stats_level             | cluster\|indices\|shards | indices  | indices_stats details level         |
+| indices                         |                          | ["_all"] | indices to collect stats on         |
+
+#### dangling options
+
+Events from **/_dangling**.
+
+| setting  | type        | default | description                    |
+|----------|-------------|---------|--------------------------------|
+| dangling | true\|false | false   | enable dangling events collect |
+
+
+## Installation
+
+Manual install, by executing:
+
+    $ gem install fluent-plugin-elasticsearch-stats
+
+Add to Gemfile with:
+
+    $ bundle add fluent-plugin-elasticsearch-stats
+
+
+## Copyright
+
+* Copyright(c) 2024- Thomas Tych
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,19 @@
+# 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'
+RuboCop::RakeTask.new
+
+require 'bump/tasks'
+
+task default: %i[test rubocop]

data/fluent-plugin-elasticsearch-stats.gemspec

@@ -0,0 +1,40 @@
+# 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-elasticsearch-stats'
+  spec.version = '0.1.0'
+  spec.authors = ['Thomas Tych']
+  spec.email   = ['thomas.tych@gmail.com']
+
+  spec.summary       = 'fluentd plugin to generate elasticsearch cluster stats events.'
+  spec.homepage      = 'https://gitlab.com/ttych/fluent-plugin-elasticsearch-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 'simplecov', '~> 0.22.0'
+  spec.add_development_dependency 'test-unit', '~> 3.6.1'
+  spec.add_development_dependency 'timecop', '~> 0.9.6'
+
+  spec.add_runtime_dependency 'faraday', '~> 2.9'
+  spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
+end