riemann-opensearch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ad75c8e4d2492c09bf3d837e26f95d7afc4969c840ea981cae193ba047b2a0c
+  data.tar.gz: becbc3a64ac8adfc216d614821638bad5c9cdda449f8398a6d7ddd48ba86e3dc
+SHA512:
+  metadata.gz: 29d052cff7131832712db0b85493af178c8a4d10b3ee81270da43978747d86811b3a0e687fb8c0099dddf626dcd343f73e1fa37fcc8d6f1cc84cedc33146d4fe
+  data.tar.gz: 4763cf0dfb57bbabaacffd8db98c8df6c0ca06e42c160edfdb3c77d0c9f08a70494b760faf6e70d9282d5a1b078346de2c38efd0ea88d707995a74ce62823f38

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at romain@blogreen.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in riemann-opensearch.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Romain Tartière
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# riemann-opensearch
+
+Send OpenSearch metrics to Riemann.
+
+## Get started
+
+```
+$ gem install riemann-opensearch
+```
+
+See `riemann-opensearch --help` for options.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/opus-codium/riemann-opensearch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/riemann-opensearch/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the riemann-opensearch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/opus-codium/riemann-opensearch/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[standard spec]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "riemann/opensearch"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/riemann-opensearch

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+Process.setproctitle($PROGRAM_NAME)
+
+require "riemann/tools/opensearch"
+
+Riemann::Tools::OpenSearch.run

data/lib/riemann/tools/opensearch.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require "riemann/tools"
+require "opensearch-ruby"
+
+module Riemann
+  module Tools
+    class OpenSearch
+      class JsonMapper
+        def initialize(values)
+          values.each do |k, v|
+            components = k.split(".")
+            last_component = components.pop
+
+            s = self
+            components.each do |c|
+              s = s.send(c)
+            end
+            s.send(:"#{last_component}=", normalize(v))
+          end
+        end
+
+        def normalize(value)
+          case value
+          when "true" then true
+          when "false" then false
+          when /\A\d+\z/ then value.to_i
+          when /\A\d+\.\d+\z/ then value.to_f
+          when /\A\d+\.\d+%\z/ then value.to_f * 0.01
+          when "-" then nil
+          else value
+          end
+        end
+      end
+
+      class Allocation < JsonMapper
+        class Disk
+          attr_accessor :indices, :used, :avail, :total, :percent
+        end
+
+        attr_accessor :shards, :disk, :host, :ip, :node
+
+        def initialize(values)
+          # @disk = Disk.new
+          @disk = Struct.new(:indices, :used, :avail, :total, :percent).new
+          super
+        end
+      end
+
+      class Health < JsonMapper
+        class Node
+          attr_accessor :total, :data
+        end
+
+        attr_accessor :epoch, :timestamp, :cluster, :status, :node, :discovered_cluster_manager, :shards, :pri, :relo, :init, :unassign, :pending_tasks, :max_task_wait_time, :active_shards_percent
+
+        def initialize(values)
+          @node = Node.new
+          super
+        end
+      end
+
+      include Riemann::Tools
+
+      opt :os_host, "OpenSearch cluster to connect to", short: :none, default: "https://admin:admin@localhost:9200"
+      opt :os_ca_cert, "Path to CA certificate file", short: :none, type: :string
+      opt :os_cert, "Path to certificate file", short: :none, type: :string
+      opt :os_key, "Path to key file", short: :none, type: :string
+      opt :os_insecure, "Do not check remote host certificate", short: "-k", default: false
+
+      opt :os_shard_allocation_warning, "Shard allocation warning threshold", short: :none, default: 0.90
+      opt :os_shard_allocation_error, "Shard allocation error threshold", short: :none, default: 0.95
+
+      opt :os_disk_usage_warning, "Disk usage warning threshold", short: :none, default: 0.90
+      opt :os_disk_usage_error, "Disk usage error threshold", short: :none, default: 0.95
+
+      HEALTH_STATUS_STATE = {
+        "green" => :ok,
+        "yellow" => :warning,
+        "red" => :critical
+      }
+
+      def tick
+        invalidate_cache
+
+        @client = ::OpenSearch::Client.new(
+          host: opts[:os_host],
+          transport_options: {
+            ssl: {
+              ca_file: opts[:os_ca_cert],
+              client_cert: opts[:os_cert],
+              client_key: opts[:os_key],
+              verify: !opts[:os_insecure]
+            }
+          }
+        )
+
+        report({
+          service: "#{health.cluster} cluster health",
+          state: HEALTH_STATUS_STATE[health.status],
+          description: health.status
+        })
+
+        max_shards_per_node = setting("cluster.max_shards_per_node")
+        allocations.each do |allocation|
+          report({
+            service: "#{health.cluster} #{allocation.node} shard allocation",
+            state: shard_allocation_state(allocation.shards, max_shards_per_node),
+            metric: allocation.shards,
+            description: "#{allocation.shards}/#{max_shards_per_node}"
+          })
+
+          usage = allocation.disk.used.to_f / allocation.disk.total
+          report({
+            service: "#{health.cluster} #{allocation.node} disk usage",
+            state: disk_usage_state(usage),
+            metric: usage,
+            description: format("%.3f %%", usage * 100)
+          })
+        end
+      end
+
+      def allocations
+        @allocations ||= @client.cat.allocation(format: "json", bytes: "b").map do |allocation|
+          Allocation.new(allocation)
+        end
+      end
+
+      def health
+        @health ||= @client.cat.health(format: "json").map do |health|
+          Health.new(health)
+        end.first
+      end
+
+      def settings
+        @settings ||= @client.cluster.get_settings(include_defaults: true)
+      end
+
+      def setting(name)
+        pieces = name.split(".")
+
+        value = settings.dig(*(["persistent"] + pieces)) ||
+          settings.dig(*(["transient"] + pieces)) ||
+          settings.dig(*(["defaults"] + pieces))
+
+        Integer(value)
+      rescue ArgumentError
+        value
+      end
+
+      def disk_usage_state(usage)
+        if usage >= opts[:os_disk_usage_error]
+          :critical
+        elsif usage >= opts[:os_disk_usage_warning]
+          :warning
+        else
+          :ok
+        end
+      end
+
+      def shard_allocation_state(count, limit)
+        if count >= opts[:os_shard_allocation_error] * limit
+          :critical
+        elsif count >= opts[:os_shard_allocation_warning] * limit
+          :warning
+        else
+          :ok
+        end
+      end
+
+      private
+
+      def invalidate_cache
+        @allocations = nil
+        @health = nil
+        @settings = nil
+      end
+    end
+  end
+end

data/riemann-opensearch.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "riemann-opensearch"
+  spec.version = "0.0.1"
+  spec.authors = ["Romain Tartière"]
+  spec.email = ["romain@blogreen.org"]
+
+  spec.summary = "Send OpenSearch metrics to Riemann"
+  spec.homepage = "https://github.com/opus-codium/riemann-opensearch"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables =
+    spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday-net_http_persistent"
+  spec.add_dependency "opensearch-ruby", "~> 3.0"
+  spec.add_dependency "riemann-tools", "~> 1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: riemann-opensearch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Romain Tartière
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opensearch-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: riemann-tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- romain@blogreen.org
+executables:
+- riemann-opensearch
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/riemann-opensearch
+- lib/riemann/tools/opensearch.rb
+- riemann-opensearch.gemspec
+homepage: https://github.com/opus-codium/riemann-opensearch
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/opus-codium/riemann-opensearch
+  source_code_uri: https://github.com/opus-codium/riemann-opensearch
+  changelog_uri: https://github.com/opus-codium/riemann-opensearch
+  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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: Send OpenSearch metrics to Riemann
+test_files: []