IBA ibaPDA-Data-Store-InfluxDB Owner's manual

ibaPDA-Data-Store-InfluxDB

Data streaming into InfluxDB

Manual

Issue 1.0

Measurement Systems for Industry and Energy

www.iba-ag.com

Manufacturer

iba AG

Koenigswarterstr. 44

90762 Fuerth

Germany

Contacts

Main oce +49 911 97282-0

Fax +49 911 97282-33

Support +49 911 97282-14

Engineering +49 911 97282-13

E-mail [email protected]

Web www.iba-ag.com

Unless explicitly stated to the contrary, it is not permied to pass on or copy this document, nor

to make use of its contents or disclose its contents. Infringements are liable for compensaon.

The content of this publicaon has been checked for compliance with the described hardware

and soware. Nevertheless, discrepancies cannot be ruled out, and we do not provide guaran-

tee for complete conformity. However, the informaon furnished in this publicaon is updated

regularly. Required correcons are contained in the following regulaons or can be downloaded

on the Internet.

The current version is available for download on our web site www.iba-ag.com.

Version Date Revision - Chapter / Page Author Version SW

1.0 04-2022 First issue st 8.0.0

Windows® is a brand and registered trademark of Microso Corporaon. Other product and

company names menoned in this manual can be labels or registered trademarks of the corre-

sponding owners.

1.0 3

ibaPDA-Data-Store-InuxDB Content

Content

1 About this manual .............................................................................................................4

1.1 Target group and previous knowledge ..................................................................... 4

1.2 Notaons .................................................................................................................. 5

1.3 Used symbols ............................................................................................. ...............6

2 Introducon ...................................................................................................................... 7

2.1 System requirements ................................................................................................ 7

3 Datastoreconguraon ....................................................................................................8

3.1 Add a data store ....................................................................................................... 8

3.2 Data store InuxDB ................................................................................................... 9

3.3 Examples for data models ...................................................................................... 12

3.4 Buer ...................................................................................................................... 15

4 Signalselecon ............................................................................................................... 18

5 Triggermode ................................................................................................................... 19

6 Diagnoscs ......................................................................................................................23

6.1 Data storage status .................................................................................................23

6.2 Diagnoscs of data stores ....................................................................................... 24

6.3 OPC UA Server ........................................................................................................ 25

6.4 SNMP ...................................................................................................................... 26

6.5 Virtual funcons ..................................................................................................... 27

7 Support and contact ........................................................................................................ 28

4 1.0

About this manual ibaPDA-Data-Store-InuxDB

1 About this manual

This documentaon describes the funcon and applicaon of the data store

ibaPDA-Data-Store-InuxDB.

This documentaon is a supplement to the ibaPDA manual. Informaon about all the other

characteriscs and funcons of ibaPDA may be found in the ibaPDA manual or in the online

help.

You will nd basic informaon about data storage in ibaPDA in the ibaPDA manual part 5.

1.1 Targetgroupandpreviousknowledge

This documentaon addresses qualied professionals, who are familiar with handling electrical

and electronic modules as well as communicaon and measurement technology. A person is

regarded as professional if he/she is capable of assessing the work assigned to him/her and rec-

ognizing possible risks on the basis of his/her specialist training, knowledge and experience and

knowledge of the standard regulaons.

This documentaon in parcular addresses persons, who are concerned with the congura-

on, test, commissioning or maintenance of the supported database, cloud or cluster storage

technology. For the handling of ibaPDA-Data-Store-InuxDB the following basic knowledge is

required and/or useful:

■ Windows operang system

■ Basic knowledge of ibaPDA

■ Basic knowledge of databases, cloud or cluster storage technology

1.0 5

ibaPDA-Data-Store-InuxDB About this manual

1.2 Notaons

In this manual, the following notaons are used:

Acon Notaon

Menu command Menu Logic diagram

Calling the menu command Step 1 – Step 2 – Step 3 – Step x

Example:

Select the menu Logic diagram - Add - New funcon

block.

Keys <Key name>

Example: <Alt>; <F1>

Press the keys simultaneously <Key name> + <Key name>

Example: <Alt> + <Ctrl>

Buons <Key name>

Example: <OK>; <Cancel>

File names, paths "Filename", "Path"

Example: "Test.doc"

6 1.0

About this manual ibaPDA-Data-Store-InuxDB

1.3 Used symbols

If safety instrucons or other notes are used in this manual, they mean:

Danger!

Thenon-observanceofthissafetyinformaonmayresultinanimminentrisk

ofdeathorsevereinjury:

■ Observe the specied measures.

Warning!

Thenon-observanceofthissafetyinformaonmayresultinapotenalriskof

deathorsevereinjury!

■ Observe the specied measures.

Cauon!

Thenon-observanceofthissafetyinformaonmayresultinapotenalriskof

injuryormaterialdamage!

■ Observe the specied measures

Note

A note species special requirements or acons to be observed.

Tip

Tip or example as a helpful note or insider p to make the work a lile bit easier.

Otherdocumentaon

Reference to addional documentaon or further reading.

1.0 7

ibaPDA-Data-Store-InuxDB Introducon

2 Introducon

Dierent types of data stores are available in ibaPDA for dierent purposes and methods of

data storage. Depending on the licenses enabled, dierent types of data stores are available for

conguraon in the dialog.

This documentaon describes the “InuxDB mebased data store” type of recording. This re-

cording type writes mebased data to an InuxDB database management system.

Chapter ì Signal selecon, page 18 describes the selecon of the signals that are to be re-

corded.

The data can be connuously recorded or recorded by trigger, see chapter ì Trigger mode,

page 19.

2.1 System requirements

The following system requirements are necessary when using data storage in an InuxDB server:

■ ibaPDA v8.0.0 or higher

■ License for ibaPDA-Data-Store-InuxDB

■ InuxDB v2.x or higher

The licenses are staggered according to the number of signals that should be wrien in the

InuxDB server. The number of used data stores is unlimited.

Order no. Product name Descripon

30.671060 ibaPDA-Data-Store-InuxDB-64 Data streaming into an InuxDB

server, max. 64 signals

30.671061 ibaPDA-Data-Store-InuxDB-256 Data streaming into an InuxDB

server, max. 256 signals

30.671062 ibaPDA-Data-Store-InuxDB-1024 Data streaming into an InuxDB

server, max. 1024 signals

30.671065 upgrade-ibaPDA-Data-Store-

InuxDB-64 to 256

License for extension from 64 to 256

signals

30.671066 upgrade-ibaPDA-Data-Store-Inux-

DB-256 to 1024

License for extension from 256 to

1024 signals

8 1.0

Data store conguraon ibaPDA-Data-Store-InuxDB

3 Datastoreconguraon

3.1 Add a data store

The dialog for data storage conguraon can be opened in the Congure – Data storage main

menu or by clicking on the buon in the main toolbar.

In order to add a new data store, click on the blue link Add data store in the tree structure. You

can also right-click on the data store node in the tree structure and choose Add data store from

the context menu.

Select InuxDB mebased data store for the streaming of mebased data into an InuxDB serv-

er.

1.0 9

ibaPDA-Data-Store-InuxDB Data store conguraon

3.2 DatastoreInuxDB

Locked

A data store can be locked in order to prevent an accidental or unauthorized change of sengs.

Acve

A data store must be enabled in order to work. However, you can congure various data stores

and disable data stores that are not required.

Datastoreindex

Unique index of all exisng InuxDB data stores. You need to reference this index e.g. in the

virtual funcon DataStoreInfoInux() for generang diagnosc data for a specic InuxDB data

store.

Data store name

You can enter a name for the data store here.

Serveraddress

The IP address or hostname of the InuxDB server.

Port

Port to use for the connecon. The default port is 8086.

<Testconnecon>

Click on the buon <Test connecon> to verify if ibaPDA can establish a connecon to your

InuxDB server using the server address and port number.

10 1.0

Data store conguraon ibaPDA-Data-Store-InuxDB

Organizaon

The organizaon in your InuxDB you want to use.

APItoken

The API token you enter here needs to have read and write rights to the data bucket and, if

used, the metadata bucket. To do this, log in to the InuxDB web interface and go to API to-

ken conguraon. Use the <Copy to clipboard> buon to copy & paste your API token into the

ibaPDA conguraon.

Databucketname

The name of the bucket you want to store the data in.

Use the buon <Find buckets> to ll the dropdown list with all available buckets. Then select

the data bucket you want to use from the dropdown list.

Only buckets will be found (and can be used) which belong to the congured organizaon and

have read rights assigned for the API token in use.

Measurement name

Name for the current measurement

Messagebatchingme,Maxmessagesperbatch

To reduce the number of single telegrams sent to the InuxDB server, mulple data points are

collected and sent as a packet. This is done when either the message batching me expires, or

the number of messages exceeds the max messages per batch number.

Use data compression

You can enable data compression to reduce the size of the transmied data packets.

Communicaonmeout

Time unl a telegram sent to the server is regarded as not successfully delivered.

Maxretries

Number of retries for a not successfully delivered message unl the connecon to the InuxDB

server is regarded as broken.

1.0 11

ibaPDA-Data-Store-InuxDB Data store conguraon

In the lower secon it is congured how metadata should be handled. For examples of the dif-

ferent data models, see chapter ì Examples for data models, page 12.

Select a metadata write mode.

No metadata

Only the data bucket is used. No signal metadata is wrien, except for the ibaPDA signal ID.

The signal ID is wrien as a tag key not as a eld key. Tag keys are indexed in InuxDB. Therefore

queries on tags are faster than queries on elds. In this write mode the least data is transmied

via the line protocol and the least space is required for data storage in InuxDB. The ltering op-

ons in queries are limited on the other hand, since only the signal ID is available as metadata.

Indatabucket

Here you can choose to write addional metadata (the signal ID by default is always wrien). All

addional metadata will be wrien into the data bucket as extra tag keys. Choose via checkbox-

es which metadata you want to include.

■ Unit

■ Comment 1

■ Comment 2

■ Signal name

■ Module number

■ Signal number

■ Data type

■ Sampling rate in ms

The metadata needs to be transmied via the line protocol for each data point in this write

mode. Also more space is required for data storage in InuxDB. The advantage is that me se-

ries data as well as all metadata is kept in one single bucket.

Inseparatebucket

The addional metadata and the signal ID is wrien into a separate bucket. Metadata is wrien

only once when either the IO conguraon or the data store conguraon is applied. Via the

signal ID and the mestamp the metadata and the me series data from both buckets can be

correlated.

This way less data needs to be transferred and stored compared to the write mode “In data

bucket”. The disadvantage is that the analysis e.g. via Flux is more complex.

Metadatabucketname

The name of the bucket you want to store the metadata when using the write mode “In sepa-

rate bucket”. Use the buon <Find buckets> to ll the dropdown list with all available buckets.

Then select the metadata bucket you want to use from the dropdown list.

12 1.0

Data store conguraon ibaPDA-Data-Store-InuxDB

3.3 Examplesfordatamodels

The following example demonstrates what the data in InuxDB will look like when using the dif-

ferent metadata write modes.

Three example signals are congured in a module with number 0 and will be wrien to InuxDB

applying the dierent metadata write modes. The three signals are:

■ The signal with ID [0:0] has a numeric value

■ The signal with ID [0:1] has a text value

■ The signal with ID [0.0] has a boolean value

Metadatawritemode‘Nometadata’

The column _value contains the signal value for each wrien mestamp. The eld key (column

_eld) shows an entry value, value_t or value_b depending on if it is a numeric, text or boolean

signal value. There is just one tag key SignalId lled with the signal ID. A tag key is indexed for

faster query execuon.

1.0 13

ibaPDA-Data-Store-InuxDB Data store conguraon

Metadatawritemode‘Indatabucket’

As an example three addional metadata values are wrien in the data bucket (Unit, Com-

ment 1, Signal name):

Compared to the rst example addional tag key columns for the metadata values appear: Unit,

Comment1, SignalName. InuxDB writes to the data bucket cyclically. Even though metadata

rarely changes, this data is sll transmied and stored repevely.

Metadatawritemode‘Inseparatebucket’

Again three addional metadata values are wrien, but this me in a separate metadata bucket

(Unit, Comment 1, Signal name):

14 1.0

Data store conguraon ibaPDA-Data-Store-InuxDB

The data bucket now again looks the same as when using the write mode ‘No metadata’:

The metadata bucket shows now a single metadata entry per signal for the point of me where

the acquison was started. Metadata can change only when the conguraon was changed.

The column _value contains the signal ID. The eld key (column _eld) is always SignalId. The

tag key SignalId always exists. The other tag key columns depend on the metadata that was con-

gured. In this example again three addional tag key columns Unit, Comment1, SignalName

exist.

Less metadata is transmied this way but the analysis is more complex sind the data from two

buckets needs to be correlated.

1.0 15

ibaPDA-Data-Store-InuxDB Data store conguraon

3.4 Buer

The data storage uses a memory buer and addionally a le buer that can be enabled opon-

ally.

The descripon applies to all types of data stores that transfer data to external systems and

where temporary accessibility and available bandwidth issues may occur, such as:

■ ibaHD mebased/event/lengthbased

■ DB/Cloud mebased

■ Kaa cluster mebased

■ MQTT mebased

■ MindSphere mebased

■ InuxDB mebased

Data to be sent to the target system always passes through the internal ibaPDA memory buer.

If the connecon to the target system exists, the data is sent there from the memory buer im-

mediately. If the connecon is lost, or the data cannot be sent out fast enough, the data remain

in the memory buer. The memory buer is located in the RAM of the ibaPDA computer and is

therefore limited and volale. If, for example, the acquision is restarted, the buered data will

be lost. If the memory buer grows beyond the congured size during ongoing acquision, the

oldest values are deleted and thus lost.

To improve this, a le buer can addionally be enabled, which can buer much larger amounts

of data. The data is stored in les in a directory in a local drive of the ibaPDA server. When the

le buer is enabled, data is transferred from the overowing memory buer to the le buer.

If the acquision is nished or restarted (e.g. by applying a modied IO conguraon), data that

may be in the memory buer at this me is also transferred to the le buer.

Aer reconnecng to the target system, the oldest data is always transferred rst. Newer values

are added to the buer in the meanme. If there is sll buered data in the le buer when the

acquision is started, it will be handled and processed in the same way. The data is saved in the

format that was congured in the data store at the me of buering and it is also sent in this

format when the connecon is established again.

You congure the buering in the Buer node of the respecve data store. The gure below

shows the buer conguraon using the example of DB/Cloud data store.

16 1.0

Data store conguraon ibaPDA-Data-Store-InuxDB

Memorybuer

The memory buer is always enabled. It cannot be deacvated, since data to be transmied

always passes through the buer before being forwarded to the target system.

Maximumsize

Enter here the maximum total size for items buered in memory. If the maximum size is exceed-

ed, there are 2 opons:

■ When le buering is disabled, the oldest item in memory is deleted (and is lost forever).

■ When le buering is enabled, the oldest part of the buer memory is moved to a buer le.

Periodicallypersistmemorybuerevery...s

This opon can be enabled only if le buering is enabled. If the opon is enabled, the enre

memory buer is periodically swapped to a buer le.

Enter a duraon aer which the memory buer is periodically stored. It must be between 10 s

and 600 s.

With this opon you can ensure that as lile data as possible is lost in case of a system failure.

Currentmemoryconguraon

Display of the approximate me period that can be temporarily stored in the memory buer

with the congured sengs. Specied in d.hh:mm:ss.

Filebuer

Uselebuering

By default, the le buer is not used. Here you can enable le buering.

1.0 17

ibaPDA-Data-Store-InuxDB Data store conguraon

Currentleconguraon

Display of the approximate me period that can be temporarily stored in the le buer with the

congured sengs. Specied in d.hh:mm:ss.

Filestoragepath

In the File storage path eld you can select a locaon for the les. You can enter the directory

directly into the text eld, or select it via the browse buon <...>. The congured le directory

must be located on a local hard disk of the ibaPDA server computer.

The same le directory can be used for several data stores, because the buer les of a data

store have a unique name. Files from dierent data stores can thus be disnguished by their

name.

Maximumsize

You can congure the maximum total size of the buer les of a data store. The buer les

themselves have the le extension .buf, the index le for managing the buer les has the ex-

tension .info. The maximum size is the total size of all these les. If the maximum buer size is

exceeded, the oldest buer le is deleted.

Otherbuersengs

Maximumme

Stored data older than the maximum me will not be transferred to the target system. Files old-

er than the maximum me can be deleted. You can enter a value between 1 and 1000 hours.

Memorybuer/Filebuerdiagnoscs

Lastitemremoved

Indicates when the last item was taken from this part of the buer.

Filllevel

The ll level indicates what percentage of the buer size is currently lled with buered data.

Unprocessedlevel

Items transferred to the target system are not deleted immediately in the le buer. Only when

a buer le is completely read, it is deleted. Therefore, it is possible that only a part of a buer

le contains data that has not yet been transferred. The ll level refers to the exisng buer

les, while the "unprocessed level" indicates the percentage of data in the le buer that has

not yet been transferred.

18 1.0

Signal selecon ibaPDA-Data-Store-InuxDB

4 Signalselecon

To enable signals to be recorded, they must be assigned to a storage prole of type Time. Select

the signal selecon node below your InuxDB mebased data store to open the signal selecon

dialog.

In the prole list, select the storage prole to which you want to assign certain signals. Set a

check mark in the selecon elds next to the signals which you would like to assign to this pro-

le. A signal can only be assigned to one prole per data store. The Prole properes secon

displays some informaon about the congured mebase, ltering and column naming of the

selected prole.

InuxDB data stores are staggered according to the number of signals wrien to the database.

The current number of selected signals in all InuxDB data stores is shown at the boom of the

dialog, similar to the number of congured signals in the I/O Manager.

The licensed number of signals is indicated by the length of the signal strip. In the above exam-

ple, it is possible to write up to 1,024 signals in several InuxDB data stores. Currently 6 signals

are enabled.

1.0 19

ibaPDA-Data-Store-InuxDB Trigger mode

5 Triggermode

The descripon applies to all types of data stores that transfer data to external systems, such as:

ibaHD me/event/lengthbased

DB/cloud mebased

Kaa cluster mebased

MQTT mebased

MindSphere mebased

InuxDB mebased.

In the Trigger Mode node, you determine when data is recorded, here using the example of

DB/Cloud mebased data store.

Starttrigger

You inially choose whether you would like to connuously record or it should be red by a trig-

ge r.

Uncondional

The data is connuously recorded with this selecon. In this case, the recording will start imme-

diately at the start of the measurement or when pressing the "GO" buon.

Triggeronsignal

If you want the trigger to re on a measured signal or a virtual signal, you need to check Trigger

on signal in the opon eld. In the elds next to this, dene the properes of the trigger signal.

20 1.0

Trigger mode ibaPDA-Data-Store-InuxDB

■ Field 1: Drop-down list for signal selecon (available analog and digital signals)

■ Field 2: Drop-down list for selecng edges or levels

■ Field 3: Drop-down list for selecng the trigger level value given in the specic physical unit

(eld 3 is only enabled in case of analog trigger signals)

Both analog and digital signals can serve as triggers. The signal to trigger on is to be selected

from the drop-down lists (see picture below, eld 1). In the drop-down list, you will nd the

well-known signal tree containing available signals. Select the signal you want to use as trigger

signal.

Depending on whether a digital or an analog signal was selected, the elds 2 or 3, respecvely,

are oered allowing the trigger event to be dened more specically.

As for analog signals, you can choose between level or edge triggers including a predened level

(eld 3).

As for digital signals, you can choose between level or edge triggers including the 2 levels logical

0 (FALSE) and logical 1 (TRUE).

Page is loading ...

IBA ibaPDA-Data-Store-InfluxDB Owner's manual

Related papers

Other documents