rack-influxdb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 692f56fbc15ce9112783e0a51f3a323e32bcb1063db207d38684d66ef11f0c45
+  data.tar.gz: b6d827637d9b7162a69b04682846ffbb372bce98af6b2fa547d6d2a0dd967864
+SHA512:
+  metadata.gz: 12047f80e2e445e38b03304590ab8b77d197d6ab6061f3e68bef009dca49e40aad006cf2eac593ec33012f9af2dd3054fda4c9ab84eedc1fc9cb4ef98b33d02b
+  data.tar.gz: 31cdc1e24c9e4931e545d93139a7fa4709fbc03597f3a6891f60bca98cbd695b2422fab94779af62f4f5716bf636c26891a734169fd31af69654cc3fd6b23145

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Chimpy
+
+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,80 @@
+# rack-influxdb
+
+[![Continuous Integration](https://github.com/heychimpy/rack-influxdb/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/heychimpy/rack-influxdb/actions/workflows/test.yml)
+
+This gem provides a Rack middleware for [InfluxDB](https://github.com/influxdata/influxdb).
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Configuration](#configuration)
+  - [Basic usage](#basic-usage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-influxdb'
+```
+
+Then run:
+
+```ruby
+bundle
+```
+
+## Usage
+
+### Configuration
+The Rack::InfluxDB gem can be easily configured
+
+```ruby
+Rack::InfluxDB.configure do |config|
+  # The name of your measurement
+  config.name = "http_requests"
+
+  # Custom tags
+  config.tags = { app: "my-awesome-api", env: "production" }
+
+  # The URL of your InfluxDB instance
+  config.url = "https://test.influxdb.example.com"
+
+  # The API token provided by InfluxDB
+  config.token = "topsecret"
+
+  # A lambda that returns a hash containing the fields to write.
+  # E.g. to just track the HTTP status:
+  config.fields = lambda { |env, response| return { status: response[0] } }
+
+  # Handle errors individually
+  config.handle_errors = lambda { |err| report_error(err) }
+
+  # Options like Org, Bucket and Precision
+  config.options = {
+    org: 'my-org',
+    bucket: 'my-bucket',
+    precision: InfluxDB2::WritePrecision::MILLISECOND
+  }
+
+  # Write options - it's highly recommended to use batching and not
+  # synchronous writing.
+  config.write_options = {
+    write_type: InfluxDB2::WriteType::BATCHING,
+    batch_size: 1_000
+  }
+end
+```
+
+### Basic usage
+All you have to do is to include the middleware in your Rack stack. 
+
+In Rails:
+
+```ruby
+# config/application.rb
+
+class Application < Rails::Application
+  ...
+  config.middleware.use Rack::InfluxDB
+end
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/rack/influxdb/configuration.rb

@@ -0,0 +1,33 @@
+module Rack
+  class InfluxDB
+    class Configuration
+      attr_accessor :name, :tags, :url, :token, :options, :write_options,
+                    :fields, :handle_error
+
+      def initialize
+        set_defaults
+      end
+
+      private
+
+      def set_defaults
+        @name = 'http_requests'
+        @tags = {}
+        @url = ''
+        @token = ''
+        @fields = lambda { |env, response| return {} }
+        @handle_error = lambda { |err| return }
+        @options = {
+          org: '',
+          bucket: '',
+          precision: InfluxDB2::WritePrecision::MILLISECOND
+        }
+
+        @write_options = InfluxDB2::WriteOptions.new(
+          write_type: InfluxDB2::WriteType::BATCHING,
+          batch_size: 100,
+        )
+      end
+    end
+  end
+end

data/lib/rack/influxdb/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class InfluxDB
+    VERSION = '0.1.0'
+  end
+end

data/lib/rack/influxdb.rb

@@ -0,0 +1,63 @@
+require 'influxdb-client'
+require 'rack/influxdb/configuration'
+
+module Rack
+  class InfluxDB
+    class << self
+      attr_reader :configuration
+
+      def configuration
+        @configuration ||= Rack::InfluxDB::Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @app.call(env).tap { |response| write_request(env, response) }
+    end
+
+    private
+
+    def write_request(env, response)
+      # The presence or absence of a token implicitly determines whether it
+      # should be executed at all. This allows this gem to run in each
+      # environment.
+      return if config.token.to_s.empty?
+
+      # Run the write logic inside a thread so we don't slow down
+      # main request.
+      Thread.new do
+        begin
+          InfluxDB2::Client.use(config.url, config.token, **config.options) do |c|
+            write_api = c.create_write_api(write_options: config.write_options)
+            write_api.write(data: point(env, response))
+          end
+        rescue => e
+          config.handle_error.call(e)
+        end
+      end
+    rescue => e
+      # Let the app decide what needs to be done when an error occurs.
+      config.handle_error.call(e)
+    end
+
+    def point(env, response)
+      {
+        name: config.name,
+        tags: config.tags,
+        fields: config.fields.call(env, response)
+      }
+    end
+
+    def config
+      Rack::InfluxDB.configuration
+    end
+  end
+end

data/spec/rack_influxdb_spec.rb

@@ -0,0 +1,113 @@
+require_relative './spec_helper'
+
+RSpec.describe Rack::InfluxDB do
+  describe '.configuration' do
+    it 'returns a new instance of Rack::InfluxDB::Configuration' do
+      expect(described_class.configuration)
+        .to be_a(Rack::InfluxDB::Configuration)
+    end
+
+    it 'memoizes the configuration' do
+      conf = described_class.configuration
+
+      expect(described_class.configuration).to eq(conf)
+    end
+  end
+
+  describe '.configure' do
+    it 'passes the configuration object to block' do
+      conf = described_class.configuration
+
+      expect { |block| described_class.configure(&block) }.to \
+        yield_with_args(conf)
+    end
+
+    it 'saves new configuration values' do
+      described_class.configure do |config|
+        config.name = 'test_name'
+      end
+
+      expect(described_class.configuration.name).to eq('test_name')
+    end
+  end
+
+  describe '#call' do
+    before do
+      allow(Thread).to receive(:new).and_yield
+    end
+
+    it 'returns the initial status code' do
+      get '/'
+
+      expect(last_response.status).to eq(200)
+    end
+
+    it 'returns the initial body' do
+      get '/'
+
+      expect(last_response.body).to eq('Hello World')
+    end
+
+    context 'when no config token is given' do
+      it 'does not call InfluxDB2::Client.use' do
+        expect(InfluxDB2::Client).not_to receive(:use)
+
+        get '/'
+      end
+    end
+
+    context 'when config token is given' do
+      before do
+        allow(InfluxDB2::Client).to receive(:use)
+
+        described_class.configure do |config|
+          config.token = "token"
+          config.url = "example.com"
+        end
+      end
+
+      let(:conf) { described_class.configuration }
+
+      it 'calls InfluxDB2::Client.use with right params' do
+        get '/'
+
+        expect(InfluxDB2::Client)
+          .to have_received(:use)
+          .with(conf.url, conf.token, conf.options)
+      end
+    end
+
+    context 'when an error occurs' do
+      before do
+        allow(InfluxDB2::Client).to receive(:use).and_raise('Could not write')
+
+        described_class.configure do |config|
+          config.token = "token"
+          config.url = "example.com"
+        end
+      end
+
+      it 'the error is swallowed' do
+        expect { get '/' }.not_to raise_error
+      end
+
+      it 'returns the initial status code' do
+        get '/'
+
+        expect(last_response.status).to eq(200)
+      end
+
+      context 'when custom error handling is applied' do
+        before do
+          described_class.configure do |config|
+            config.handle_error = ->(e) { raise e }
+          end
+        end
+
+        it 'it gets handled (re-raised)' do
+          expect { get '/' }.to raise_error('Could not write')
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'bundler/setup'
+
+require 'rack'
+require 'rack/test'
+require 'rack/influxdb'
+
+# The dummy app which includes the Rack::InfluxDB middleware.
+def app
+  Rack::Builder.new do
+    # Include the InfluxDB middleware.
+    use Rack::InfluxDB
+
+    run lambda { |_env| [200, {}, ['Hello World']] }
+  end.to_app
+end
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+
+  config.expect_with :rspec do |conf|
+    conf.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rack-influxdb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Henning Vogt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: influxdb-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: A rack middleware for logging requests to InfluxDB
+email: tech@heychimpy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack/influxdb.rb
+- lib/rack/influxdb/configuration.rb
+- lib/rack/influxdb/version.rb
+- spec/rack_influxdb_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/heychimpy/rack-influxdb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key: 
+specification_version: 4
+summary: Log HTTP requests to InfluxDB
+test_files:
+- spec/rack_influxdb_spec.rb
+- spec/spec_helper.rb