https://github.com/cosmo0920/fluent-plugin-terminal_notifier
A fluentd plugin to notify notification center with terminal-notifier.
https://github.com/cosmo0920/fluent-plugin-terminal_notifier
fluentd-plugin macos terminal-notifier
Last synced: about 1 month ago
JSON representation
A fluentd plugin to notify notification center with terminal-notifier.
- Host: GitHub
- URL: https://github.com/cosmo0920/fluent-plugin-terminal_notifier
- Owner: cosmo0920
- License: mit
- Created: 2015-10-18T07:44:45.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-05-07T04:30:58.000Z (about 9 years ago)
- Last Synced: 2026-03-07T14:07:41.735Z (3 months ago)
- Topics: fluentd-plugin, macos, terminal-notifier
- Language: Ruby
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Fluent::Plugin::TerminalNotifier
[](https://travis-ci.org/cosmo0920/fluent-plugin-terminal_notifier)
A fluentd plugin to notify notification center with terminal-notifier.
## Notice
0.1.0 had been dropped support Fluentd v0.12.
If you want to use this plugin with Fluentd v0.12, please add version constraint in your Gemfile like as:
```ruby
gem "fluent-plugin-formatter_simple_tsv", "~> 0.0.3"
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'fluent-plugin-terminal_notifier'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install fluent-plugin-terminal_notifier
## TerminalNotifierOutput
### Configuration Example
For example, add `terminal-notifier` configuration section like this:
```
@type terminal_notifier
title test
sub_title sub
```
Also you can specify app ID to activate like this:
This example is activating Terminal.app.
```
@type terminal_notifier
title test
sub_title sub
activate com.apple.Terminal
```
In more detail about activatation, please refer to the [TerminalNotifier document](https://github.com/julienXX/terminal-notifier/blob/f727ffdb19c91bd4f87d30274c12044ccea47fe2/README.markdown).
### Parameters
- **title** (String. Optional) This key is used in Notification title.
- **sub_title** (String. Optional) This key is used in Notification sub title.
- **activate** (String. Optional) This key is used in OS X application activating.
## TerminalNotifierFilter
### Configuration Example
This is a filter version of terminal-notifier fluentd plugin.
For example, add `terminal_notifier` configuration section like this:
```
@type terminal_notifier
title filtered
sub_title sub_filtered
```
Also you can specify app ID to activate like this:
This example is activating Terminal.app.
```
@type terminal_notifier
title filtered
sub_title sub_filtered
activate com.apple.Terminal
```
In more detail about activatation, please refer to the [TerminalNotifier document](https://github.com/julienXX/terminal-notifier/blob/f727ffdb19c91bd4f87d30274c12044ccea47fe2/README.markdown).
### Parameters
- **title** (String. Optional) This key is used in Notification title.
- **sub_title** (String. Optional) This key is used in Notification sub title.
- **activate** (String. Optional) This key is used in OS X application activating.
## More Complex Example
Please refer to the [example configuration](example/fluent.conf).
And note that this output plugin do not emit records, so, please consider to use something like copy plugin.
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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 `version.rb`, 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/cosmo0920/fluent-plugin-terminal_notifier.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).