Email output pluginedit

  • Plugin version: v4.0.6
  • Released on: 2017-08-16
  • Changelog

Installationedit

For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-email. See Working with plugins for more details.

Getting Helpedit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Descriptionedit

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

Usage Exampleedit

output {
  if "shouldmail" in [tags] {
    email {
      to => 'technical@example.com'
      from => 'monitor@example.com'
      subject => 'Alert - %{title}'
      body => "Tags: %{tags}\\n\\Content:\\n%{message}"
      domain => 'mail.example.com'
      port => 25
    }
  }
}

Email Output Configuration Optionsedit

This plugin supports the following configuration options plus the Common Options described later.

Also see Common Options for a list of options supported by all output plugins.

 

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@example.com, you@example.com"

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"

The HELO/EHLO domain name used in the greeting message when connecting to a remote SMTP server. Some servers require this name to match the actual hostname of the connecting client.

fromedit

  • Value type is string
  • Default value is "logstash.alert@example.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.

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@example.com, you@example.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.

Common Optionsedit

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

workers

number

No

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.

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.

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 email outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  email {
    id => "my_plugin_id"
  }
}

workersedit

  • Value type is string
  • Default value is 1