Fluentd Input plugin to process message from sakura.io websocket API.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib/fluent/plugin
test
.gitignore
.travis.yml
CHANGELOG.md
Gemfile
LICENSE.txt
README.md
Rakefile
fluent-plugin-sakuraio.gemspec

README.md

fluent-plugin-sakuraio

Build Status

Fluentd Input plugin to process message from sakura.io WebSocket API.

Requirements

  • Ruby >= 2.1
  • Fluentd >= v0.14.0

Installation

gem install 'fluent-plugin-sakuraio'

Input Configuration

<source>
  @type sakuraio
  url wss://api.sakura.io/ws/v1/xxxxxxxxxxxxxxxxxxxxxxx
</source>

Tag format

  • channels type messages: {module}.channels.{channel}
  • connection and location type messages: {module}.{type}

Record format

  • channels type messages: {"module":{module},"channel":{channel},"type":"{data type}","value":{value}}
  • connection type messages: {"module":{module},"is_online":{is_online}}
  • location type messages: {"module":{module},"latitude":{latitude},"longitude":"{longitude}","range_m":{range_m}}

The details of sakura.io message spec: https://sakura.io/docs/pages/platform-specification/message.html

Output Configuration

<match **>
  @type sakuraio
  url wss://api.sakura.io/ws/v1/xxxxxxxxxxxxxxxxxxxxxxx
  modules ["uXXXXXXXXXXX"] # array of modules
  channels {"0": ["key", "i"]} # hash of channels {"channel number": ["key in record", "data type"]}
</match>

License

The gem is available as open source under the terms of the MIT License.