logstash-output-sns 4.0.3 → 4.0.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +8 -1
- data/docs/index.asciidoc +162 -0
- data/logstash-output-sns.gemspec +2 -2
- metadata +3 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4af9bd85265a38a9dc507e536ae3bddf07f8b44b
|
4
|
+
data.tar.gz: c07661a41d6528289084a5ee8fd635bfbc2a26eb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5d5a74f717ff3973eee5f2f2cd6fa5a1daf1445be3dd3f686c1d30a95cf81e5c2b4b7608703a732b8faf9180e5c743f58749613701f3d8138da726d8c9b39a5b
|
7
|
+
data.tar.gz: 639a4ac9f5b161cb96ab375853b29d98f64f143be19633e6964e5f888dd683d2a24905d7fe6eb1d14887664bf652ac682f9ad54c654227c35761adc3e323e15e
|
data/Gemfile
CHANGED
@@ -1,4 +1,11 @@
|
|
1
1
|
source 'https://rubygems.org'
|
2
2
|
|
3
|
-
# Specify your gem's dependencies in logstash-mass_effect.gemspec
|
4
3
|
gemspec
|
4
|
+
|
5
|
+
logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
|
6
|
+
use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
|
7
|
+
|
8
|
+
if Dir.exist?(logstash_path) && use_logstash_source
|
9
|
+
gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
|
10
|
+
gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
|
11
|
+
end
|
data/docs/index.asciidoc
ADDED
@@ -0,0 +1,162 @@
|
|
1
|
+
:plugin: sns
|
2
|
+
:type: output
|
3
|
+
|
4
|
+
///////////////////////////////////////////
|
5
|
+
START - GENERATED VARIABLES, DO NOT EDIT!
|
6
|
+
///////////////////////////////////////////
|
7
|
+
:version: %VERSION%
|
8
|
+
:release_date: %RELEASE_DATE%
|
9
|
+
:changelog_url: %CHANGELOG_URL%
|
10
|
+
:include_path: ../../../../logstash/docs/include
|
11
|
+
///////////////////////////////////////////
|
12
|
+
END - GENERATED VARIABLES, DO NOT EDIT!
|
13
|
+
///////////////////////////////////////////
|
14
|
+
|
15
|
+
[id="plugins-{type}-{plugin}"]
|
16
|
+
|
17
|
+
=== Sns output plugin
|
18
|
+
|
19
|
+
include::{include_path}/plugin_header.asciidoc[]
|
20
|
+
|
21
|
+
==== Description
|
22
|
+
|
23
|
+
SNS output.
|
24
|
+
|
25
|
+
Send events to Amazon's Simple Notification Service, a hosted pub/sub
|
26
|
+
framework. It supports various subscription types, including email, HTTP/S, SMS, and SQS.
|
27
|
+
|
28
|
+
For further documentation about the service see:
|
29
|
+
|
30
|
+
http://docs.amazonwebservices.com/sns/latest/api/
|
31
|
+
|
32
|
+
This plugin looks for the following fields on events it receives:
|
33
|
+
|
34
|
+
* `sns` - If no ARN is found in the configuration file, this will be used as
|
35
|
+
the ARN to publish.
|
36
|
+
* `sns_subject` - The subject line that should be used.
|
37
|
+
Optional. The "%{host}" will be used if `sns_subject` is not present. The subject
|
38
|
+
will be truncated to 100 characters. If `sns_subject` is set to a non-string value a JSON version of that value will be saved.
|
39
|
+
* `sns_message` - Optional string of message to be sent. If this is set to a non-string value it will be encoded with the specified `codec`. If this is not set the entire event will be encoded with the codec.
|
40
|
+
with the @message truncated so that the length of the JSON fits in
|
41
|
+
`32768` bytes.
|
42
|
+
|
43
|
+
==== Upgrading to 2.0.0
|
44
|
+
|
45
|
+
This plugin used to have a `format` option for controlling the encoding of messages prior to being sent to SNS.
|
46
|
+
This plugin now uses the logstash standard <<codec,codec>> option for encoding instead.
|
47
|
+
If you want the same 'plain' format as the v0/1 codec (`format => "plain"`) use `codec => "s3_plain"`.
|
48
|
+
|
49
|
+
|
50
|
+
[id="plugins-{type}s-{plugin}-options"]
|
51
|
+
==== Sns Output Configuration Options
|
52
|
+
|
53
|
+
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
|
54
|
+
|
55
|
+
[cols="<,<,<",options="header",]
|
56
|
+
|=======================================================================
|
57
|
+
|Setting |Input type|Required
|
58
|
+
| <<plugins-{type}s-{plugin}-access_key_id>> |<<string,string>>|No
|
59
|
+
| <<plugins-{type}s-{plugin}-arn>> |<<string,string>>|No
|
60
|
+
| <<plugins-{type}s-{plugin}-aws_credentials_file>> |<<string,string>>|No
|
61
|
+
| <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No
|
62
|
+
| <<plugins-{type}s-{plugin}-publish_boot_message_arn>> |<<string,string>>|No
|
63
|
+
| <<plugins-{type}s-{plugin}-region>> |<<string,string>>, one of `["us-east-1", "us-east-2", "us-west-1", "us-west-2", "eu-central-1", "eu-west-1", "eu-west-2", "ap-southeast-1", "ap-southeast-2", "ap-northeast-1", "ap-northeast-2", "sa-east-1", "us-gov-west-1", "cn-north-1", "ap-south-1", "ca-central-1"]`|No
|
64
|
+
| <<plugins-{type}s-{plugin}-secret_access_key>> |<<string,string>>|No
|
65
|
+
| <<plugins-{type}s-{plugin}-session_token>> |<<string,string>>|No
|
66
|
+
|=======================================================================
|
67
|
+
|
68
|
+
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
|
69
|
+
output plugins.
|
70
|
+
|
71
|
+
|
72
|
+
|
73
|
+
[id="plugins-{type}s-{plugin}-access_key_id"]
|
74
|
+
===== `access_key_id`
|
75
|
+
|
76
|
+
* Value type is <<string,string>>
|
77
|
+
* There is no default value for this setting.
|
78
|
+
|
79
|
+
This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:
|
80
|
+
|
81
|
+
1. Static configuration, using `access_key_id` and `secret_access_key` params in logstash plugin config
|
82
|
+
2. External credentials file specified by `aws_credentials_file`
|
83
|
+
3. Environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
|
84
|
+
4. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`
|
85
|
+
5. IAM Instance Profile (available when running inside EC2)
|
86
|
+
|
87
|
+
[id="plugins-{type}s-{plugin}-arn"]
|
88
|
+
===== `arn`
|
89
|
+
|
90
|
+
* Value type is <<string,string>>
|
91
|
+
* There is no default value for this setting.
|
92
|
+
|
93
|
+
Optional ARN to send messages to. If you do not set this you must
|
94
|
+
include the `sns` field in your events to set the ARN on a per-message basis!
|
95
|
+
|
96
|
+
[id="plugins-{type}s-{plugin}-aws_credentials_file"]
|
97
|
+
===== `aws_credentials_file`
|
98
|
+
|
99
|
+
* Value type is <<string,string>>
|
100
|
+
* There is no default value for this setting.
|
101
|
+
|
102
|
+
Path to YAML file containing a hash of AWS credentials.
|
103
|
+
This file will only be loaded if `access_key_id` and
|
104
|
+
`secret_access_key` aren't set. The contents of the
|
105
|
+
file should look like this:
|
106
|
+
|
107
|
+
[source,ruby]
|
108
|
+
----------------------------------
|
109
|
+
:access_key_id: "12345"
|
110
|
+
:secret_access_key: "54321"
|
111
|
+
----------------------------------
|
112
|
+
|
113
|
+
|
114
|
+
[id="plugins-{type}s-{plugin}-proxy_uri"]
|
115
|
+
===== `proxy_uri`
|
116
|
+
|
117
|
+
* Value type is <<string,string>>
|
118
|
+
* There is no default value for this setting.
|
119
|
+
|
120
|
+
URI to proxy server if required
|
121
|
+
|
122
|
+
[id="plugins-{type}s-{plugin}-publish_boot_message_arn"]
|
123
|
+
===== `publish_boot_message_arn`
|
124
|
+
|
125
|
+
* Value type is <<string,string>>
|
126
|
+
* There is no default value for this setting.
|
127
|
+
|
128
|
+
When an ARN for an SNS topic is specified here, the message
|
129
|
+
"Logstash successfully booted" will be sent to it when this plugin
|
130
|
+
is registered.
|
131
|
+
|
132
|
+
Example: arn:aws:sns:us-east-1:770975001275:logstash-testing
|
133
|
+
|
134
|
+
|
135
|
+
[id="plugins-{type}s-{plugin}-region"]
|
136
|
+
===== `region`
|
137
|
+
|
138
|
+
* Value can be any of: `us-east-1`, `us-east-2`, `us-west-1`, `us-west-2`, `eu-central-1`, `eu-west-1`, `eu-west-2`, `ap-southeast-1`, `ap-southeast-2`, `ap-northeast-1`, `ap-northeast-2`, `sa-east-1`, `us-gov-west-1`, `cn-north-1`, `ap-south-1`, `ca-central-1`
|
139
|
+
* Default value is `"us-east-1"`
|
140
|
+
|
141
|
+
The AWS Region
|
142
|
+
|
143
|
+
[id="plugins-{type}s-{plugin}-secret_access_key"]
|
144
|
+
===== `secret_access_key`
|
145
|
+
|
146
|
+
* Value type is <<string,string>>
|
147
|
+
* There is no default value for this setting.
|
148
|
+
|
149
|
+
The AWS Secret Access Key
|
150
|
+
|
151
|
+
[id="plugins-{type}s-{plugin}-session_token"]
|
152
|
+
===== `session_token`
|
153
|
+
|
154
|
+
* Value type is <<string,string>>
|
155
|
+
* There is no default value for this setting.
|
156
|
+
|
157
|
+
The AWS Session token for temporary credential
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
[id="plugins-{type}s-{plugin}-common-options"]
|
162
|
+
include::{include_path}/{type}.asciidoc[]
|
data/logstash-output-sns.gemspec
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
|
3
3
|
s.name = 'logstash-output-sns'
|
4
|
-
s.version = '4.0.
|
4
|
+
s.version = '4.0.4'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
6
|
s.summary = "Send events to Amazon's Simple Notification Service a hosted pub/sub framework"
|
7
7
|
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
|
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
|
|
11
11
|
s.require_paths = ["lib"]
|
12
12
|
|
13
13
|
# Files
|
14
|
-
s.files = Dir[
|
14
|
+
s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
|
15
15
|
|
16
16
|
# Tests
|
17
17
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-output-sns
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.0.
|
4
|
+
version: 4.0.4
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Elastic
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-
|
11
|
+
date: 2017-06-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -70,6 +70,7 @@ files:
|
|
70
70
|
- LICENSE
|
71
71
|
- NOTICE.TXT
|
72
72
|
- README.md
|
73
|
+
- docs/index.asciidoc
|
73
74
|
- lib/logstash/outputs/sns.rb
|
74
75
|
- logstash-output-sns.gemspec
|
75
76
|
- spec/outputs/sns_spec.rb
|