semlogr-sinks-seq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be108635842d0272886fa9f86981c5bfceffdbd3583f22dda283bdf40fbc220e
+  data.tar.gz: d2284aea604a7a9bfe929ff49b2f3e00c1245d0c299a6ea1af6056d2c6a2af97
+SHA512:
+  metadata.gz: e048c37bed8374cd78d78c8f8aa637d3aeb669928010fd1de15b716f767d209e38d162a859f724f2b11b20badad92c6512667e963f3c654051ba5abd00c3deaf
+  data.tar.gz: f7a11437f867d83f37a06fc347134182d12c49ddae874438892b05e9babd9879cc8bbc8f98286440eb83835755d69ed86224726e827d416eaf352725da65ceb4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.tags*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  TargetRubyVersion: 2.2
+
+Documentation:
+  Enabled: false
+OrderedGems:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Do not use Rubocop to enforce complexity rules, these will me
+# managed via the PR prorcess to not let in clearly complex code.
+Metrics/ClassLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.13.6

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+### 0.2.1
+
+- Use new semlogr component registry
+
+### 0.1.3
+
+- Rubocop update (nothing useful)
+
+### 0.1.2
+
+- Remove dependency on logstash-logger and implement connection and queue using ruby-stud
+
+### 0.1.1
+
+- Initial release

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+![Codeship Status for semlogr/semlogr](https://codeship.com/projects/9677cdd0-8768-0134-57f3-36c2ccf79a16/status?branch=master)
+
+# Seq sink for Semlogr
+
+This sink provides support for writing logs to [seq](https://getseq.net/), the sink uses [ruby-stud](https://github.com/jordansissel/ruby-stud) to provide batch flushing of events using the Seq HTTP API.
+
+## Installation
+
+To install:
+
+    gem install semlogr-sinks-seq
+
+Or if using bundler, add semlogr to your Gemfile:
+
+    gem 'semlogr-sinks-seq'
+
+then:
+
+    bundle install
+
+## Getting Started
+
+Create an instance of the logger configuring the seq sink with your token.
+
+```ruby
+require 'semlogr'
+require 'semlogr/sinks/seq'
+
+Semlogr.logger = Semlogr.create_logger do |c|
+  c.log_at :info
+
+  c.write_to :seq, server_url: 'http://seq', api_key: '1234'
+end
+
+Semlogr.info('Customer {customer_id} did something interesting', customer_id: 1234)
+```
+
+## Development
+
+After cloning the repository run `bundle install` to get up and running, to run the specs just run `rake spec`.
+
+## Contributing
+
+See anything broken or something you would like to improve? feel free to submit an issue or better yet a pull request!

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'semlogr/sinks/seq'
+require 'pry'
+
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/semlogr/sinks/seq/seq_api.rb

@@ -0,0 +1,29 @@
+require 'faraday'
+
+module Semlogr
+  module Sinks
+    module Seq
+      class SeqApi
+        def initialize(server_url, api_key)
+          @server_url = server_url
+          @api_key = api_key
+        end
+
+        def post_events(payload)
+          connection = Faraday.new(url: @server_url) do |c|
+            c.request   :retry
+            c.response  :raise_error
+            c.adapter   :net_http
+          end
+
+          connection.post('/api/events/raw') do |req|
+            req.headers['Content-Type'] = 'application/vnd.serilog.clef'
+            req.headers['X-Api-Key'] = @api_key if @api_key
+
+            req.body = payload
+          end
+        end
+      end
+    end
+  end
+end

data/lib/semlogr/sinks/seq/sink.rb

@@ -0,0 +1,63 @@
+require 'stud/buffer'
+require 'semlogr/formatters/json_formatter'
+require 'semlogr/sinks/seq/seq_api'
+
+module Semlogr
+  module Sinks
+    module Seq
+      class Sink
+        include Stud::Buffer
+
+        def initialize(opts = {})
+          @options = opts
+          @formatter = Formatters::JsonFormatter.new
+          @client = create_client(opts)
+
+          buffer_initialize(opts)
+        end
+
+        def emit(log_event)
+          buffer_receive(log_event)
+        end
+
+        def flush(log_events, _group = nil)
+          payload = ''
+
+          log_events.each do |log_event|
+            payload << @formatter.format(log_event) do |event|
+              seq_event = event[:properties] || {}
+              seq_event = seq_event.merge(
+                '@t' => event[:timestamp],
+                '@l' => event[:severity],
+                '@mt' => event[:message_template]
+              )
+
+              add_error(seq_event, event[:error])
+
+              seq_event
+            end
+          end
+
+          @client.post_events(payload)
+        end
+
+        private
+
+        def create_client(opts)
+          server_url = opts.fetch(:server_url, 'http://localhost:5341')
+          api_key = opts.fetch(:api_key, nil)
+
+          SeqApi.new(server_url, api_key)
+        end
+
+        def add_error(seq_event, error)
+          return unless error
+          seq_event['@x'] = "#{error[:type]}: #{error[:message]}"
+
+          return unless error[:backtrace] && error[:backtrace].any?
+          seq_event['@x'] += "\n\s\s#{error[:backtrace].join("\n\s\s")}"
+        end
+      end
+    end
+  end
+end

data/lib/semlogr/sinks/seq/version.rb

@@ -0,0 +1,7 @@
+module Semlogr
+  module Sinks
+    module Seq
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

data/lib/semlogr/sinks/seq.rb

@@ -0,0 +1,15 @@
+require 'semlogr/sinks/seq/version'
+require 'semlogr/sinks/seq/sink'
+require 'semlogr/component_registry'
+
+module Semlogr
+  module Sinks
+    module Seq
+      def self.new(opts = {})
+        Sink.new(opts)
+      end
+    end
+
+    ComponentRegistry.register(:sink, seq: Seq)
+  end
+end

data/semlogr-sinks-seq.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'semlogr/sinks/seq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'semlogr-sinks-seq'
+  spec.version       = Semlogr::Sinks::Seq::VERSION
+  spec.authors       = ['Stefan Sedich']
+  spec.email         = ['stefan.sedich@gmail.com']
+
+  spec.summary       = 'A semlogr sink for logging to seq.'
+  spec.description   = 'A semlogr sink for logging to seq.'
+  spec.homepage      = 'https://github.com/semlogr/semlogr-sinks-seq'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'faraday', '~> 0.14'
+  spec.add_dependency 'semlogr', '~> 0.2'
+  spec.add_dependency 'stud', '~> 0.0.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.53'
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: semlogr-sinks-seq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Sedich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: semlogr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: stud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.53'
+description: A semlogr sink for logging to seq.
+email:
+- stefan.sedich@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/semlogr/sinks/seq.rb
+- lib/semlogr/sinks/seq/seq_api.rb
+- lib/semlogr/sinks/seq/sink.rb
+- lib/semlogr/sinks/seq/version.rb
+- semlogr-sinks-seq.gemspec
+homepage: https://github.com/semlogr/semlogr-sinks-seq
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: A semlogr sink for logging to seq.
+test_files: []