emailedit

  • Version: 4.0.3
  • Released on: 2016-08-04
  • Changelog
Note

This plugin does not ship with Logstash by default, but it is easy to install by running bin/logstash-plugin install logstash-output-email.

Send email when an output is received. Alternatively, you may include or exclude the email output execution using conditionals.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

email {
    to => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

address

string

No

"localhost"

attachments

array

No

[]

authentication

string

No

body

string

No

""

cc

string

No

codec

codec

No

"plain"

contenttype

string

No

"text/html; charset=UTF-8"

debug

boolean

No

false

domain

string

No

"localhost"

enable_metric

boolean

No

true

from

string

No

"logstash.alert@nowhere.com"

htmlbody

string

No

""

id

string

No

password

string

No

port

number

No

25

replyto

string

No

subject

string

No

""

to

string

Yes

use_tls

boolean

No

false

username

string

No

via

string

No

"smtp"

workers

<<,>>

No

1

Detailsedit

 

addressedit

  • Value type is string
  • Default value is "localhost"

The address used to connect to the mail server

attachmentsedit

  • Value type is array
  • Default value is []

Attachments - specify the name(s) and location(s) of the files.

authenticationedit

  • Value type is string
  • There is no default value for this setting.

Authentication method used when identifying with the server

bodyedit

  • Value type is string
  • Default value is ""

Body for the email - plain text only.

  • Value type is string
  • There is no default value for this setting.

The fully-qualified email address(es) to include as cc: address(es).

This field also accepts a comma-separated string of addresses, for example: "me@host.com, you@host.com"

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output, without needing a separate filter in your Logstash pipeline.

contenttypeedit

  • Value type is string
  • Default value is "text/html; charset=UTF-8"

contenttype : for multipart messages, set the content-type and/or charset of the HTML part. NOTE: this may not be functional (KH)

debugedit

  • Value type is boolean
  • Default value is false

Run the mail relay in debug mode

domainedit

  • Value type is string
  • Default value is "localhost"

Domain used to send the email messages

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

fromedit

  • Value type is string
  • Default value is "logstash.alert@nowhere.com"

The fully-qualified email address for the From: field in the email.

htmlbodyedit

  • Value type is string
  • Default value is ""

HTML Body for the email, which may contain HTML markup.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

``` output { stdout { id ⇒ "ABC" } } ```

If you don’t explicitely set this variable Logstash will generate a unique name.

passwordedit

  • Value type is string
  • There is no default value for this setting.

Password to authenticate with the server

portedit

  • Value type is number
  • Default value is 25

Port used to communicate with the mail server

replytoedit

  • Value type is string
  • There is no default value for this setting.

The fully qualified email address for the Reply-To: field.

subjectedit

  • Value type is string
  • Default value is ""

Subject: for the email.

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The fully-qualified email address to send the email to.

This field also accepts a comma-separated string of addresses, for example: "me@host.com, you@host.com"

You can also use dynamic fields from the event with the %{fieldname} syntax.

use_tlsedit

  • Value type is boolean
  • Default value is false

Enables TLS when communicating with the server

usernameedit

  • Value type is string
  • There is no default value for this setting.

Username to authenticate with the server

viaedit

  • Value type is string
  • Default value is "smtp"

How Logstash should send the email, either via SMTP or by invoking sendmail.

workersedit

  • Value type is string
  • Default value is 1