Contents
========


* `Contents <#contents>`__

  * `InfluxDBConnector Module <#influxdbconnector-module>`__

    * `Configuration <#configuration>`__

InfluxDBConnector Module
------------------------


#. InfluxDBConnector will subscribe to the InfluxDB and start the zmq
   publisher, zmq subscriber threads, and zmq request reply thread
   based on PubTopics, SubTopics and QueryTopics configuration.
#. zmq subscriber thread connects to the PUB socket of zmq bus on which
   the data is published by VideoAnalytics and push it to the InfluxDB.
#. zmq publisher thread will publish the point data ingested by the telegraf
   and the classifier result coming out of the point data analytics.
#. zmq reply request service will receive the InfluxDB select query and
   response with the historical data.

Configuration
^^^^^^^^^^^^^

All the InfluxDBConnector module configuration are added into etcd (distributed key-value data store) under ``AppName`` as mentioned in the environment section of this app's service definition in docker-compose.
If ``AppName`` is ``InfluxDBConnector``\ , then the app's config would look like as below for ``/InfluxDBConnector/config`` key in Etcd:

.. code-block:: json

       "influxdb": {
               "retention": "1h30m5s",
               "dbname": "datain",
               "ssl": "True",
               "verifySsl": "False",
               "port": "8086"
           }

For nested json data, by default InfluxDBConnector will flatten the nested json and push the flat data to InfluxDB to avoid the flattening of any particular nested key mention the tag key in the **config.json(\ ``[WORK_DIR]/IEdgeInsights/InfluxDBConnector/config.json``\ )** file. Currently the ``defects`` key is ignored from flattening. Every key to be ignored has to be in a new line.

For example,

.. code-block:: json

      ignore_keys = [ "Key1", "Key2", "Key3" ]

By default, all the keys in the data schema will be pushed to InfluxDB as fields. If tags are present in data schema, it can be mentioned in the **config.json(\ ``[WORK_DIR]/IEdgeInsights/InfluxDBConnector/config.json``\ )** file then the data pushed to InfluxDB, will have fields and tags both.
Currently, no tags are present in the data scheme and tag_keys is kept blank in the config file.

For example,

.. code-block:: json

     tag_keys = [ "Tag1", "Tag2" ]

For more details on Etcd secrets and messagebus endpoint configuration, refer to `Etcd_Secrets_Configuration.md </3.0.1/IEdgeInsights/Etcd_Secrets_Configuration.html>`_ and
`MessageBus Configuration </3.0.1/IEdgeInsights/common/libs/ConfigMgr/README.html#interfaces>`_ respectively.