fluent-plugin-logtail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0c8596cf46b0faa3a9d7e580d453d0cec5af12bd1b75d42232f72c57a834a7b
+  data.tar.gz: 60b7f73e13bedafe63b2cbfb80338ba15644387c292312471cff7247e333df5d
+SHA512:
+  metadata.gz: 4103a98491a69624c5354facafd04735c3ba85a2ceb2d8c179435e46f9c82e0ce3376287717e830635c75842ee22aed02822d2cf1afe1f1a931dc820ae2cc063
+  data.tar.gz: 83bb7f6e2b67ad1700f1b59b1f52efaa4d33d386e671e98af0dd7b8686df93bb44188f66a7ec42dfad10412df7bbe47323894cf11e39314e8e1fc026f0e98629

data/.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-20.04
+
+    strategy:
+      matrix:
+        ruby-version:
+          - 3.0.0
+          - 2.7.2
+          - 2.6.6
+          - 2.5.8
+          - 2.4.10
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,16 @@
+.DS_Store
+.rvmrc
+.ruby-version
+coverage
+*.swp
+*.gem
+Gemfile.lock
+
+gemfiles/*.lock
+
+/.bundle
+/.yardoc
+/doc
+/log
+/tmp
+/pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,15 @@
+# License
+
+Copyright (c) 2021, Logtail
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# 🪵 Fluent::Plugin::Logtail, a plugin for [Fluentd](http://fluentd.org)
+
+[![build](https://github.com/logtail/fluentd-plugin-logtail/actions/workflows/main.yml/badge.svg)](https://github.com/logtail/fluentd-plugin-logtail/actions/workflows/main.yml)
+
+A Fluentd plugin that delivers events to the [Logtail.com logging service](https://logtail.com). It uses batching, msgpack, and retry logic for highly efficient and reliable delivery of log data.
+
+## Installation
+
+```
+gem install fluent-plugin-logtail
+```
+
+## Usage
+
+In your Fluentd configuration, use `@type logtail`:
+
+```
+<match your_match>
+  @type logtail
+  source_token YOUR_SOURCE_TOKEN
+  # ip 127.0.0.1
+  buffer_chunk_limit 1m                      # Must be < 5m
+  flush_at_shutdown true                     # Only needed with file buffer
+</match>
+```
+
+## Configuration
+
+* `source_token` - This is your [Logtail source token](https://logtail.com).
+
+For advanced configuration options, please see to the [buffered output parameters documentation.](http://docs.fluentd.org/articles/output-plugin-overview#buffered-output-parameters).

data/fluent-plugin-logtail.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name        = 'fluent-plugin-logtail'
+  s.version     = '0.1.0'
+  s.date        = Date.today.to_s
+  s.summary     = 'Logtail.com plugin for Fluentd'
+  s.description = 'Streams Fluentd logs to the Logtail.com logging service.'
+  s.authors     = ['Logtail.com']
+  s.email       = 'hello@logtail.com'
+  s.homepage    = 'https://github.com/logtail/fluent-plugin-logtail'
+  s.license     = 'ISC'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = Gem::Requirement.new(">= 2.4.0".freeze)
+
+  s.add_runtime_dependency('fluentd', '> 1', '< 2')
+  s.add_runtime_dependency('http', '~> 2.0', '>= 2.0.3')
+
+  s.add_development_dependency('rspec', '~> 3.4')
+  s.add_development_dependency('test-unit', '~> 3.3.9')
+  s.add_development_dependency('webmock', '~> 2.3')
+end

data/lib/fluent/plugin/out_logtail.rb

@@ -0,0 +1,80 @@
+require 'fluent/output'
+
+module Fluent
+  class LogtailOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('logtail', self)
+
+    VERSION = "0.1.0".freeze
+    CONTENT_TYPE = "application/msgpack".freeze
+    HOST = "https://in.logtail.com".freeze
+    PATH = "/".freeze
+    MAX_ATTEMPTS = 3.freeze
+    RETRYABLE_CODES = [429, 500, 502, 503, 504].freeze
+    USER_AGENT = "Logtail Logstash/#{VERSION}".freeze
+
+    config_param :source_token, :string, secret: true
+    config_param :ip, :string, default: nil
+
+    def configure(conf)
+      source_token = conf["source_token"]
+      @headers = {
+        "Authorization" => "Bearer #{source_token}",
+        "Content-Type" => CONTENT_TYPE,
+        "User-Agent" => USER_AGENT
+      }
+      super
+    end
+
+    def start
+      super
+      require 'http'
+      HTTP.default_options = {:keep_alive_timeout => 29}
+      @http_client = HTTP.persistent(HOST)
+    end
+
+    def shutdown
+      @http_client.close if @http_client
+      super
+    end
+
+    def format(tag, time, record)
+      record.merge("dt" => Time.at(time).utc.iso8601).to_msgpack
+    end
+
+    def write(chunk)
+      deliver(chunk, 1)
+    end
+
+    private
+      def deliver(chunk, attempt)
+        if attempt > MAX_ATTEMPTS
+          log.error("msg=\"Max attempts exceeded dropping chunk\" attempt=#{attempt}")
+          return false
+        end
+
+        body = chunk.read
+        response = @http_client.headers(@headers).post(PATH, body: body)
+        response.flush
+        code = response.code
+
+        if code >= 200 && code <= 299
+          true
+        elsif RETRYABLE_CODES.include?(code)
+          sleep_time = sleep_for_attempt(attempt)
+          log.warn("msg=\"Retryable response from the Logtail API\" " +
+            "code=#{code} attempt=#{attempt} sleep=#{sleep_time}")
+          sleep(sleep_time)
+          deliver(chunk, attempt + 1)
+        else
+          log.error("msg=\"Fatal response from the Logtail API\" code=#{code} attempt=#{attempt}")
+          false
+        end
+      end
+
+      def sleep_for_attempt(attempt)
+        sleep_for = attempt ** 2
+        sleep_for = sleep_for <= 60 ? sleep_for : 60
+        (sleep_for / 2) + (rand(0..sleep_for) / 2)
+      end
+  end
+end

data/spec/fluent/plugin/out_logtail_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+require "fluent/plugin/out_logtail"
+
+describe Fluent::LogtailOutput do
+  let(:config) do
+    %{
+      source_token  abcd1234
+    }
+  end
+
+  let(:driver) do
+    tag = "test"
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::LogtailOutput, tag) {
+      # v0.12's test driver assume format definition. This simulates ObjectBufferedOutput format
+      if !defined?(Fluent::Plugin::Output)
+        def format(tag, time, record)
+          [time, record].to_msgpack
+        end
+      end
+    }.configure(config)
+  end
+  let(:record) do
+    {'age' => 26, 'request_id' => '42', 'parent_id' => 'parent', 'routing_id' => 'routing'}
+  end
+
+  before(:each) do
+    Fluent::Test.setup
+  end
+
+  describe "#write" do
+    it "should send a chunked request to the Logtail API" do
+      stub = stub_request(:post, "https://in.logtail.com/").
+        with(
+          :body => start_with("\x85\xA3age\x1A\xAArequest_id\xA242\xA9parent_id\xA6parent\xAArouting_id\xA7routing\xA2dt\xB4".force_encoding("ASCII-8BIT")),
+          :headers => {'Authorization'=>'Bearer abcd1234', 'Connection'=>'Keep-Alive', 'Content-Type'=>'application/msgpack', 'User-Agent'=>'Logtail Logstash/0.1.0'}
+        ).
+        to_return(:status => 200, :body => "", :headers => {})
+
+      driver.emit(record)
+      driver.run
+
+      expect(stub).to have_been_requested.times(1)
+    end
+
+    it "handles 500s" do
+      stub = stub_request(:post, "https://in.logtail.com/").to_return(:status => 500, :body => "", :headers => {})
+
+      driver.emit(record)
+      driver.run
+
+      expect(stub).to have_been_requested.times(3)
+    end
+
+    it "handle auth failures" do
+      stub = stub_request(:post, "https://in.logtail.com/").to_return(:status => 403, :body => "", :headers => {})
+
+      driver.emit(record)
+      driver.run
+
+      expect(stub).to have_been_requested.times(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# Base
+require 'rubygems'
+require 'bundler/setup'
+
+# Testing
+require 'rspec'
+
+# Webmock
+require 'webmock/rspec'
+WebMock.disable_net_connect!
+
+# Fluent
+require "fluent/test"
+
+# Rspec
+RSpec.configure do |config|
+  config.color = true
+  config.order = :random
+  config.warnings = false
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-logtail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Logtail.com
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.9
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Streams Fluentd logs to the Logtail.com logging service.
+email: hello@logtail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- README.md
+- fluent-plugin-logtail.gemspec
+- lib/fluent/plugin/out_logtail.rb
+- spec/fluent/plugin/out_logtail_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/logtail/fluent-plugin-logtail
+licenses:
+- ISC
+metadata: {}
+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.2.3
+signing_key:
+specification_version: 4
+summary: Logtail.com plugin for Fluentd
+test_files:
+- spec/fluent/plugin/out_logtail_spec.rb
+- spec/spec_helper.rb