fluent-plugin-timber 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 496cd7f7702fb5c4753cd01e1f5757956110b873
-  data.tar.gz: dcb578e403619c54d9bbd4b631f432d532300d70
+  metadata.gz: 44b8ee267100fb87a1db9fa3937a26da452bc0f8
+  data.tar.gz: 8776259a74b9ca2c1c05e2c7abb0c3710748ade0
 SHA512:
-  metadata.gz: 94c65c0c0f837a5f1c0fbbe776e3487ad61a6ec1390116150f6164643f77c8862265685f6032bfe41f0b73e6050c21b6c9ab769ad6b2fe5d3272d13aea608b33
-  data.tar.gz: 6eaa933afbd1a11dd58a2bde616e7fa7f76c7a3ea32958a70e3c55c8cf6167cec0c56b4805f936fbb8d91bd8c8219c3e3a9b27fbdabd9d96f36e0613a40bfdd0
+  metadata.gz: '02820d632dc32d924a557f8be3b647c72ca8c1646602998305ed3b24bd7ed108a7489090c0f202b033c32f1635bf2761e06e71a1f14a0cd7b88e59ebe8734edb'
+  data.tar.gz: 982bff76269b31ee9f25b8322b608691534113a9ca6f0a0e0db3a09479b22c0c9351637aa5f49eb14ba4ab71bccf0f0870ec9cc18599b72dc22f1eb8cb765211

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.2.6
+- 2.3.3
+- 2.4.1
+before_script:
+- echo $BUNDLE_GEMFILE
+- bundle install
+script: bundle exec rspec

data/README.md

@@ -1,4 +1,4 @@
-# Fluent::Plugin::Timber, a plugin for [Fluentd](http://fluentd.org)
+# 🌲 Fluent::Plugin::Timber, a plugin for [Fluentd](http://fluentd.org)
 
 [![Gem Version](https://badge.fury.io/rb/fluent-plugin-timber.png)](http://badge.fury.io/rb/fluent-plugin-timber)
 [![Build Status](https://travis-ci.org/timberio/fluent-plugin-timber.png?branch=master)](https://travis-ci.org/timberio/fluent-plugin-timber)
@@ -9,9 +9,19 @@ A highly efficient Fluentd plugin that delivers events to the [Timber.io logging
 
 [Timber.io](https://timber.io) is a different kind of logging service with a focus on modern logging best-practices: easy setup, structured data, fast clean usable interface, 6 months of searchable retention, threshold based alerts, simple graphing, and more. Learn more at [https://timber.io](https://timber.io).
 
+## Installation
+
+```
+gem install fluent-plugin-timber
+```
+
+## Usage
+
+In your Fluentd configuration, use @type timber:
+
 ```
 <match your_match>
-  type timber
+  @type timber
   api_key xxxxxxxxxxxxxxxxxxxxxxxxxxx        # Your Timber API (required)
   hostname "#{Socket.gethostname}"           # Your hostname (required)
   # ip 127.0.0.1                             # IP address (optional)
@@ -20,6 +30,14 @@ A highly efficient Fluentd plugin that delivers events to the [Timber.io logging
 </match>
 ```
 
+## Configuration
+
+* `api_key` - This is your Timber API key. You can obtain your key by creating an app in the [Timber console](https://app.timber.io). Registration is one click. If you already have an app, you can locate your API in your app's settings. [See our API key docs](https://timber.io/docs/app/advanced/api-keys/).
+* `hostname` - This adds `hostname` as context to your logs, making it easy to filter by hostname in the [Timber console](https://app.timber.io).
+* `ip` - This adds `ip` as context to your logs, making it easy to filter by IP address in the [Timber console](https://app.timber.io).
+
 For advanced configuration options, please see to the [buffered output parameters documentation.](http://docs.fluentd.org/articles/output-plugin-overview#buffered-output-parameters).
 
+---
+
 Questions? Need help? [support@timber.io](mailto:support@timber.io).

data/fluent-plugin-timber.gemspec

@@ -3,7 +3,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name        = 'fluent-plugin-timber'
-  s.version     = '1.0.0'
+  s.version     = '1.0.1'
   s.date        = Date.today.to_s
   s.summary     = 'Timber.io plugin for Fluentd'
   s.description = 'Streams Fluentd logs to the Timber.io logging service.'

data/lib/fluent/plugin/out_timber.rb

@@ -7,8 +7,8 @@ module Fluent
   class TimberOutput < Fluent::BufferedOutput
     Fluent::Plugin.register_output('timber', self)
 
-    VERSION = "1.0.0".freeze
-    CONTENT_TYPE = "application/json".freeze
+    VERSION = "1.0.1".freeze
+    CONTENT_TYPE = "application/msgpack".freeze
     HOST = "https://logs.timber.io".freeze
     MAX_ATTEMPTS = 3.freeze
     PATH = "/frames".freeze

data/spec/fluent/plugin/out_timber_spec.rb

@@ -33,7 +33,7 @@ describe Fluent::TimberOutput do
       stub = stub_request(:post, "https://logs.timber.io/frames").
         with(
           :body => start_with("\x85\xA3age\x1A\xAArequest_id\xA242\xA9parent_id\xA6parent\xAArouting_id\xA7routing\xA2dt\xB4".force_encoding("ASCII-8BIT")),
-          :headers => {'Authorization'=>'Basic YWJjZDEyMzQ=', 'Connection'=>'Keep-Alive', 'Content-Type'=>'application/json', 'User-Agent'=>'Timber Logstash/1.0.0'}
+          :headers => {'Authorization'=>'Basic YWJjZDEyMzQ=', 'Connection'=>'Keep-Alive', 'Content-Type'=>'application/msgpack', 'User-Agent'=>'Timber Logstash/1.0.0'}
         ).
         to_return(:status => 200, :body => "", :headers => {})
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-timber
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Timber.io
@@ -99,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.md