Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

fluent-plugin-sakuraio

Test 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
  ping 60
</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"]}
  ping 60
</match>

License

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

About

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

Topics

Resources

License

Packages

No packages published

Languages