cabin-es 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +10 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +84 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/cabin-es.gemspec +38 -0
- data/lib/cabin/es.rb +8 -0
- data/lib/cabin/es/version.rb +5 -0
- data/lib/cabin/outputs/elastic_search.rb +28 -0
- metadata +112 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 832bce7cbb88ad24a9565a823ceed93701d74516
|
4
|
+
data.tar.gz: 6194b13528cbd44ff616bb3878b2ad565effcb46
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: fcf3ebe7c7d42c6c41cc23c02d80eaa5bfb71bc1b95b5c59027f6e479889093e0eb15c9199763a5de38c7de1c466d0e31c7038726c339931daf692c191952349
|
7
|
+
data.tar.gz: 72676a61d90a83f7d5578e3519c51cf38c118d958a1a4e59cb1b642fac0fcede09aed455235efb92e9ac6c83c392646b8dbcb2a5b84c1f1fbd468e5c1305b3aa
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Stark Riedesel
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,84 @@
|
|
1
|
+
# Cabin - ElasticSearch
|
2
|
+
|
3
|
+
[ElasticSearch](https://www.elastic.co/) output provider for the [Ruby Cabin](https://github.com/jordansissel/ruby-cabin) logging framework.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'cabin-es', require: 'cabin/es'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install cabin-es
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Used just like any other Cabin output plugin:
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'cabin'
|
27
|
+
require 'cabin/es'
|
28
|
+
|
29
|
+
# Create a new Cabin channel
|
30
|
+
@logger = Cabin::Channel.new
|
31
|
+
|
32
|
+
# Subscribe to an ElasticSearch host
|
33
|
+
es = Cabin::Output::ElasticSearch.new(url: 'http://elasticsearch.example.com:9200', index: 'cabin', type: 'log')
|
34
|
+
@logger.subscribe(es)
|
35
|
+
|
36
|
+
# Send logs just like normal
|
37
|
+
@logger.info "Test Message", {some: 'data', nested { data: 'is cool' }}
|
38
|
+
|
39
|
+
# Set the ElasticSearch "_type" on a per-message basis
|
40
|
+
@logger.info "Special Message", {some: 'data', _type: 'special'}
|
41
|
+
```
|
42
|
+
|
43
|
+
Message and data fields are imported into ElasticSearch as you would expect
|
44
|
+
```json
|
45
|
+
{
|
46
|
+
"_index": "cabin",
|
47
|
+
"_type": "log",
|
48
|
+
"_id": "AVgrn6PBq2Wn7-YPg6FT",
|
49
|
+
"_score": null,
|
50
|
+
"_source": {
|
51
|
+
"timestamp": "2016-11-03T14:17:12.076636-0500",
|
52
|
+
"message": "Test Message",
|
53
|
+
"level": "info",
|
54
|
+
"some": "data",
|
55
|
+
"nested": {
|
56
|
+
"data": "is cool"
|
57
|
+
}
|
58
|
+
},
|
59
|
+
"fields": {
|
60
|
+
"timestamp": [
|
61
|
+
1478200632076
|
62
|
+
]
|
63
|
+
},
|
64
|
+
"sort": [
|
65
|
+
1478200632076
|
66
|
+
]
|
67
|
+
}
|
68
|
+
```
|
69
|
+
|
70
|
+
## Development
|
71
|
+
|
72
|
+
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
73
|
+
|
74
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
75
|
+
|
76
|
+
## Contributing
|
77
|
+
|
78
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/starkriedesel/cabin-es.
|
79
|
+
|
80
|
+
|
81
|
+
## License
|
82
|
+
|
83
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
84
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "cabin/es"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
data/cabin-es.gemspec
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'cabin/es/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "cabin-es"
|
8
|
+
spec.version = Cabin::Es::VERSION
|
9
|
+
spec.authors = ["Stark Riedesel"]
|
10
|
+
spec.email = ["starkriedesel@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{ElasticSearch output provider for the Ruby Cabin logging framework}
|
13
|
+
spec.description = %q{ElasticSearch output provider for the Ruby Cabin logging framewor}
|
14
|
+
spec.homepage = "https://www.github.com/starkriedesel/cabin-es"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
18
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
19
|
+
if spec.respond_to?(:metadata)
|
20
|
+
spec.metadata['allowed_push_host'] = "https://rubygems.org"
|
21
|
+
else
|
22
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
23
|
+
"public gem pushes."
|
24
|
+
end
|
25
|
+
|
26
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
27
|
+
f.match(%r{^(test|spec|features)/})
|
28
|
+
end
|
29
|
+
spec.bindir = "bin"
|
30
|
+
spec.executables = []
|
31
|
+
spec.require_paths = ["lib"]
|
32
|
+
|
33
|
+
spec.add_development_dependency "bundler", "~> 1.13"
|
34
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
35
|
+
|
36
|
+
spec.add_runtime_dependency "cabin", "~> 0.9.0"
|
37
|
+
spec.add_runtime_dependency "elasticsearch", "~> 2.0.0"
|
38
|
+
end
|
data/lib/cabin/es.rb
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
require 'cabin'
|
2
|
+
require 'elasticsearch'
|
3
|
+
|
4
|
+
class Cabin::Outputs::ElasticSearch
|
5
|
+
attr_accessor :settings, :es
|
6
|
+
|
7
|
+
def initialize(args={})
|
8
|
+
logger = args.delete 'logger'
|
9
|
+
self.settings = {index: 'cabin', type: 'cabin'}.merge(args)
|
10
|
+
sanity_check!
|
11
|
+
self.es = Elasticsearch::Client.new urls: settings[:urls], logger: logger
|
12
|
+
end
|
13
|
+
|
14
|
+
def sanity_check!
|
15
|
+
settings[:urls] ||= [settings.delete(:url)] if settings.key? :url
|
16
|
+
[:index, :type].each {|x| settings[x] = settings[x].to_s}
|
17
|
+
raise Exception.new 'Index must be not blank for Cabin::Outputs::ElasticSearch' if settings[:index] =~ /^\s*$/
|
18
|
+
raise Exception.new 'Type must be not blank for Cabin::Outputs::ElasticSearch' if settings[:type] =~ /^\s*$/
|
19
|
+
raise Exception.new 'At least one URL must be provided to Cabin::Outputs::ElasticSearch' if settings[:urls].nil? or settings[:urls].count == 0
|
20
|
+
end
|
21
|
+
|
22
|
+
def <<(event)
|
23
|
+
type = event.delete :_type
|
24
|
+
type = event.delete "_type" if type.nil?
|
25
|
+
type = settings[:type] if type.nil?
|
26
|
+
es.index index: settings[:index], type: type.to_s, body: event
|
27
|
+
end
|
28
|
+
end
|
metadata
ADDED
@@ -0,0 +1,112 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: cabin-es
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Stark Riedesel
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-11-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.13'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.13'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: cabin
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: 0.9.0
|
48
|
+
type: :runtime
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: 0.9.0
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: elasticsearch
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 2.0.0
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 2.0.0
|
69
|
+
description: ElasticSearch output provider for the Ruby Cabin logging framewor
|
70
|
+
email:
|
71
|
+
- starkriedesel@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- Gemfile
|
78
|
+
- LICENSE.txt
|
79
|
+
- README.md
|
80
|
+
- Rakefile
|
81
|
+
- bin/console
|
82
|
+
- bin/setup
|
83
|
+
- cabin-es.gemspec
|
84
|
+
- lib/cabin/es.rb
|
85
|
+
- lib/cabin/es/version.rb
|
86
|
+
- lib/cabin/outputs/elastic_search.rb
|
87
|
+
homepage: https://www.github.com/starkriedesel/cabin-es
|
88
|
+
licenses:
|
89
|
+
- MIT
|
90
|
+
metadata:
|
91
|
+
allowed_push_host: https://rubygems.org
|
92
|
+
post_install_message:
|
93
|
+
rdoc_options: []
|
94
|
+
require_paths:
|
95
|
+
- lib
|
96
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
97
|
+
requirements:
|
98
|
+
- - ">="
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
version: '0'
|
101
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
102
|
+
requirements:
|
103
|
+
- - ">="
|
104
|
+
- !ruby/object:Gem::Version
|
105
|
+
version: '0'
|
106
|
+
requirements: []
|
107
|
+
rubyforge_project:
|
108
|
+
rubygems_version: 2.5.1
|
109
|
+
signing_key:
|
110
|
+
specification_version: 4
|
111
|
+
summary: ElasticSearch output provider for the Ruby Cabin logging framework
|
112
|
+
test_files: []
|