riemann-tools 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c06d1c46f6c9c6d78ac614c29ee04f62d18227b2f306719185efcfd3747f56
-  data.tar.gz: e71e90f111b57c7466ac0a6d33e0111525e8192e5c152b64903644bf8be92aa2
+  metadata.gz: 32ac83ea47b36e6632eea36cb430b0c9547b0aaecc3be6b7e10098c8a4c8c5fe
+  data.tar.gz: 4227da1e9388eb3d2b831071db0b21132b51d834167ddfa54c57faa57360672b
 SHA512:
-  metadata.gz: d598a191d654c8be5cdd9d32bd5f99d54f3f86fb062022f4b9ab84b48c8d2cfc5cef2929354082d2b3796c0eb5d7f79dfdf789bfec5b222f295066fb7ca95332
-  data.tar.gz: 0fddd305b30cbdac305a5bcd8cff3f3b139285d9e0d53a27019b5dcf70c12b9b0d29177460b166c7f7d70d1f1cc85d39d11e22c08c47153ef02b49478de80253
+  metadata.gz: 4a218c867ea61f0cb64f581e386861f22a28fcf9a8ab24870ceb20d7239a0224e33df98a0364b513a984d2317695a482257039367ca65eb249f6f8e625b24ba1
+  data.tar.gz: e8310afa539023c8dffb2e3ed3ccf91ebc703ff3939a730823b0001ffa75e9ac28e61f0a014bd8582880900566d6bf2f633e6119d5dd662b1ce97b399e052e66

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -10,11 +10,24 @@ on:
       - main
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Run rubocop
+        run: bundle exec rubocop
   test:
+    needs: lint
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby-version:
+          - 2.6
           - 2.7
           - 3.0
           - 3.1

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '27 16 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.rubocop.yml

@@ -0,0 +1,32 @@
+---
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+Layout/LineLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming/MethodParameterName:
+  AllowedNames:
+    - az # availability zone
+    - id
+    - lb # load balancer
+Style/Documentation:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -1,8 +1,37 @@
 # Changelog
 
-## [1.0.0](https://github.com/riemann/riemann-tools/tree/1.0.0) (2022-06-21)
+## [1.1.0](https://github.com/riemann/riemann-tools/tree/1.1.0) (2022-07-01)
 
-[Full Changelog](https://github.com/riemann/riemann-tools/compare/0.2.14...1.0.0)
+[Full Changelog](https://github.com/riemann/riemann-tools/compare/v1.0.0...1.1.0)
+
+**Implemented enhancements:**
+
+- Report computed disk metric [\#213](https://github.com/riemann/riemann-tools/pull/213) ([smortex](https://github.com/smortex))
+- Add support for FreeBSD system fd monitoring [\#204](https://github.com/riemann/riemann-tools/pull/204) ([smortex](https://github.com/smortex))
+- Improve interface matching flexibility [\#203](https://github.com/riemann/riemann-tools/pull/203) ([smortex](https://github.com/smortex))
+- Improve disk usage reporting [\#200](https://github.com/riemann/riemann-tools/pull/200) ([smortex](https://github.com/smortex))
+
+**Fixed bugs:**
+
+- Revert tmpfs as an ignored filesystem by default [\#206](https://github.com/riemann/riemann-tools/pull/206) ([smortex](https://github.com/smortex))
+- Fix network interfaces reporting [\#202](https://github.com/riemann/riemann-tools/pull/202) ([smortex](https://github.com/smortex))
+- Fix setting custom load thresholds [\#201](https://github.com/riemann/riemann-tools/pull/201) ([smortex](https://github.com/smortex))
+
+**Closed issues:**
+
+- Disk usage resolution is coarse [\#212](https://github.com/riemann/riemann-tools/issues/212)
+- Load warning/critical doesn't work [\#182](https://github.com/riemann/riemann-tools/issues/182)
+
+**Merged pull requests:**
+
+- Modernized riemann-ntp and included warning for macOS [\#211](https://github.com/riemann/riemann-tools/pull/211) ([jamtur01](https://github.com/jamtur01))
+- Create dependabot.yml [\#209](https://github.com/riemann/riemann-tools/pull/209) ([jamtur01](https://github.com/jamtur01))
+- Create codeql-analysis.yml [\#208](https://github.com/riemann/riemann-tools/pull/208) ([jamtur01](https://github.com/jamtur01))
+- Setup Rubocop [\#205](https://github.com/riemann/riemann-tools/pull/205) ([smortex](https://github.com/smortex))
+
+## [v1.0.0](https://github.com/riemann/riemann-tools/tree/v1.0.0) (2022-06-22)
+
+[Full Changelog](https://github.com/riemann/riemann-tools/compare/0.2.14...v1.0.0)
 
 **Implemented enhancements:**
 

data/README.markdown

@@ -1,5 +1,4 @@
-Riemann Tools
-=============
+# Riemann Tools
 
 Tiny programs to submit events to Riemann.
 
@@ -9,18 +8,14 @@ randomly distributed metrics for load testing.
 
 [![Gem Version](https://badge.fury.io/rb/riemann-tools.svg)](https://badge.fury.io/rb/riemann-tools) [![CI](https://github.com/riemann/riemann-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/riemann/riemann-tools/actions/workflows/ci.yml)
 
-
-
-Get started
-===========
+## Get started
 
 ``` bash
 gem install riemann-tools
 riemann-health --host my.riemann.server
 ```
 
-Riemann-tools programs
-======================
+## Riemann-tools programs
 
 This repository contains a number of different programs. Some of them
 ship with the `riemann-tools` gem, including:
@@ -49,18 +44,15 @@ ship with the `riemann-tools` gem, including:
 Also contained in the repository are a number of stand-alone monitoring
 tools, which are shipped as separate gems.
 
-Riemann stand-alone tools
-=========================
+## Riemann stand-alone tools
 
 Use these tools by installing their individual gems, usually named for
-the specific tool, for example:
+the specific tool, for example, to install the AWS tools:
 
 ```bash
 gem install riemann-aws
 ```
 
-To install the AWS tools.
-
 * riemann-aws - Monitor various AWS services.
 * riemann-elasticsearch - Monitor Elasticsearch.
 * riemann-mesos - Monitor Mesos.
@@ -74,20 +66,12 @@ To install the AWS tools.
 There are also a number of additional, stand-alone tools, contained in
 the [Riemann GitHub account](https://github.com/riemann/).
 
-Docker Images
-=============
+## Docker Images
 
 You can find Docker images for the tools [here](https://hub.docker.com/u/riemannio/dashboard/).
 
-Build status
-============
-
-[![Build Status](https://travis-ci.com/riemann/riemann-tools.svg?branch=master)](https://travis-ci.com/riemann/riemann-tools)
-
-License
-=======
+## License
 
 The MIT License
 
-Copyright (c) 2011-2016 Kyle Kingsbury
-
+Copyright (c) 2011-2022 Kyle Kingsbury

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'riemann/tools/version'
 
 require 'bundler/gem_tasks'
@@ -13,9 +15,9 @@ end
 
 desc 'Recursively build all gems'
 task :rbuild do
-  Dir.glob("tools/**") do |dir|
+  Dir.glob('tools/**') do |dir|
     Dir.chdir(dir)
     sh 'rake gem'
-    Dir.chdir("../..")
+    Dir.chdir('../..')
   end
 end

data/SECURITY.md

@@ -0,0 +1,42 @@
+# Riemann Security and Disclosure Information
+This page describes Riemann security and disclosure information.
+
+## Supported Versions
+
+The currently supported version of Riemann for security-patching purposes is always the latest version.
+
+## Security Announcements
+
+Will be made on the [Riemann mailing list](https://groups.google.com/g/riemann-users?pli=1).
+
+## Report a Vulnerability
+
+We're extremely grateful for security researchers and users that report vulnerabilities to Riemann. All reports are thoroughly investigated by the maintainers.
+
+To make a report, you should email the private security@riemann.io list with the details.
+
+## When Should I Report a Vulnerability?
+
+* You think you discovered a potential security vulnerability in Riemann.
+* You are unsure how a vulnerability affects Riemann.
+* You think you discovered a vulnerability in another project that Riemann depends on
+
+For projects with their own vulnerability reporting and disclosure process, please report it directly there.
+
+## When Should I NOT Report a Vulnerability?
+
+* You need help tuning Riemann components for security
+* You need help applying security related updates
+* Your issue is not security related
+
+## Security Vulnerability Response
+
+Each report is acknowledged and analyzed within 5 working days.
+
+Any vulnerability information shared stays within Riemann project and will not be disseminated to other projects unless it is necessary to get the issue fixed.
+
+As the security issue moves from triage, to identified fix, to release planning we will keep the reporter updated.
+
+## Public Disclosure Timing
+
+A public disclosure date is negotiated by the Riemann maintainers nd the bug submitter. We prefer to fully disclose the bug as soon as possible once a user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. For a vulnerability with a straightforward mitigation, we expect report date to disclosure date to be on the order of 7 days. The Riemann maintainers hold the final say when setting a disclosure date.

data/bin/riemann-apache-status

@@ -1,99 +1,113 @@
 #!/usr/bin/env ruby
-Process.setproctitle($0)
+# frozen_string_literal: true
+
+Process.setproctitle($PROGRAM_NAME)
 
 # Collects Apache metrics and submits them to Riemann
 # More information can be found at http://httpd.apache.org/docs/2.4/mod/mod_status.html
 
 # Removes whitespace from 'Total Accesses' and 'Total kBytes' for output to graphite
 
-require File.expand_path('../../lib/riemann/tools', __FILE__)
-
-class Riemann::Tools::ApacheStatus
-  include Riemann::Tools
-  require 'net/http'
-  require 'uri'
-
-  opt :uri, 'Apache Server Status URI', :default => 'http://localhost/server-status'
-
-  def initialize
-    @uri = URI.parse(opts[:uri]) + '?auto'
-    # Sample Response with ExtendedStatus On
-    # Total Accesses: 20643
-    # Total kBytes: 36831
-    # CPULoad: .0180314
-    # Uptime: 43868
-    # ReqPerSec: .470571
-    # BytesPerSec: 859.737
-    # BytesPerReq: 1827.01
-    # BusyWorkers: 6
-    # IdleWorkers: 94
-    # Scoreboard: ___K_____K____________W_
-
-    @scoreboard_map  = { '_' => 'waiting', 'S' => 'starting', 'R' => 'reading', 'W' => 'sending',
-      'K' => 'keepalive', 'D' => 'dns', 'C' => 'closing', 'L' => 'logging', 'G' => 'graceful',
-      'I' => 'idle', '.' => 'open' }
-  end
+require File.expand_path('../lib/riemann/tools', __dir__)
+
+module Riemann
+  module Tools
+    class ApacheStatus
+      include Riemann::Tools
+      require 'net/http'
+      require 'uri'
+
+      opt :uri, 'Apache Server Status URI', default: 'http://localhost/server-status'
+
+      def initialize
+        @uri = "#{URI.parse(opts[:uri])}?auto"
+        # Sample Response with ExtendedStatus On
+        # Total Accesses: 20643
+        # Total kBytes: 36831
+        # CPULoad: .0180314
+        # Uptime: 43868
+        # ReqPerSec: .470571
+        # BytesPerSec: 859.737
+        # BytesPerReq: 1827.01
+        # BusyWorkers: 6
+        # IdleWorkers: 94
+        # Scoreboard: ___K_____K____________W_
+
+        @scoreboard_map = {
+          '_' => 'waiting',
+          'S' => 'starting',
+          'R' => 'reading',
+          'W' => 'sending',
+          'K' => 'keepalive',
+          'D' => 'dns',
+          'C' => 'closing',
+          'L' => 'logging',
+          'G' => 'graceful',
+          'I' => 'idle',
+          '.' => 'open',
+        }
+      end
 
+      def get_scoreboard_metrics(response)
+        results = Hash.new(0)
 
-  def get_scoreboard_metrics(response)
-    results = Hash.new(0)
+        response.slice! 'Scoreboard: '
+        response.each_char do |char|
+          results[char] += 1
+        end
+        results.transform_keys { |k| @scoreboard_map[k] }
+      end
 
-    response.slice! 'Scoreboard: '
-    response.each_char do |char|
-      results[char] += 1
-    end
-    Hash[results.map { |k, v| [@scoreboard_map[k], v] }]
-  end
+      def report_metrics(metrics)
+        metrics.each do |k, v|
+          report(
+            service: "httpd #{k}",
+            metric: v.to_f,
+            state: 'ok',
+            tags: ['httpd'],
+          )
+        end
+      end
 
-  def report_metrics(metrics)
-    metrics.each do |k, v|
-      report(
-        :service  => "httpd #{k}",
-        :metric   => v.to_f,
-        :state    => 'ok',
-        :tags     => ['httpd']
-      )
-    end
-  end
+      def connection
+        response = nil
+        begin
+          response = Net::HTTP.get(@uri)
+        rescue StandardError => e
+          report(
+            service: 'httpd health',
+            state: 'critical',
+            description: "Httpd connection error: #{e.class} - #{e.message}",
+            tags: ['httpd'],
+          )
+        else
+          report(
+            service: 'httpd health',
+            state: 'ok',
+            description: 'Httpd connection status ok',
+            tags: ['httpd'],
+          )
+        end
+        response
+      end
 
-  def get_connection
-    response = nil
-    begin
-      response = Net::HTTP.get(@uri)
-    rescue => e
-      report(
-        :service     => 'httpd health',
-        :state       => 'critical',
-        :description => 'Httpd connection error: #{e.class} - #{e.message}',
-        :tags        => ['httpd']
-      )
-    else
-      report(
-        :service     => 'httpd health',
-        :state       => 'ok',
-        :description => 'Httpd connection status ok',
-        :tags        => ['httpd']
-      )
-    end
-    response
-  end
+      def tick
+        return if (response = connection).nil?
 
-  def tick
-    unless (response = get_connection).nil?
-      response.each_line do |line|
-        metrics = Hash.new
+        response.each_line do |line|
+          metrics = {}
 
-        if line =~ /Scoreboard/
-          metrics = get_scoreboard_metrics(line.strip)
-        else
-          key, value = line.strip.split(':')
-          metrics[key.gsub(/\s/, '')] = value
+          if line =~ /Scoreboard/
+            metrics = get_scoreboard_metrics(line.strip)
+          else
+            key, value = line.strip.split(':')
+            metrics[key.gsub(/\s/, '')] = value
+          end
+          report_metrics(metrics)
         end
-        report_metrics(metrics)
       end
     end
   end
-
 end
 
 Riemann::Tools::ApacheStatus.run

data/bin/riemann-bench

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
-Process.setproctitle($0)
+# frozen_string_literal: true
+
+Process.setproctitle($PROGRAM_NAME)
 
 # Connects to a server (first arg) and populates it with a constant stream of
 # events for testing.
@@ -8,62 +10,65 @@ require 'rubygems'
 require 'riemann/client'
 require 'pp'
 
-class Riemann::Bench
-  attr_accessor :client, :hosts, :services, :states
-  def initialize
-    @hosts = [nil] + (0...10).map { |i| "host#{i}" }
-    @hosts = %w(a b c d e f g h i j)
-    @services = %w(test1 test2 test3 foo bar baz xyzzy attack cat treat)
-    @states = {}
-    @client = Riemann::Client.new(:host => (ARGV.first || 'localhost'))
-  end
+module Riemann
+  class Bench
+    attr_accessor :client, :hosts, :services, :states
+
+    def initialize
+      @hosts = [nil] + (0...10).map { |i| "host#{i}" }
+      @hosts = %w[a b c d e f g h i j]
+      @services = %w[test1 test2 test3 foo bar baz xyzzy attack cat treat]
+      @states = {}
+      @client = Riemann::Client.new(host: (ARGV.first || 'localhost'))
+    end
+
+    def evolve(state)
+      m = state[:metric] + (rand - 0.5) * 0.1
+      m = [[0, m].max, 1].min
 
-  def evolve(state)
-    m = state[:metric] + (rand - 0.5) * 0.1
-    m = [[0,m].max, 1].min
+      s = case m
+          when 0...0.75
+            'ok'
+          when 0.75...0.9
+            'warning'
+          when 0.9..1.0
+            'critical'
+          end
 
-    s = case m
-    when 0...0.75
-      'ok'
-    when 0.75...0.9
-      'warning'
-    when 0.9..1.0
-      'critical'
+      {
+        metric: m,
+        state: s,
+        host: state[:host],
+        service: state[:service],
+        description: "at #{Time.now}",
+      }
     end
 
-    {
-      :metric => m,
-      :state => s,
-      :host => state[:host],
-      :service => state[:service],
-      :description => "at #{Time.now}"
-    }
-  end
-  
-  def tick
-#    pp @states
-    hosts.product(services).each do |id|
-      client << (states[id] = evolve(states[id]))
+    def tick
+      #    pp @states
+      hosts.product(services).each do |id|
+        client << (states[id] = evolve(states[id]))
+      end
     end
-  end
 
-  def run
-    start
-    loop do
-      sleep 0.05
-      tick
+    def run
+      start
+      loop do
+        sleep 0.05
+        tick
+      end
     end
-  end
 
-  def start
-    hosts.product(services).each do |host, service|
-      states[[host, service]] = {
-        :metric => 0.5,
-        :state => 'ok',
-        :description => "Starting up",
-        :host => host,
-        :service => service
-      }
+    def start
+      hosts.product(services).each do |host, service|
+        states[[host, service]] = {
+          metric: 0.5,
+          state: 'ok',
+          description: 'Starting up',
+          host: host,
+          service: service,
+        }
+      end
     end
   end
 end