fluent-plugin-honeycomb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 694235673dc407b31637ece8465a3d29d751a4a7
+  data.tar.gz: 2f1418e09051f5943099aa544a5b34ef67482c44
+SHA512:
+  metadata.gz: 50c888610e2a75b816a260f00e7d328e1229a1ba85d12ffe73ee6c3b8029ab0e64984f44e6f5e2e1e3f7f67811e1b601eb811a9cfb50d4148ff65bd70dfcdef9
+  data.tar.gz: 8292d2a3f871f44014e95dd6b9d884569ecde0002d2271747edad121a1cdc0c9219f2cc49e5a0dd27e2fb67accb2698facb3249a50afc23b3f68399415fc3e00

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 2.2

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+   Copyright 2017 Honeycomb
+
+   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.

data/README.md

@@ -0,0 +1,52 @@
+
+## Getting started
+
+1. Install this plugin with `gem install fluent-plugin-honeycomb`
+
+2. Edit your `fluentd.conf` configuration file. A minimal configuration looks like this:
+
+```
+<match your_match>
+  @type honeycomb
+  writekey "YOUR_WRITEKEY"
+  dataset "fluentd_test_dataset"
+</match>
+```
+
+## Configuration
+
+### Basic options
+
+Parameter | Type | Required? | Description
+| --- | --- | --- | --- |
+| `writekey` | string | yes | Your Honeycomb write key. |
+| `dataset` | string | yes | The name of the destination dataset in your Honeycomb account. |
+| `sample_rate` | integer | no | Sample your event stream by sending 1 out of every N events. |
+| `include_tag_key` | bool | no | Whether to include the Fluentd tag in the submitted event. |
+| `tag_key` | string | no | If `include_tag_key` is `true`, the tag key name in the event (default: `fluentd_tag`).
+
+### Buffering options
+
+`fluent-plugin-honeycomb` supports the [standard configuration options](http://docs.fluentd.org/v0.12/articles/buffer-plugin-overview) for buffered output plugins.
+
+## Limitations
+
+`fluent-plugin-honeycomb` does not currently batch events. This functionality should be implemented in `libhoney-rb`.
+
+## Development
+I recommend using [rbenv](https://github.com/rbenv/rbenv) for development.
+
+To set up Fluentd, run:
+
+```
+gem install fluentd
+fluentd --setup ./fluent
+```
+
+Edit the configuration file at `./fluent/fluent.conf`, then run
+
+```
+fluentd -c ./fluent/fluent.conf -v
+```
+
+A note about naming: This gem must be named `fluent-plugin-xxx` in order to automatically be included in Fluentd's plugin list. See http://www.fluentd.org/faqs.

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-honeycomb.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'fluent-plugin-honeycomb'
+  spec.version     = '0.1.1'
+  spec.date        = '2017-02-07'
+
+  spec.summary     = "send data to Honeycomb"
+  spec.description = "Ruby gem for sending data to Honeycomb"
+  spec.authors     = ['The Honeycomb.io Team']
+  spec.email       = 'support@honeycomb.io'
+  spec.files       = []
+  spec.homepage    = 'https://github.com/honeycombio/fluent-plugin-honeycomb'
+  spec.license     = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.add_runtime_dependency "libhoney", "~> 1.0"
+  spec.add_runtime_dependency "fluentd", "~> 0.12"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "test-unit"
+end

data/lib/fluent/plugin/out_honeycomb.rb

@@ -0,0 +1,67 @@
+require 'fluent/output'
+require 'libhoney'
+
+module Fluent
+  class HoneycombOutput < BufferedOutput
+    # First, register the plugin. NAME is the name of this plugin
+    # and identifies the plugin in the configuration file.
+    Fluent::Plugin.register_output('honeycomb', self)
+
+    # config_param defines a parameter. You can refer a parameter via @path instance variable
+    # Without :default, a parameter is required.
+    config_param :writekey, :string
+    config_param :dataset, :string
+    config_param :sample_rate, :integer, :default => 1
+    config_param :include_tag_key, :bool, :default => false
+    config_param :tag_key, :string, :default => "fluentd_tag"
+    config_param :api_host, :string, :default => "https://api.honeycomb.io"
+
+    # This method is called before starting.
+    # 'conf' is a Hash that includes configuration parameters.
+    # If the configuration is invalid, raise Fluent::ConfigError.
+    def configure(conf)
+      super
+
+      # You can also refer raw parameter via conf[name].
+      @path = conf['path']
+    end
+
+    # This method is called when starting.
+    # Open sockets or files here.
+    def start
+      super
+      @client = Libhoney::Client.new(:writekey => @writekey,
+                                     :dataset => @dataset,
+                                     :sample_rate => @sample_rate,
+                                     :api_host => @api_host)
+    end
+
+    # This method is called when shutting down.
+    # Shutdown the thread and close sockets or files here.
+    def shutdown
+      super
+      # Drain libhoney request queue before shutting down.
+      @client.close(true)
+    end
+
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    # This method is called every flush interval. Write the buffer chunk
+    # to files or databases here.
+    # 'chunk' is a buffer chunk that includes multiple formatted
+    # events. You can use 'data = chunk.read' to get all events and
+    # 'chunk.open {|io| ... }' to get IO objects.
+    #
+    # NOTE! This method is called by internal thread, not Fluentd's main thread. So IO wait doesn't affect other plugins.
+    def write(chunk)
+      chunk.msgpack_each do |(tag, time, record)|
+        if @include_tag_key
+          record[@tag_key] = tag
+        end
+        @client.send_now(record)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-honeycomb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- The Honeycomb.io Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: libhoney
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem for sending data to Honeycomb
+email: support@honeycomb.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-honeycomb.gemspec
+- lib/fluent/plugin/out_honeycomb.rb
+homepage: https://github.com/honeycombio/fluent-plugin-honeycomb
+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: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: send data to Honeycomb
+test_files: []