fluent-plugin-twilio

fluent-plugin-twilio

Overview

Fluentd Output plugin to make a call with twilio. Twilio free trial is available to signup at the official website. You can try call to your cellphone for free!

Requirements

fluent-plugin-twilio	fluentd	ruby
>= 0.1.0	>= v0.14.15	>= 2.1
< 0.1.0	>= v0.12.0	>= 1.9

Installation

install with gem or td-agent-gem command as:

### for local fluentd
$ gem install fluent-plugin-twilio

### for td-agent2 (standard)
$ sudo td-agent-gem install fluent-plugin-twilio

Configuration

Message Format

fluent_logger.post('notify.call', {
  :number   => '[phone]',  # Required if default_number is brank
  :message  => 'Hello World!'   # Required if default_message is brank
})

Sample

<source>
  @type http
  port 8888
</source>

<match notify.call>
  @type twilio

  # Set account Sid and Token from twilio.com/user/account
  account_sid     TWILIO_ACCOUNT_SID           # Required
  auth_token      TWILIO_AUTH_TOKEN            # Required

  # Set caller ID with country code
  from_number     [phone]                 # Required

  # Set defaults of making outbound call.
  # To call multiple phone at the same time, list them with comma like below.
  default_number  [phone],[phone]  # Optional
  default_message "call from fluentd."         # Optional

  # Set log level to prevent info error
  @log_level       warn
</match>

Sample to customize messages

You can customize message using filter_record_transformer.

<source>
  @type http
  port 8888
  @label @NOTIFY
</source>

<label @NOTIFY>
  <filter>
    @type record_transformer
    <record>
      message Hi. ${record["name"]} has made a order of ${record["item"]} just now.
    </record>
  </filter>
  <match>
    @type twilio
    # snip ...
  </match>
</label>

Quick Test

# test call to [phone] and say "Help! System ABC has down." with woman voice.
$ curl http://localhost:8888/notify.call -F 'json={"number":"[phone]","voice":"woman","message":"Help! System ABC has down."}'

# check twilio activity log
$ tail -f /var/log/td-agent/td-agent.log

Backend Service

• Twilio https://www.twilio.com/
• Twilio Japan http://twilio.kddi-web.com/

Blog Articles

• http://y-ken.hatenablog.com/entry/fluent-plugin-twilio-has-released

TODO

Pull requests are very welcome!!

Copyright

Copyright © 2013- Kentaro Yoshida (@yoshi_ken)

License

Apache License, Version 2.0