HowTo setup Fluentd on IOT Gateway

Agenda

  • Supply fluentd software on IOT Gateway
  • Learn configuration parameters for fluentd
  • Request fluentd instance for IOT Gateway

 

This tutorial teaches how to setup fluentd on IOT Gateway. 

Before doing this tutorial make sure you read and completed the following tutorials

You will also need to configure slapos client. For that read SlapOS HowTo Use SlapOS Client tutorial from Get SlapOS Master Token chapter.

 

Supply Software

First find the reference of your IOT Gateway.

It is located in your Slapos Dashboard in Servers tab.

Then using supply command of Slapos Client install flunetd software release on that computer.


supply("https://lab.nexedi.com/nexedi/slapos/raw/master/software/fluentd/software.cfg", "YOUR_COMPUTER_ID")

Configuration Parameters


<source>
@type forward
port 24224
bind ::0
</source>
<match YOUR_TAG_NAME>
@type wendelin
streamtool_uri https://softinstXXXX.host.vifib.net/erp5/portal_ingestion_policies/default
user      zope
password  *****
buffer_type file 
buffer_path fluentd-buffer-file/ 
flush_interval 1m 
</match>

About Fluentd configuration file you can learn from here.

For input plugin we use Fluentd's standard forward plugin.

For output we use our custom output plugin called wendelin.

YOUR_TAG_NAME - it must consist of 2 part separated by .(dot). For example sensor_1.sample-environment-raw-data. First part (sensor_1) is the name of the sensor and must be the same as the reference of the Data Supply we created in HowTo Create Data Supply tutorial. The second part (sample-environment-raw-data) is the type of data (Data Product  -  HowTo Create Data Product).

streamtool_uri - is the URL of the Wendelin instance created in HowTo Request ipv4 frontend with Ciphers tutorial. 

username and passowrd  of that instance you can in Connection Information tab of your webrunner as described in HowTo Install Wendelin on Webrunner.

 

 

Configuration Parameters Cont.


<source>
@type forward
port 24224
bind ::0
</source>
<match YOUR_TAG_NAME>
@type wendelin
streamtool_uri https://softinstXXXX.host.vifib.net/erp5/portal_ingestion_policies/default
user      zope
password  *****
buffer_type file 
buffer_path fluentd-buffer-file/ 
flush_interval 1m 
</match>

We also use file buffering plugin for fluentd. 

For path give a relative path to a directory where you want to store buffer files.  

flush_interval 1m  means that data will be flushed to wendelin every minute. 

 

Request Instance


config_params = """<source>
  @type forward
  port 24224
bind ::0 
</source>
<match sensor_1.sample-environment-raw-data>
@type wendelin
streamtool_uri https://softinstXXXXXX.host.vifib.net/erp5/portal_ingestion_policies/default
user zope
password ******
buffer_type file
buffer_path fluentd-buffer-file/
flush_interval 1m
</match>"""
request("https://lab.nexedi.com/nexedi/slapos/raw/master/software/fluentd/software.cfg", "IOT-Gateway-Tutorial-Fluentd",filter_kw={"computer_guid": "YOUR_COMPUTER_ID"}, partition_parameter_kw={"conf_text":config_params})

As the fluentd configuration has many parameters for convenience we will write a short python script which will request the instance, instead of calling request function from Slapos Client.  

Create a python script and name it request_fluentd.py and copy/paste the presented code. 

** Don't forget to correctly fill in your computer reference, Instance name, url etc. 

As we are requesting instance of fluentd for the same computer the reference is the same as when we were supplying the software.

"YOUR_INSTANCE_NAME" -  give your instance a distinguishing name so you can later easily find it. For example IOT-Gateway-Tutorial-Fluentd.

Once it's ready run it by calling following command : 

slapos console request_fluentd.py

Fluentd Instance

This step can take some time.  

In your Slapos dashboard you can see you newly requested instance.

Instance is ready when the the Monitoring Status is green.

Note the Parameters section - there are the flunetd configuration parameters we defined earlier.

IOT Gateway

Login to your IOT Gateway and run the following command : 

sudo slapos node status

You see that a new service for fluentd is added.

And the generated flunted configuration file is located here :

/srv/slapgrid/slappartX/etc/fluentd-agent.conf

 

Now your IOT Gateway is ready to receive data and to forward it to Wendelin.