Logstash 參考指南（Email輸出插件）

Email輸出插件

• 插件版本：v4.1.1
• 發佈於：2018-04-06
• 修改日誌

其餘版本請參閱版本化的插件文檔。

獲取幫助

有關插件的問題，請在討論論壇中打開一個主題，對於bug或特性請求，在Github中打開一個issue，關於Elastic支持的插件列表，請考慮Elastic支持矩陣。

描述

當收到輸出時發送email，或者，你能夠使用條件包含或排除email輸出執行。

使用的例子

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

Email輸出配置選項

此插件支持如下配置選項以及稍後描述的通用選項。

設置	輸入類型	要求
address	string	No
attachments	array	No
authentication	string	No
body	string	No
cc	string	No
bcc	string	No
contenttype	string	No
debug	boolean	No
domain	string	No
from	string	No
htmlbody	string	No
password	string	No
port	number	No
replyto	string	No
subject	string	No
to	string	Yes
use_tls	boolean	No
username	string	No
via	string	No
template_file	path	No

還能夠查看全部輸出插件支持的通用選項列表。

address

• 值類型爲string
• 默認值爲「localhost」
• 用於鏈接到郵件服務器的地址

attachments

• 值類型爲array
• 默認值爲[]
• 附件 — 指定文件的名稱和位置

authentication

• 值類型爲string
• 此設置沒有默認值
• 與服務器進行標識時使用的身份驗證方法

body

• 值類型爲string
• 默認值爲 ""
• 郵件正文 — 純文本

cc

• 值類型爲string
• 此設置沒有默認值
• 徹底合格的電子郵件地址包括爲cc：地址

該字段還接受以逗號分隔的地址字符串，例如：「me@example.com, you@example.com」

bcc

• 值類型爲string
• 此設置沒有默認值
• 徹底合格的電子郵件地址包括爲bcc：地址，此字段接受多個地址，如cc

contenttype

• 值類型爲string
• 默認值爲"text/html; charset=UTF-8"
• contenttype：對於多部分消息，設置HTML部分的content-type和/或字符集，這可能不是功能性的（KH）

debug

• 值類型爲boolean
• 默認值是false
• 在debug模式運行email傳遞

domain

• 值類型爲string
• 默認值爲「localhost」
• 鏈接到遠程SMTP服務器時，在問候語中使用的HELO/EHLO域名，有些服務器須要這個名稱來匹配鏈接客戶端的實際主機名

from

• 值類型爲string
• 默認值爲「logstash.alert@example.com」
• From的email中的徹底限定電子郵件地址：email中的字段

htmlbody

• 值類型爲string
• 默認值爲""
• 郵件的HTML主體，可能包含HTML標記

password

• 值類型爲string
• 此設置沒有默認值
• 與服務器進行身份驗證的密碼

port

• 值類型爲number
• 默認值爲25
• 用於與郵件服務器通訊的端口

replyto

• 值類型爲string
• 此設置沒有默認值
• Reply-To的徹底限定電子郵件地址：字段

subject

• 值類型爲string
• 默認值爲""
• Subject：email的主題

to

• 這是必需的設置
• 值類型爲string
• 此設置沒有默認值
• 發送電子郵件到的徹底限定的電子郵件地址，該字段還接受以逗號分隔的地址字符串，例如：「me@example.com, you@example.com」，你還能夠使用%{fieldname}語法從事件中獲取的動態字段

use_tls

• 值類型爲boolean
• 默認值爲false
• 在與服務器通訊時啓用TLS

username

• 值類型爲string
• 此設置沒有默認值
• 使用服務器驗證的用戶名

via

• 值類型爲string
• 默認值爲"smtp"
• Logstash應該如何發送郵件，或者經過SMTP，或者經過調用sendmail

template_file

• 值類型爲path
• 此設置沒有默認值
• 用於電子郵件模板的Mustache模板文件路徑，請參閱測試夾具中的示例，能夠與body一塊兒發送多部分的電子郵件，優先於htmlBody

通用選項

全部輸出插件都支持如下配置選項：

設置	輸入類型	要求
codec	codec	No
enable_metric	boolean	No
id	string	No

codec

• 值類型爲codec
• 默認值爲"plain"
• 用於輸出數據的編解碼器，輸出編解碼器是一種方便的方法，能夠在數據離開輸出以前對其進行編碼，而不須要在你的Logstash管道中使用單獨的過濾器。

enable_metric

• 值類型爲boolean
• 默認值爲true
• 爲這個特定的插件實例禁用或啓用指標日誌記錄，默認狀況下，咱們記錄了全部咱們能夠記錄的指標，可是你能夠禁用特定插件的指標集合。

id

• 值類型爲string
• 此設置沒有默認值

• 在插件配置中添加惟一的ID，若是沒有指定ID，則Logstash將生成一個，強烈建議在配置中設置此ID，當你有兩個或多個相同類型的插件時，這一點特別有用。例如，若是你有兩個電子郵件輸出，在本例中添加一個命名ID將有助於在使用監控API時監控Logstash。

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