fluent-plugin-papertrail-urlbox 0.2.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9df9ae3225c6b929ef1cb05ca769f38603c517adc01ea36924e2b34783713a0f
+  data.tar.gz: 17c1b0b16cc980c7567beb694c74c017830a12b1f70a04387eb4db27e813b9e2
+SHA512:
+  metadata.gz: 024a919566133dd2f805f5068f7290468751e05b14c8ac6eeffc25034bc3fe08fb06383a9ab49e44de06bcb006eb2c485908970d62fd2fab9a411fbdb4c9718d
+  data.tar.gz: 6fc7b9eabf2a25a4678fbf6c5d1ba47dabf8c5101f27f77656d38b52e0e430ce1b2d04d9bd745d69be536aca8ef0c1d4fbd8863cad1aa3827ba087c8bac3f755

data/.circleci/config.yml

@@ -0,0 +1,51 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.3
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+        
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            bundle exec rake test
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.gitignore

@@ -0,0 +1,13 @@
+.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/vendor/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM fluent/fluentd:v1.7-1
+
+# Use root account to use apk
+USER root
+
+# below RUN includes plugins - you may customize including plugins as you wish
+RUN apk add --no-cache --update --virtual .build-deps \
+        sudo build-base ruby-dev git \
+ && sudo gem install fluent-plugin-papertrail \
+ && sudo gem sources --clear-all \
+ && apk del .build-deps \
+ && rm -rf /tmp/* /var/tmp/* /usr/lib/ruby/gems/*/cache/*.gem
+
+USER fluent

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-papertrail.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,217 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2018 SolarWinds Worldwide, LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+------------------------------------------------
+
+This software includes portions of syslog_protocol from https://github.com/eric/syslog_protocol/
+under the following MIT license:
+
+The MIT License (MIT)
+
+Copyright (c) 2013 Jake Douglas and Eric Lindvall
+
+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/Makefile

@@ -0,0 +1,12 @@
+REPO_NAME=fluent-plugin-papertrail-urlbox
+
+bundle:
+	bundle install
+
+test: bundle
+	bundle exec rake test
+
+release: bundle
+	rm -rf ${REPO_NAME}-*.gem
+	bundle exec gem build ${REPO_NAME}.gemspec
+	bundle exec gem push ${REPO_NAME}-*.gem

data/README.md

@@ -0,0 +1,122 @@
+# Fluent::Plugin::Papertrail
+
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-papertrail.svg)](https://badge.fury.io/rb/fluent-plugin-papertrail) [![CircleCI](https://circleci.com/gh/solarwinds/fluent-plugin-papertrail/tree/master.svg?style=shield)](https://circleci.com/gh/solarwinds/fluent-plugin-papertrail/tree/master)
+
+## Description
+
+This repository contains the Fluentd Papertrail Output Plugin.
+
+## Installation
+
+Install this gem when setting up fluentd:
+```ruby
+gem install fluent-plugin-papertrail
+```
+
+## Usage
+
+### Setup
+
+This plugin connects to Papertrail log destinations over TCP+TLS. This connection method should be enabled by default in standard Papertrail accounts, see:
+```
+papertrailapp.com > Settings > Log Destinations
+```
+
+To configure this in fluentd:
+```xml
+<match whatever.*>
+  type papertrail
+  papertrail_host <your papertrail hostname>
+  papertrail_port <your papertrail port>
+</match>
+```
+
+### Configuring a record_transformer
+
+This plugin expects the following fields to be set for each Fluent record:
+```
+    message   The log
+    program   The program/tag
+    severity  A valid syslog severity label
+    facility  A valid syslog facility label
+    hostname  The source hostname for papertrail logging
+```
+
+The following example is a `record_transformer` filter, from the Kubernetes assets [in the Solarwinds fluentd-deployment repo](https://github.com/solarwinds/fluentd-deployment/blob/master/docker/conf/kubernetes.conf), that is used along with the [fluent-plugin-kubernetes_metadata_filter](https://github.com/fabric8io/fluent-plugin-kubernetes_metadata_filter) to populate the required fields for our plugin:
+```yaml
+<filter kubernetes.**>
+  type kubernetes_metadata
+</filter>
+
+<filter kubernetes.**>
+  type record_transformer
+  enable_ruby true
+  <record>
+    hostname ${record["kubernetes"]["namespace_name"]}-${record["kubernetes"]["pod_name"]}
+    program ${record["kubernetes"]["container_name"]}
+    severity info
+    facility local0
+    message ${record['log']}
+  </record>
+</filter>
+```
+
+If you don't set `hostname` and `program` values in your record, they will default to the environment variable `FLUENT_HOSTNAME` or `'unidentified'` and the fluent tag, respectively.
+
+### Advanced Configuration
+This plugin inherits a few useful config parameters from Fluent's `BufferedOutput` class.
+
+Parameters for flushing the buffer, based on size and time, are `buffer_chunk_limit` and `flush_interval`, respectively. This plugin overrides the inherited default `flush_interval` to `1`, causing the fluent buffer to flush to Papertrail every second. 
+
+If the plugin fails to write to Papertrail for any reason, the log message will be put back in Fluent's buffer and retried. Retrying can be tuned and inherits a default configuration where `retry_wait` is set to `1` second and `retry_limit` is set to `17` attempts.
+
+If you want to change any of these parameters simply add them to a match stanza. For example, to flush the buffer every 60 seconds and stop retrying after 2 attempts, set something like:
+```xml
+<match whatever.*>
+  type papertrail
+  papertrail_host <your papertrail hostname>
+  papertrail_port <your papertrail port>
+  flush_interval 60
+  retry_limit 2
+</match>
+```
+
+## Kubernetes Annotations
+
+If you're running this plugin in Kubernetes with the kubernetes_metadata_filter plugin enabled you can redirect logs to alternate Papertrail destinations by adding annotations to your Pods or Namespaces:
+
+```
+solarwinds.io/papertrail_host: 'logs0.papertrailapp.com'
+solarwinds.io/papertrail_port: '12345'
+```
+
+If both the Pod and Namespace have annotations for any running Pod, the Pod's annotation is used.
+
+## Development
+
+This plugin is targeting Ruby 2.4 and Fluentd v1.0, although it should work with older versions of both.
+
+We have a [Makefile](Makefile) to wrap common functions and make life easier.
+
+### Install Dependencies
+`make bundle`
+
+### Test
+`make test`
+
+### Release in [RubyGems](https://rubygems.org/gems/fluent-plugin-papertrail)
+To release a new version, update the version number in the [GemSpec](fluent-plugin-papertrail.gemspec) and then, run:
+
+`make release`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at: https://github.com/solarwinds/fluent-plugin-papertrail
+
+## License
+
+The gem is available as open source under the terms of the [Apache License](LICENSE).
+
+# Questions/Comments?
+
+Please [open an issue](https://github.com/solarwinds/fluent-plugin-papertrail/issues/new), we'd love to hear from you.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/fluent-plugin-papertrail-urlbox.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-papertrail-urlbox"
+  spec.version       = "0.2.10"
+  spec.authors       = ["Jonathan Lozinski", "Alex Ouzounis", "Chris Rust", "Chris Erway","Chris Roebuck"]
+  spec.email         = ["jonathan.lozinski@solarwinds.com", "alex.ouzounis@solarwinds.com", "chris.rust@solarwinds.com", "chris.erway@solarwinds.com", "chris@urlbox.io"]
+
+  spec.summary       = %q{Remote Syslog Output Fluentd plugin for papertrail}
+  spec.description   = %q{Remote Syslog Output Fluentd plugin for papertrail}
+  spec.homepage      = "https://github.com/urlbox/fluent-plugin-papertrail"
+  spec.license       = "Apache-2.0"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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 "fluentd", '>= 0.10', '< 2'
+  spec.add_dependency "fluent-mixin-config-placeholders", "~> 0.4.0"
+
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "test-unit", "~> 3.5"
+end

data/lib/fluent/plugin/out_papertrail.rb

@@ -0,0 +1,149 @@
+require 'syslog_protocol'
+
+module Fluent
+  class Papertrail < Fluent::BufferedOutput
+    class SocketFailureError < StandardError; end
+    attr_accessor :sockets
+
+    # if left empty in fluent config these config_param's will error
+    config_param :papertrail_host, :string
+    config_param :papertrail_port, :integer
+    # default to ENV['FLUENT_HOSTNAME'] or :default_hostname if no hostname in record
+    config_param :default_hostname, :string, default: 'unidentified'
+    # overriding default flush_interval (60 sec) from Fluent::BufferedOutput
+    config_param :flush_interval, :time, default: 1
+    config_param :discard_unannotated_pod_logs, :bool, default: false
+    config_param :maximum_syslog_packet_size, :integer, default: 99990
+    config_param :fallback_severity, :string, default: 'info'
+
+    # register as 'papertrail' fluent plugin
+    Fluent::Plugin.register_output('papertrail', self)
+
+    # declare const string for nullifying token if we decide to discard records
+    DISCARD_STRING = 'DISCARD'
+
+    def configure(conf)
+      super
+      # create initial sockets hash and socket based on config param
+      @sockets = {}
+      socket_key = form_socket_key(@papertrail_host, @papertrail_port)
+      @sockets[socket_key] = create_socket(socket_key)
+      # redefine default hostname if it's been passed in through ENV
+      @default_hostname = ENV['FLUENT_HOSTNAME'] || @default_hostname
+      @fallback_severity = ENV['FLUENT_FALLBACK_SEVERITY'] || @fallback_severity
+    end
+
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    def write(chunk)
+      chunk.msgpack_each {|(tag, time, record)|
+        socket_key = pick_socket(record)
+        unless socket_key.eql? form_socket_key(DISCARD_STRING, DISCARD_STRING)
+          # recreate the socket if it's nil
+          @sockets[socket_key] ||= create_socket(socket_key)
+          packet = create_packet(tag, time, record)
+          send_to_papertrail(packet, socket_key)
+        end
+      }
+    end
+
+    def form_socket_key(host, port)
+      "#{host}:#{port}"
+    end
+
+    def split_socket_key(socket_key)
+      socket_key_arr = socket_key.split(':')
+      return socket_key_arr[0], socket_key_arr[1]
+    end
+
+    def create_socket(socket_key)
+      log.info "initializing tcp socket for #{socket_key}"
+      begin
+        host, port = split_socket_key(socket_key)
+        socket = TCPSocket.new(host, port)
+        log.debug "enabling ssl for socket #{socket_key}"
+        ssl = OpenSSL::SSL::SSLSocket.new(socket)
+        # close tcp and ssl socket when either fails
+        ssl.sync_close = true
+        # initiate SSL/TLS handshake with server
+        ssl.connect
+      rescue => e
+        log.warn "failed to create tcp socket #{socket_key}: #{e}"
+        ssl = nil
+      end
+      ssl
+    end
+
+    def create_packet(tag, time, record)
+      # construct syslog packet from fluent record
+      packet = SyslogProtocol::Packet.new
+      packet.hostname = record['hostname'] || @default_hostname
+      packet.facility = record['facility'] || 'local0'
+      begin
+        packet.severity = record['severity'] || 'info'
+      rescue ArgumentError
+        packet.severity = @fallback_severity
+      end
+      packet.tag      = record['program'] || tag
+      packet.content  = record['message'] || record['log']
+      packet.time     = time ? Time.at(time) : Time.now
+      packet
+    end
+
+    def pick_socket(record)
+      # if kubernetes pod has papertrail destination as annotation, use it
+      if record.dig('kubernetes', 'annotations', 'solarwinds_io/papertrail_host') && \
+         record.dig('kubernetes', 'annotations', 'solarwinds_io/papertrail_port')
+        host = record['kubernetes']['annotations']['solarwinds_io/papertrail_host']
+        port = record['kubernetes']['annotations']['solarwinds_io/papertrail_port']
+      # else if kubernetes namespace has papertrail destination as annotation, use it
+      elsif record.dig('kubernetes', 'namespace_annotations', 'solarwinds_io/papertrail_host') && \
+            record.dig('kubernetes', 'namespace_annotations', 'solarwinds_io/papertrail_port')
+        host = record['kubernetes']['namespace_annotations']['solarwinds_io/papertrail_host']
+        port = record['kubernetes']['namespace_annotations']['solarwinds_io/papertrail_port']
+      # else if it is a kubernetes log and we're discarding unannotated logs
+      elsif @discard_unannotated_pod_logs && record.dig('kubernetes')
+        host = DISCARD_STRING
+        port = DISCARD_STRING
+      # else use pre-configured destination
+      else
+        host = @papertrail_host
+        port = @papertrail_port
+      end
+      socket_key = form_socket_key(host, port)
+
+      if socket_key == ':'
+        kubernetes_err_msg = ''
+        if record.dig('kubernetes', 'namespace_name')
+          namespace_name = record['kubernetes']['namespace_name']
+          kubernetes_err_msg = " from Kubernetes namespace: \"#{namespace_name}\""
+        end
+        log.warn("Received nil socket_configuration#{kubernetes_err_msg}. Discarding message.")
+        host = DISCARD_STRING
+        port = DISCARD_STRING
+        socket_key = form_socket_key(host, port)
+      end
+
+      socket_key
+    end
+
+    def send_to_papertrail(packet, socket_key)
+      if @sockets[socket_key].nil?
+        err_msg = "Unable to create socket with #{socket_key}"
+        raise SocketFailureError, err_msg
+      else
+        begin
+          # send it
+          @sockets[socket_key].puts packet.assemble(max_size=@maximum_syslog_packet_size)
+        rescue => e
+          err_msg = "Error writing to #{socket_key}: #{e}"
+          # socket failed, reset to nil to recreate for the next write
+          @sockets[socket_key] = nil
+          raise SocketFailureError, err_msg, e.backtrace
+        end
+      end
+    end
+  end
+end

data/lib/syslog_protocol/common.rb

@@ -0,0 +1,79 @@
+module SyslogProtocol
+  # These hashes stolen from Syslog.pm
+  
+  FACILITIES = {
+    'kern'     => 0,
+    'user'     => 1,
+    'mail'     => 2,
+    'daemon'   => 3,
+    'auth'     => 4,
+    'syslog'   => 5,
+    'lpr'      => 6,
+    'news'     => 7,
+    'uucp'     => 8,
+    'cron'     => 9,
+    'authpriv' => 10,
+    'ftp'      => 11,
+    'ntp'      => 12,
+    'audit'    => 13,
+    'alert'    => 14,
+    'at'       => 15,
+    'local0'   => 16,
+    'local1'   => 17,
+    'local2'   => 18,
+    'local3'   => 19,
+    'local4'   => 20,
+    'local5'   => 21,
+    'local6'   => 22,
+    'local7'   => 23
+  }
+  
+  FACILITY_INDEX = {
+    0   => 'kern',
+    1   => 'user',
+    2   => 'mail',
+    3   => 'daemon',
+    4   => 'auth',
+    5   => 'syslog',
+    6   => 'lpr',
+    7   => 'news',
+    8   => 'uucp',
+    9   => 'cron',
+    10  => 'authpriv',
+    11  => 'ftp',
+    12  => 'ntp',
+    13  => 'audit',
+    14  => 'alert',
+    15  => 'at',
+    16  => 'local0',
+    17  => 'local1',
+    18  => 'local2',
+    19  => 'local3',
+    20  => 'local4',
+    21  => 'local5',
+    22  => 'local6',
+    23  => 'local7'
+  }
+  
+  SEVERITIES = {
+    'emerg'   => 0,
+    'alert'   => 1,
+    'crit'    => 2,
+    'err'     => 3,
+    'warn'    => 4,
+    'notice'  => 5,
+    'info'    => 6,
+    'debug'   => 7 
+  }
+  
+  SEVERITY_INDEX = {
+    0  => 'emerg',
+    1  => 'alert',
+    2  => 'crit',
+    3  => 'err',
+    4  => 'warn',
+    5  => 'notice',
+    6  => 'info',
+    7  => 'debug'
+  }
+end

data/lib/syslog_protocol/logger.rb

@@ -0,0 +1,21 @@
+module SyslogProtocol
+  class Logger
+    def initialize(hostname, tag, facility)
+      @packet = Packet.new
+      @packet.hostname = hostname
+      @packet.tag      = tag
+      @packet.facility = facility
+    end
+    
+    SEVERITIES.each do |k,v|
+      define_method(k) do |content|
+        raise ArgumentError.new("Message may not be omitted") unless content and content.length > 0
+
+        p = @packet.dup
+        p.severity = k
+        p.content = content
+        p.assemble
+      end
+    end
+  end
+end

data/lib/syslog_protocol/packet.rb

@@ -0,0 +1,135 @@
+module SyslogProtocol
+  class Packet
+    attr_reader :facility, :severity, :hostname, :tag
+    attr_accessor :time, :content
+
+    def to_s
+      assemble
+    end
+
+    def assemble(max_size = 1024)
+      unless @hostname and @facility and @severity and @tag
+        raise "Could not assemble packet without hostname, tag, facility, and severity"
+      end
+      data = "<#{pri}>#{generate_timestamp} #{@hostname} #{@tag}: #{@content}"
+
+      if string_bytesize(data) > max_size
+        data = data.slice(0, max_size)
+        while string_bytesize(data) > max_size
+          data = data.slice(0, data.length - 1)
+        end
+      end
+
+      data
+    end
+
+    def facility=(f)
+      if f.is_a? Integer
+        if (0..23).include?(f)
+          @facility = f
+        else
+          raise ArgumentError.new "Facility must be within 0-23"
+        end
+      elsif f.is_a? String
+        if facility = FACILITIES[f]
+          @facility = facility
+        else
+          raise ArgumentError.new "'#{f}' is not a designated facility"
+        end
+      else
+        raise ArgumentError.new "Facility must be a designated number or string"
+      end
+    end
+
+    def tag=(t)
+      unless t && t.is_a?(String) && t.length > 0
+        raise ArgumentError, "Tag must not be omitted"
+      end
+      if t.length > 1024
+        raise ArgumentError, "Tag must not be longer than 1024 characters"
+      end
+      if t =~ /\s/
+        raise ArgumentError, "Tag may not contain spaces"
+      end
+      if t =~ /[^\x21-\x7E]/
+        raise ArgumentError, "Tag may only contain ASCII characters 33-126"
+      end
+
+      @tag = t
+    end
+
+    def severity=(s)
+      if s.is_a? Integer
+        if (0..7).include?(s)
+          @severity = s
+        else
+          raise ArgumentError.new "Severity must be within 0-7"
+        end
+      elsif s.is_a? String
+        if severity = SEVERITIES[s.downcase]
+          @severity = severity
+        else
+          raise ArgumentError.new "'#{s}' is not a designated severity"
+        end
+      else
+        raise ArgumentError.new "Severity must be a designated number or string"
+      end
+    end
+
+    def hostname=(h)
+      unless h and h.is_a? String and h.length > 0
+        raise ArgumentError.new("Hostname may not be omitted")
+      end
+      if h =~ /\s/
+        raise ArgumentError.new("Hostname may not contain spaces")
+      end
+      if h =~ /[^\x21-\x7E]/
+        raise ArgumentError.new("Hostname may only contain ASCII characters 33-126")
+      end
+      @hostname = h
+    end
+
+    def facility_name
+      FACILITY_INDEX[@facility]
+    end
+
+    def severity_name
+      SEVERITY_INDEX[@severity]
+    end
+
+    def pri
+      (@facility * 8) + @severity
+    end
+
+    def pri=(p)
+      unless p.is_a? Integer and (0..191).include?(p)
+        raise ArgumentError.new "PRI must be a number between 0 and 191"
+      end
+      @facility = p / 8
+      @severity = p - (@facility * 8)
+    end
+
+    def generate_timestamp
+      time = @time || Time.now
+      # The timestamp format requires that a day with fewer than 2 digits have
+      # what would normally be a preceding zero, be instead an extra space.
+      day = time.strftime("%d")
+      day = day.sub(/^0/, ' ') if day =~ /^0\d/
+      time.strftime("%b #{day} %H:%M:%S")
+    end
+
+    if "".respond_to?(:bytesize)
+      def string_bytesize(string)
+        string.bytesize
+      end
+    else
+      def string_bytesize(string)
+        string.length
+      end
+    end
+
+    SEVERITIES.each do |k,v|
+      define_method("#{k}?") { SEVERITIES[k] == @severity }
+    end
+  end
+end

data/lib/syslog_protocol/parser.rb

@@ -0,0 +1,57 @@
+require 'time'
+
+module SyslogProtocol
+  
+  def self.parse(msg, origin=nil)
+    packet = Packet.new
+    original_msg = msg.dup
+    pri = parse_pri(msg)
+    if pri and (pri = pri.to_i).is_a? Integer and (0..191).include?(pri)
+      packet.pri = pri
+    else
+      # If there isn't a valid PRI, treat the entire message as content
+      packet.pri = 13
+      packet.time = Time.now
+      packet.hostname = origin || 'unknown'
+      packet.content = original_msg
+      return packet
+    end
+    time = parse_time(msg)
+    if time
+      packet.time = Time.parse(time)
+    else
+      packet.time = Time.now
+    end
+    hostname = parse_hostname(msg)
+    packet.hostname = hostname || origin
+    if m = msg.match(/^(\w+)(: | )(.*)$/)
+      packet.tag = m[1]
+      packet.content = m[3]
+    else
+      packet.tag = 'unknown'
+      packet.content = msg
+    end
+    packet
+  end
+  
+  private
+  
+  def self.parse_pri(msg)
+    pri = msg.slice!(/<(\d\d?\d?)>/)
+    pri = pri.slice(/\d\d?\d?/) if pri
+    if !pri or (pri =~ /^0/ and pri !~ /^0$/)
+      return nil
+    else
+      return pri
+    end
+  end
+  
+  def self.parse_time(msg)
+    msg.slice!(/(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s(\s|[1-9])\d\s\d\d:\d\d:\d\d\s/)
+  end
+  
+  def self.parse_hostname(msg)
+    msg.slice!(/^[\x21-\x7E]+\s/).rstrip
+  end
+  
+end

data/lib/syslog_protocol.rb

@@ -0,0 +1,8 @@
+require 'syslog_protocol/common'
+require 'syslog_protocol/packet'
+require 'syslog_protocol/logger'
+require 'syslog_protocol/parser'
+
+module SyslogProtocol
+  VERSION = '0.9.2'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-papertrail-urlbox
+version: !ruby/object:Gem::Version
+  version: 0.2.10
+platform: ruby
+authors:
+- Jonathan Lozinski
+- Alex Ouzounis
+- Chris Rust
+- Chris Erway
+- Chris Roebuck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: fluent-mixin-config-placeholders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Remote Syslog Output Fluentd plugin for papertrail
+email:
+- jonathan.lozinski@solarwinds.com
+- alex.ouzounis@solarwinds.com
+- chris.rust@solarwinds.com
+- chris.erway@solarwinds.com
+- chris@urlbox.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- Dockerfile
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- fluent-plugin-papertrail-urlbox.gemspec
+- lib/fluent/plugin/out_papertrail.rb
+- lib/syslog_protocol.rb
+- lib/syslog_protocol/common.rb
+- lib/syslog_protocol/logger.rb
+- lib/syslog_protocol/packet.rb
+- lib/syslog_protocol/parser.rb
+homepage: https://github.com/urlbox/fluent-plugin-papertrail
+licenses:
+- Apache-2.0
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Remote Syslog Output Fluentd plugin for papertrail
+test_files: []