Sns output plugin
editSns output plugin
edit- Plugin version: v4.0.7
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-sns
. See Working with plugins for more details.
Getting Help
editFor 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.
Description
editSNS output.
Send events to Amazon’s Simple Notification Service, a hosted pub/sub framework. It supports various subscription types, including email, HTTP/S, SMS, and SQS.
For further documentation about the service see:
http://docs.amazonwebservices.com/sns/latest/api/
This plugin looks for the following fields on events it receives:
-
sns
- If no ARN is found in the configuration file, this will be used as the ARN to publish. -
sns_subject
- The subject line that should be used. Optional. The "%{host}" will be used ifsns_subject
is not present. The subject will be truncated to 100 characters. Ifsns_subject
is set to a non-string value a JSON version of that value will be saved. -
sns_message
- Optional string of message to be sent. If this is set to a non-string value it will be encoded with the specifiedcodec
. If this is not set the entire event will be encoded with the codec. with the @message truncated so that the length of the JSON fits in32768
bytes.
Upgrading to 2.0.0
editThis plugin used to have a format
option for controlling the encoding of messages prior to being sent to SNS.
This plugin now uses the logstash standard codec option for encoding instead.
If you want the same plain format as the v0/1 codec (format => "plain"
) use codec => "s3_plain"
.
Sns Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
string, one of |
No |
|
No |
||
No |
Also see Common Options for a list of options supported by all output plugins.
access_key_id
edit- Value type is string
- There is no default value for this setting.
This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:
-
Static configuration, using
access_key_id
andsecret_access_key
params in logstash plugin config -
External credentials file specified by
aws_credentials_file
-
Environment variables
AWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
-
Environment variables
AMAZON_ACCESS_KEY_ID
andAMAZON_SECRET_ACCESS_KEY
- IAM Instance Profile (available when running inside EC2)
arn
edit- Value type is string
- There is no default value for this setting.
Optional ARN to send messages to. If you do not set this you must
include the sns
field in your events to set the ARN on a per-message basis!
aws_credentials_file
edit- Value type is string
- There is no default value for this setting.
Path to YAML file containing a hash of AWS credentials.
This file will only be loaded if access_key_id
and
secret_access_key
aren’t set. The contents of the
file should look like this:
:access_key_id: "12345" :secret_access_key: "54321"
proxy_uri
edit- Value type is string
- There is no default value for this setting.
URI to proxy server if required
publish_boot_message_arn
edit- Value type is string
- There is no default value for this setting.
When an ARN for an SNS topic is specified here, the message "Logstash successfully booted" will be sent to it when this plugin is registered.
Example: arn:aws:sns:us-east-1:770975001275:logstash-testing
region
edit-
Value can be any of:
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
-
Default value is
"us-east-1"
The AWS Region
Common Options
editThe following configuration options are supported by all output plugins:
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.
enable_metric
edit- 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.
id
edit- 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 sns outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { sns { id => "my_plugin_id" } }