https://github.com/sonots/alerty-plugin-amazon_sns

Amazon SNS plugin for alerty https://github.com/sonots/alerty
https://github.com/sonots/alerty-plugin-amazon_sns

Last synced: 3 months ago
JSON representation

Amazon SNS plugin for alerty https://github.com/sonots/alerty

• Host: GitHub
• URL: https://github.com/sonots/alerty-plugin-amazon_sns
• Owner: sonots
• License: mit
• Created: 2015-08-13T14:59:01.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-01-31T05:02:55.000Z (almost 8 years ago)
• Last Synced: 2024-04-24T20:26:19.840Z (8 months ago)
• Language: Ruby
• Size: 10.7 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Alerty::Plugin::AmazonSns

Amazon SNS plugin for alerty

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'alerty-plugin-amazon_sns'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install alerty-plugin-amazon_sns

## Configuration

* **type**: must be `amazon_sns`

* **topc_arn**: Amazon SNS topic name

* **subject**: subject of alert. `${command}` is replaced with a given command, `${hostname}` is replaced with the hostname ran the command, `${output}` is replaced with the output.

* **message**: message of alert. `${command}` is replaced with a given command, `${hostname}` is replaced with the hostname ran the command, `${output}` is replaced with the output. The default is `${output}`.

* **aws_region**: AWS Region. (default: guess from topic_arn, like arn:aws:sns:us-east-1:: => us-east-1)

* **aws_access_key_id**: Credential key id (default: ENV['AWS_SECRET_KEY_id'] or ~/.aws/credentials or instance profile on EC2)

* **aws_secret_access_key**: Credential secret access_key (default: ENV['AWS_SECRET_ACCESS_KEY'] or ~/.aws/credentials or instance profile on EC2)

See [example.yml](./example.yml)

## ChangeLog

See [CHANGELOG.md](./CHANGELOG.md)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/alerty-plugin-amazon_sns. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).