Sns 输出插件
编辑Sns 输出插件编辑
有关其他版本,请参阅版本化插件文档。
获取帮助编辑
如果您对该插件有任何疑问,请在论坛中打开一个主题。对于错误或功能请求,请在Github中打开一个问题。有关 Elastic 支持的插件列表,请参阅Elastic 支持矩阵。
描述编辑
SNS 输出。
将事件发送到 Amazon 的简单通知服务,这是一个托管的发布/订阅框架。它支持各种订阅类型,包括电子邮件、HTTP/S、短信和 SQS。
有关该服务的更多文档,请参阅
http://docs.amazonwebservices.com/sns/latest/api/
此插件会在其接收的事件中查找以下字段
-
sns
- 如果在配置文件中未找到 ARN,则将使用此字段作为发布的 ARN。 -
sns_subject
- 应使用的主题行。可选。如果未提供sns_subject
,则将使用“%{host}”。主题将被截断为 100 个字符。如果sns_subject
设置为非字符串值,则将保存该值的 JSON 版本。 -
sns_message
- 要发送的消息的可选字符串。如果将其设置为非字符串值,则将使用指定的codec
对其进行编码。如果未设置,则将使用编解码器对整个事件进行编码,并截断 @message,以便 JSON 的长度适合32768
字节。
升级到 2.0.0编辑
此插件以前使用 format
选项来控制在发送到 SNS 之前对消息进行编码。此插件现在使用 Logstash 标准 编解码器 选项进行编码。如果您希望使用与 v0/1 编解码器相同的 *plain* 格式(format => "plain"
),请使用 codec => "s3_plain"
。
Sns 输出配置选项编辑
此插件支持以下配置选项以及稍后描述的通用选项。
设置 | 输入类型 | 必需 |
---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
字符串,以下之一: |
否 |
|
否 |
||
否 |
||
否 |
另请参阅通用选项,以获取所有输出插件支持的选项列表。
access_key_id
编辑
- 值类型为字符串
- 此设置没有默认值。
此插件使用 AWS SDK 并支持以下几种获取凭证的方式,将按以下顺序尝试这些方式
- 静态配置,使用 Logstash 插件配置中的
access_key_id
和secret_access_key
参数 aws_credentials_file
指定的外部凭证文件- 环境变量
AWS_ACCESS_KEY_ID
和AWS_SECRET_ACCESS_KEY
- 环境变量
AMAZON_ACCESS_KEY_ID
和AMAZON_SECRET_ACCESS_KEY
- IAM 实例配置文件(在 EC2 内部运行时可用)
aws_credentials_file
编辑
- 值类型为字符串
- 此设置没有默认值。
包含 AWS 凭证哈希的 YAML 文件的路径。仅当未设置 access_key_id
和 secret_access_key
时,才会加载此文件。文件内容应如下所示
:access_key_id: "12345" :secret_access_key: "54321"
publish_boot_message_arn
编辑
- 值类型为字符串
- 此设置没有默认值。
如果在此处指定了 SNS 主题的 ARN,则在注册此插件时,将向其发送消息“Logstash 成功启动”。
示例:arn:aws:sns:us-east-1:770975001275:logstash-testing
region
编辑
- 值可以是以下任意一项:
us-east-1
、us-east-2
、us-west-1
、us-west-2
、eu-central-1
、eu-west-1
、eu-west-2
、ap-southeast-1
、ap-southeast-2
、ap-northeast-1
、ap-northeast-2
、sa-east-1
、us-gov-west-1
、cn-north-1
、ap-south-1
、ca-central-1
- 默认值为
"us-east-1"
AWS 区域