- Logstash Reference: other versions:
- Logstash Reference
- Logstash Introduction
- Getting Started with Logstash
- Package Repositories
- Breaking changes
- Upgrading Logstash
- Configuring Logstash
- Working with plugins
- Contributing to Logstash
- Logstash Plugins Community Maintainer Guide
- Input plugins
- beats
- couchdb_changes
- drupal_dblog
- elasticsearch
- exec
- eventlog
- file
- ganglia
- gelf
- generator
- graphite
- github
- heartbeat
- heroku
- http
- http_poller
- irc
- imap
- jdbc
- jmx
- kafka
- log4j
- lumberjack
- meetup
- pipe
- puppet_facter
- relp
- rss
- rackspace
- rabbitmq
- redis
- salesforce
- snmptrap
- stdin
- sqlite
- s3
- sqs
- stomp
- syslog
- tcp
- unix
- udp
- varnishlog
- wmi
- websocket
- xmpp
- zenoss
- zeromq
- Output plugins
- boundary
- circonus
- csv
- cloudwatch
- datadog
- datadog_metrics
- elasticsearch
- elasticsearch_java
- exec
- file
- google_bigquery
- google_cloud_storage
- ganglia
- gelf
- graphtastic
- graphite
- hipchat
- http
- irc
- influxdb
- juggernaut
- jira
- kafka
- lumberjack
- librato
- loggly
- mongodb
- metriccatcher
- nagios
- null
- nagios_nsca
- opentsdb
- pagerduty
- pipe
- riemann
- redmine
- rackspace
- rabbitmq
- redis
- riak
- s3
- sqs
- stomp
- statsd
- solr_http
- sns
- syslog
- stdout
- tcp
- udp
- webhdfs
- websocket
- xmpp
- zabbix
- zeromq
- Filter plugins
- aggregate
- alter
- anonymize
- collate
- csv
- cidr
- clone
- cipher
- checksum
- date
- de_dot
- dns
- drop
- elasticsearch
- extractnumbers
- environment
- elapsed
- fingerprint
- geoip
- grok
- i18n
- json
- json_encode
- kv
- mutate
- metrics
- multiline
- metaevent
- prune
- punct
- ruby
- range
- syslog_pri
- sleep
- split
- throttle
- translate
- uuid
- urldecode
- useragent
- xml
- zeromq
- Codec plugins
- Logstash 2.2 Release Notes
Send email when an output is received. Alternatively, you may include or exclude the email output execution using conditionals.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
email { to => ... }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
No |
|
||
No |
|||
No |
|
||
No |
|||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|||
No |
|
||
No |
|||
No |
|
||
Yes |
|||
No |
|
||
No |
|||
No |
|
||
No |
|
Details
edit
address
edit- Value type is string
-
Default value is
"localhost"
The address used to connect to the mail server
attachments
edit- Value type is array
-
Default value is
[]
Attachments - specify the name(s) and location(s) of the files.
authentication
edit- Value type is string
- There is no default value for this setting.
Authentication method used when identifying with the server
cc
edit- 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"
codec
edit- 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.
contenttype
edit- 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)
from
edit- Value type is string
-
Default value is
"logstash.alert@nowhere.com"
The fully-qualified email address for the From: field in the email.
htmlbody
edit- Value type is string
-
Default value is
""
HTML Body for the email, which may contain HTML markup.
password
edit- Value type is string
- There is no default value for this setting.
Password to authenticate with the server
replyto
edit- Value type is string
- There is no default value for this setting.
The fully qualified email address for the Reply-To: field.
to
edit- 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_tls
edit- Value type is boolean
-
Default value is
false
Enables TLS when communicating with the server
username
edit- Value type is string
- There is no default value for this setting.
Username to authenticate with the server
On this page