logstash-output-email 4.0.4 → 4.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/docs/index.asciidoc +13 -11
- data/lib/logstash/outputs/email.rb +7 -7
- data/logstash-output-email.gemspec +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 796bc0c80400fcd45375ea26449505f08d81d038
|
4
|
+
data.tar.gz: a5c5434cfa5c1151c45d5360e3e7ed0733344303
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 529802062bddd74474e4ac650325f11b4a3faf9c761cb12650fafe75893c829b3eaa228e81733d8591cae27508633101f362d88d7896408d208efce2663d9faf
|
7
|
+
data.tar.gz: 59d87114214f143c85ca720a8f7e74395ef29729a1cf81cb975c0f5e317552cbabfa16b391512cc1412a444f5dfa1df4e7522dece82d8aea14415ed4fc5533c9
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,12 @@
|
|
1
|
+
## 4.0.6
|
2
|
+
- Fix some documentation issues
|
3
|
+
|
4
|
+
## 4.0.5
|
5
|
+
- Docs: Add plugin description
|
6
|
+
|
7
|
+
## 4.0.4
|
8
|
+
- Docs: Fix plugin title
|
9
|
+
|
1
10
|
## 4.0.3
|
2
11
|
- Properly constrain mime types deps to be < 3.0 due to ruby 2.0+ requirement
|
3
12
|
- Uncap mail gem deps to play nicely with other plugins
|
data/docs/index.asciidoc
CHANGED
@@ -12,7 +12,7 @@ START - GENERATED VARIABLES, DO NOT EDIT!
|
|
12
12
|
END - GENERATED VARIABLES, DO NOT EDIT!
|
13
13
|
///////////////////////////////////////////
|
14
14
|
|
15
|
-
[id="plugins-{type}-{plugin}"]
|
15
|
+
[id="plugins-{type}s-{plugin}"]
|
16
16
|
|
17
17
|
=== Email output plugin
|
18
18
|
|
@@ -20,6 +20,8 @@ include::{include_path}/plugin_header.asciidoc[]
|
|
20
20
|
|
21
21
|
==== Description
|
22
22
|
|
23
|
+
Sends email when an output is received. Alternatively, you may include or
|
24
|
+
exclude the email output execution using conditionals.
|
23
25
|
|
24
26
|
==== Usage Example
|
25
27
|
[source,ruby]
|
@@ -27,18 +29,16 @@ include::{include_path}/plugin_header.asciidoc[]
|
|
27
29
|
output {
|
28
30
|
if "shouldmail" in [tags] {
|
29
31
|
email {
|
30
|
-
to => 'technical@
|
31
|
-
from => 'monitor@
|
32
|
+
to => 'technical@example.com'
|
33
|
+
from => 'monitor@example.com'
|
32
34
|
subject => 'Alert - %{title}'
|
33
35
|
body => "Tags: %{tags}\\n\\Content:\\n%{message}"
|
34
|
-
domain => 'mail.
|
36
|
+
domain => 'mail.example.com'
|
35
37
|
port => 25
|
36
38
|
}
|
37
39
|
}
|
38
40
|
}
|
39
41
|
----------------------------------
|
40
|
-
Send email when an output is received. Alternatively, you may include or
|
41
|
-
exclude the email output execution using conditionals.
|
42
42
|
|
43
43
|
[id="plugins-{type}s-{plugin}-options"]
|
44
44
|
==== Email Output Configuration Options
|
@@ -114,7 +114,7 @@ Body for the email - plain text only.
|
|
114
114
|
The fully-qualified email address(es) to include as cc: address(es).
|
115
115
|
|
116
116
|
This field also accepts a comma-separated string of addresses, for example:
|
117
|
-
`"me@
|
117
|
+
`"me@example.com, you@example.com"`
|
118
118
|
|
119
119
|
[id="plugins-{type}s-{plugin}-contenttype"]
|
120
120
|
===== `contenttype`
|
@@ -139,13 +139,15 @@ Run the mail relay in debug mode
|
|
139
139
|
* Value type is <<string,string>>
|
140
140
|
* Default value is `"localhost"`
|
141
141
|
|
142
|
-
|
142
|
+
The HELO/EHLO domain name used in the greeting message when connecting
|
143
|
+
to a remote SMTP server. Some servers require this name to match the
|
144
|
+
actual hostname of the connecting client.
|
143
145
|
|
144
146
|
[id="plugins-{type}s-{plugin}-from"]
|
145
147
|
===== `from`
|
146
148
|
|
147
149
|
* Value type is <<string,string>>
|
148
|
-
* Default value is `"logstash.alert@
|
150
|
+
* Default value is `"logstash.alert@example.com"`
|
149
151
|
|
150
152
|
The fully-qualified email address for the From: field in the email.
|
151
153
|
|
@@ -199,7 +201,7 @@ Subject: for the email.
|
|
199
201
|
The fully-qualified email address to send the email to.
|
200
202
|
|
201
203
|
This field also accepts a comma-separated string of addresses, for example:
|
202
|
-
`"me@
|
204
|
+
`"me@example.com, you@example.com"`
|
203
205
|
|
204
206
|
You can also use dynamic fields from the event with the `%{fieldname}` syntax.
|
205
207
|
|
@@ -230,4 +232,4 @@ How Logstash should send the email, either via SMTP or by invoking sendmail.
|
|
230
232
|
|
231
233
|
|
232
234
|
[id="plugins-{type}s-{plugin}-common-options"]
|
233
|
-
include::{include_path}/{type}.asciidoc[]
|
235
|
+
include::{include_path}/{type}.asciidoc[]
|
@@ -6,11 +6,11 @@
|
|
6
6
|
# output {
|
7
7
|
# if "shouldmail" in [tags] {
|
8
8
|
# email {
|
9
|
-
# to => 'technical@
|
10
|
-
# from => 'monitor@
|
9
|
+
# to => 'technical@example.com'
|
10
|
+
# from => 'monitor@example.com'
|
11
11
|
# subject => 'Alert - %{title}'
|
12
12
|
# body => "Tags: %{tags}\\n\\Content:\\n%{message}"
|
13
|
-
# domain => 'mail.
|
13
|
+
# domain => 'mail.example.com'
|
14
14
|
# port => 25
|
15
15
|
# }
|
16
16
|
# }
|
@@ -30,13 +30,13 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
|
|
30
30
|
# The fully-qualified email address to send the email to.
|
31
31
|
#
|
32
32
|
# This field also accepts a comma-separated string of addresses, for example:
|
33
|
-
# `"me@
|
33
|
+
# `"me@example.com, you@example.com"`
|
34
34
|
#
|
35
35
|
# You can also use dynamic fields from the event with the `%{fieldname}` syntax.
|
36
36
|
config :to, :validate => :string, :required => true
|
37
37
|
|
38
38
|
# The fully-qualified email address for the From: field in the email.
|
39
|
-
config :from, :validate => :string, :default => "logstash.alert@
|
39
|
+
config :from, :validate => :string, :default => "logstash.alert@example.com"
|
40
40
|
|
41
41
|
# The fully qualified email address for the Reply-To: field.
|
42
42
|
config :replyto, :validate => :string
|
@@ -44,7 +44,7 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
|
|
44
44
|
# The fully-qualified email address(es) to include as cc: address(es).
|
45
45
|
#
|
46
46
|
# This field also accepts a comma-separated string of addresses, for example:
|
47
|
-
# `"me@
|
47
|
+
# `"me@example.com, you@example.com"`
|
48
48
|
config :cc, :validate => :string
|
49
49
|
|
50
50
|
# How Logstash should send the email, either via SMTP or by invoking sendmail.
|
@@ -56,7 +56,7 @@ class LogStash::Outputs::Email < LogStash::Outputs::Base
|
|
56
56
|
# Port used to communicate with the mail server
|
57
57
|
config :port, :validate => :number, :default => 25
|
58
58
|
|
59
|
-
#
|
59
|
+
# HELO/EHLO domain name
|
60
60
|
config :domain, :validate => :string, :default => "localhost"
|
61
61
|
|
62
62
|
# Username to authenticate with the server
|
@@ -1,7 +1,7 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
|
3
3
|
s.name = 'logstash-output-email'
|
4
|
-
s.version = '4.0.
|
4
|
+
s.version = '4.0.6'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
6
|
s.summary = "Send email when an output is received."
|
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"
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: logstash-output-email
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 4.0.
|
4
|
+
version: 4.0.6
|
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-08-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|