logstash-output-coralogix_logger 0.9.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +47 -60
  3. data/logstash-output-coralogix-logger.gemspec +1 -1
  4. metadata +15 -15
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 6e12a369c3095a29e874268bef7b73756f62a68d
4
- data.tar.gz: 6aba3211e218a30af2c811c6db13a699a732f1d7
3
+ metadata.gz: 0f5ba2d658ba9fea306c5e88d2b1daab20fd3081
4
+ data.tar.gz: c4a68ed34cd113a34fb2d676889595555ff6da7d
5
5
  SHA512:
6
- metadata.gz: 5a48e6fc8c9f921d03356df1bb1ae1461fee4de69e6137571183aa155fc49ff72cb405ad131a04e71e7d68bfe822af4a64b6185a08b429aa5d1d864496726684
7
- data.tar.gz: 91a4ad4ea74fc1d0fa197bf42141e9f12c2532f9e4d260a9ea0b394e016cc1628321aa0f29a257b2569b00ccdb232985f73d72553070ed111b1fac1ad0bd4cc0
6
+ metadata.gz: 8c6701127a679bf4eb5d153affbc80ba20417ef20da62b4a4fe6c84aa0030b1728374cc9bd9a4aadf3d10f2fdbf177b29ccbbca4ed31d3d5f7e20f710f6ad35e
7
+ data.tar.gz: d745cd27140fa63a2d0d18f5aeada76e0af97c31ba94a47317f7979a4175da9116f088d0bf2b772943570688f1ede8abf6a4e6dab7d8c8467deed8d9b6d091c1
data/README.md CHANGED
@@ -1,86 +1,73 @@
1
- # Logstash Plugin
2
1
 
3
- This is a plugin for [Logstash](https://github.com/elastic/logstash).
2
+ Coralogix provides a seamless integration with Logstash so you can send your logs from anywhere and parse them according to your needs.
4
3
 
5
- It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
4
+ ## Talbe of contents
6
5
 
7
- ## Documentation
6
+ 1. Prerequisites
7
+ 2. Usage
8
+ 3. Installation
9
+ 4. Configuration
8
10
 
9
- Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
10
11
 
11
- - For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
12
- - For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
13
12
 
14
- ## Need Help?
13
+ ## Prerequisites
15
14
 
16
- Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
15
+ Have Logstash installed, for more information on how to install: https://www.elastic.co/guide/en/logstash/current/installing-logstash.html
17
16
 
18
- ## Developing
19
17
 
20
- ### 1. Plugin Developement and Testing
18
+ ## Usage
21
19
 
22
- #### Code
23
- - To get started, you'll need JRuby with the Bundler gem installed.
20
+ **Private Key** - A unique ID which represents your company, this Id will be sent to your mail once you register to Coralogix..
24
21
 
25
- - Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
22
+ **Application Name** - The name of your main application, for example, a company named “SuperData” would probably insert the “SuperData” string parameter or if they want to debug their test environment they might insert the “SuperData– Test”.
26
23
 
27
- - Install dependencies
28
- ```sh
29
- bundle install
30
- ```
24
+ **SubSystem Name** - Your application probably has multiple subsystems, for example: Backend servers, Middleware, Frontend servers etc. in order to help you examine the data you need, inserting the subsystem parameter is vital.
31
25
 
32
- #### Test
33
26
 
34
- - Update your dependencies
27
+ ## Installation
35
28
 
36
- ```sh
37
- bundle install
38
- ```
29
+ logstash-plugin install logstash-output-coralogix_logger. If you are not sure where logstash-plugin is located, you can check here:
39
30
 
40
- - Run tests
31
+ https://www.elastic.co/guide/en/logstash/current/dir-layout.html
41
32
 
42
- ```sh
43
- bundle exec rspec
44
- ```
45
33
 
46
- ### 2. Running your unpublished Plugin in Logstash
34
+ ## Configuration
47
35
 
48
- #### 2.1 Run in a local Logstash clone
36
+ Open your Logstash configuration file and add Coralogix output. (You should configure input plugin depending on your needs, for more information regarding input plugins please refer to: https://www.elastic.co/guide/en/logstash/current/input-plugins.html)
49
37
 
50
- - Edit Logstash `Gemfile` and add the local plugin path, for example:
51
- ```ruby
52
- gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
53
- ```
54
- - Install plugin
55
- ```sh
56
- bin/logstash-plugin install --no-verify
57
- ```
58
- - Run Logstash with your plugin
59
- ```sh
60
- bin/logstash -e 'filter {awesome {}}'
61
- ```
62
- At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
38
+ #####
39
+ output {
40
+ coralogix_logger {
41
+ config_params => {
42
+ "PRIVATE_KEY" => "11111111-1111-1111-1111-111111111111"
43
+ "APP_NAME" => "Logstash Tester"
44
+ "SUB_SYSTEM" => "Logstash subsystem"
45
+ }
46
+ log_key_name => "message"
47
+ is_json => true
48
+ }
49
+ }
63
50
 
64
- #### 2.2 Run in an installed Logstash
51
+ The fist key (config_params) is mandatory while the other two are optional.
52
+ In case your input stream is a JSON object, you can extract APP_NAME and/or SUB_SYSTEM from the JSON using the $ sign. For instance, in the bellow JSON $message. system will extract “nginx” value.
65
53
 
66
- You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
54
+ ##### Example: Ruby usage ####
55
+ {
56
+ "@timestamp": "2017 - 04 - 03 T18: 44: 28.591 Z",
57
+ "@version": "1",
58
+ "host": "test-host",
59
+ "message": {
60
+ "system": "nginx",
61
+ "status": "OK",
62
+ "msg": "Hello from Logstash"
63
+ }
64
+ }
67
65
 
68
- - Build your plugin gem
69
- ```sh
70
- gem build logstash-filter-awesome.gemspec
71
- ```
72
- - Install the plugin from the Logstash home
73
- ```sh
74
- bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
75
- ```
76
- - Start Logstash and proceed to test the plugin
66
+ In case your input stream is a JSON object and you don’t want to send the entire JSON, rather just a portion of it, you can write the value of the key you want to send in the log_key_name. By default, logstash will put your raw log message in the "message" key.
77
67
 
78
- ## Contributing
68
+ For instance, in the above example, if you write log_key_name message then only the value of message key will be sent to Coralogix.
69
+ If you do want to send the entire message then you can just delete this key.
79
70
 
80
- All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
71
+ In case your raw log message is a JSON object you should set is_json key to a "true" value, otherwise you can ignore it.
81
72
 
82
- Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
83
-
84
- It is more important to the community that you are able to contribute.
85
-
86
- For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.
73
+ Restart Logstash.
data/logstash-output-coralogix-logger.gemspec CHANGED
@@ -1,6 +1,6 @@
1
1
  Gem::Specification.new do |s|
2
2
  s.name = 'logstash-output-coralogix_logger'
3
- s.version = '0.9.0'
3
+ s.version = '0.10.0'
4
4
  s.licenses = ['Apache License (2.0)']
5
5
  s.summary = 'Coralogix Logstash logger SDK'
6
6
  s.description = 'Coralogix Logstash logger to send logs to Coralogix server'
metadata CHANGED
@@ -1,66 +1,66 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-output-coralogix_logger
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Royee Goldberg
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2017-04-02 00:00:00.000000000 Z
11
+ date: 2017-04-03 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
+ name: logstash-core-plugin-api
14
15
  requirement: !ruby/object:Gem::Requirement
15
16
  requirements:
16
17
  - - "~>"
17
18
  - !ruby/object:Gem::Version
18
19
  version: '2.0'
19
- name: logstash-core-plugin-api
20
- prerelease: false
21
20
  type: :runtime
21
+ prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '2.0'
27
27
  - !ruby/object:Gem::Dependency
28
+ name: logstash-codec-plain
28
29
  requirement: !ruby/object:Gem::Requirement
29
30
  requirements:
30
31
  - - ">="
31
32
  - !ruby/object:Gem::Version
32
33
  version: '0'
33
- name: logstash-codec-plain
34
- prerelease: false
35
34
  type: :runtime
35
+ prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
38
  - - ">="
39
39
  - !ruby/object:Gem::Version
40
40
  version: '0'
41
41
  - !ruby/object:Gem::Dependency
42
+ name: centralized_ruby_logger
42
43
  requirement: !ruby/object:Gem::Requirement
43
44
  requirements:
44
45
  - - ">="
45
46
  - !ruby/object:Gem::Version
46
47
  version: 0.0.5
47
- name: centralized_ruby_logger
48
- prerelease: false
49
48
  type: :runtime
49
+ prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - ">="
53
53
  - !ruby/object:Gem::Version
54
54
  version: 0.0.5
55
55
  - !ruby/object:Gem::Dependency
56
+ name: logstash-devutils
56
57
  requirement: !ruby/object:Gem::Requirement
57
58
  requirements:
58
59
  - - ">="
59
60
  - !ruby/object:Gem::Version
60
61
  version: '0'
61
- name: logstash-devutils
62
- prerelease: false
63
62
  type: :development
63
+ prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - ">="
@@ -87,7 +87,7 @@ licenses:
87
87
  metadata:
88
88
  logstash_plugin: 'true'
89
89
  logstash_group: output
90
- post_install_message:
90
+ post_install_message:
91
91
  rdoc_options: []
92
92
  require_paths:
93
93
  - lib
@@ -102,9 +102,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
102
102
  - !ruby/object:Gem::Version
103
103
  version: '0'
104
104
  requirements: []
105
- rubyforge_project:
106
- rubygems_version: 2.4.8
107
- signing_key:
105
+ rubyforge_project:
106
+ rubygems_version: 2.6.11
107
+ signing_key:
108
108
  specification_version: 4
109
109
  summary: Coralogix Logstash logger SDK
110
110
  test_files: