forked from elastic/logstash
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request elastic#140 from hectcastro/aws_sns_output_plugin
AWS SNS output plugin
- Loading branch information
Showing
7 changed files
with
355 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| require "logstash/outputs/base" | ||
| require "logstash/namespace" | ||
|
|
||
| # SNS output. | ||
| # | ||
| # Send events to Amazon's Simple Notification Service, a hosted pub/sub | ||
| # framework. It supports subscribers of type 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. | ||
| # "%{@source}" will be used if not present | ||
| # (truncated at MAX_SUBJECT_SIZE_IN_CHARACTERS). | ||
| # "sns_message" => The message that should be sent. Optional. The | ||
| # event serialzed as JSON will be used if not | ||
| # present (with @message truncated so that the | ||
| # length of the JSON fits in | ||
| # MAX_MESSAGE_SIZE_IN_BYTES). | ||
| class LogStash::Outputs::Sns < LogStash::Outputs::Base | ||
| MAX_SUBJECT_SIZE_IN_CHARACTERS = 100 | ||
| MAX_MESSAGE_SIZE_IN_BYTES = 32768 | ||
|
|
||
| config_name "sns" | ||
| plugin_status "experimental" | ||
|
|
||
| # Amazon API credentials. | ||
| config :access_key_id, :validate => :string | ||
| config :secret_access_key, :validate => :string | ||
|
|
||
| # Path to YAML file containing a hash of AWS credentials. This file | ||
| # will be loaded if `access_key_id` and `secret_access_key` aren't | ||
| # set. | ||
| # | ||
| # Example: | ||
| # | ||
| # The path to YAML file containing a hash of the AWS credentials for | ||
| # your account. The contents of the file should look like this: | ||
| # | ||
| # --- | ||
| # :access_key_id: "12345" | ||
| # :secret_access_key: "54321" | ||
| # | ||
| config :credentials, :validate => :string | ||
|
|
||
| # Message format. Defaults to plain text. | ||
| config :format, :validate => [ "json", "plain" ], :default => "plain" | ||
|
|
||
| # SNS topic ARN. | ||
| config :arn, :validate => :string | ||
|
|
||
| # 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 | ||
| # | ||
| config :publish_boot_message_arn, :validate => :string | ||
|
|
||
| public | ||
| def register | ||
| require "aws-sdk" | ||
|
|
||
| # Credentials weren't specified in the configuration. | ||
| unless @access_key_id && @secret_access_key | ||
| access_creds = YAML.load_file(@credentials) | ||
|
|
||
| @access_key_id = access_creds[:access_key_id] | ||
| @secret_access_key = access_creds[:secret_access_key] | ||
| end | ||
|
|
||
| @sns = AWS::SNS.new( | ||
| :access_key_id => @access_key_id, | ||
| :secret_access_key => @secret_access_key | ||
| ) | ||
|
|
||
| # Try to publish a "Logstash booted" message to the ARN provided to | ||
| # cause an error ASAP if the credentials are bad. | ||
| if @publish_boot_message_arn | ||
| @sns.topics[@publish_boot_message_arn].publish("Logstash successfully booted", :subject => "Logstash booted") | ||
| end | ||
| end | ||
|
|
||
| public | ||
| def receive(event) | ||
| return unless output?(event) | ||
|
|
||
| arn = Array(event.fields["sns"]).first || @arn | ||
|
|
||
| raise "An SNS ARN required." unless arn | ||
|
|
||
| message = Array(event.fields["sns_message"]).first | ||
| subject = Array(event.fields["sns_subject"]).first || event.source | ||
|
|
||
| # Ensure message doesn't exceed the maximum size. | ||
| if message | ||
| # TODO: Utilize `byteslice` in JRuby 1.7: http://jira.codehaus.org/browse/JRUBY-5547 | ||
| message = message.slice(0, MAX_MESSAGE_SIZE_IN_BYTES) | ||
| else | ||
| if @format == "plain" | ||
| message = self.class.format_message(event) | ||
| else | ||
| message = self.class.json_message(event) | ||
| end | ||
| end | ||
|
|
||
| # Log event. | ||
| @logger.debug("Sending event to SNS topic [#{arn}] with subject [#{subject}] and message:") | ||
| message.split("\n").each { |line| @logger.debug(line) } | ||
|
|
||
| # Publish the message. | ||
| @sns.topics[arn].publish(message, :subject => subject.slice(0, MAX_SUBJECT_SIZE_IN_CHARACTERS)) | ||
| end | ||
|
|
||
| def self.json_message(event) | ||
| json = event.to_json | ||
| json_size = json.bytesize | ||
|
|
||
| # Truncate only the message if the JSON structure is too large. | ||
| if json_size > MAX_MESSAGE_SIZE_IN_BYTES | ||
| # TODO: Utilize `byteslice` in JRuby 1.7: http://jira.codehaus.org/browse/JRUBY-5547 | ||
| event.message = event.message.slice(0, (event.message.bytesize - (json_size - MAX_MESSAGE_SIZE_IN_BYTES))) | ||
| end | ||
|
|
||
| event.to_json | ||
| end | ||
|
|
||
| def self.format_message(event) | ||
| message = "Date: #{event.timestamp}\n" | ||
| message << "Source: #{event.source}\n" | ||
| message << "Tags: #{event.tags.join(', ')}\n" | ||
| message << "Fields: #{event.fields.inspect}\n" | ||
| message << "Message: #{event.message}" | ||
|
|
||
| # TODO: Utilize `byteslice` in JRuby 1.7: http://jira.codehaus.org/browse/JRUBY-5547 | ||
| message.slice(0, MAX_MESSAGE_SIZE_IN_BYTES) | ||
| end | ||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.