fluent-plugin-jabber, a plugin for Fluentd
Fluentd output plugin for XMPP(jabber) protocol.
Installation
Add this line to your application's Gemfile:
gem 'fluent-plugin-jabber'
And then execute:
$ bundle
Or install it yourself as:
$ gem install fluent-plugin-jabber
Usage
See source for details.
Fluentd config
<match ...>
type jabber
# Pit( https://github.com/cho45/pit ) ID for user account information.
# Need 'jid' and 'password' field.
pit_id jabber
# Or, put JID/password directly(exclusive for pit_id)
jid name@example.com
password pa55w0rd
# Output target JID. Currently multi user chat only.
#
# NOTE: Group chat could'nt accept nickname that already in used.
# It cause "conflict: That nickname is registered by another person" error.
# To prevent it, specify unique nickname per plugin definition.
room test@conference.localhost/unique_nickname
# Required, plain text message format.
format Hello!\n${user.name} # ${user.name} replaced with record['user']['name']
# Optional, XHTML message format.
# NOTE: Use '\{sharp}' instead of '#' due to fluentd treat '#' to 'Begin of comment'
xhtml_format <span style="color:\{sharp}FF0000">Hello!<strong>${user.name}</strong></span>
# Enable detailed log of XMPP4R
jabber_debug_log true
jabber_warnings_log true
</match>
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
Changes
0.5.0(unreleased)
- support ping(XEP-0199)
0.4.0
- Add filter: uri_component
0.3.0
- Add filter: br
- Fix xhtml message building
- Fix xhtml message encoding error
0.2.0
- Add xhtml_format option
0.1.1
- Fix Encoding::CompatibilityError while parsing XMPP messages caused by default_internal is ASCII_8BIT.
- add jabber_debug_log and jabber_warnings_log options.
0.1.0
- Add license
- Updated Gemfile
- Change file location to fluent plugin standard.
- Add format option
- Add test
- Add jid/password option
0.0.1
- Initial release.