EXAMPLES

Generating a default config for an instance named foo:

vtapericsson -d >/etc/aitia/vtapericsson.foo.rc

Note: the application won’t start without setting the mandatory parameters in the generated config.

Starting the foo instance:

vtapericsson /etc/aitia/vtapericsson.foo.rc

DESCRIPTION

vtapericsson is a essential component of AITIA’s 5G monitoring. The application handles the incoming vTap datastream generated by Ericsson’s virtual network functions and filters and converts data format to the sga 5G dataformat described in the design documentation (SGA_5G_Monitorozas_alapjai).

Query UDP buffer size:

sysctl net.core.rmem_max
net.core.rmem_max = 212992

Set UDP buffer size (volatile):

sudo sysctl -w net.core.rmem_max=67108864
net.core.rmem_max = 67108864

Set UDP buffer size (non-volatile):

sudo echo "net.core.rmem_default=67108864" > /etc/sysctl.conf
sudo echo "net.core.rmem_max=67108864" > /etc/sysctl.conf

Example rc file: 

# Command channel socket address in 'host:port' format
configs.set app.address 127.0.0.1:16022

# Automatic linkid database update period
configs.set linkid.refresh 1m

# URI for connecting to the SQL DB for linkid lookup. E.g.: 127.0.0.1?dbname=xxx&user=yyy&pass=zzz
configs.set linkid.uri '10.6.163.92:7008?dbname=sga&user=sga&pass=sga'
# The rulegroup of the application instance
configs.set linkid.group vTapEric

io.open in socket-gre://10.6.200.137:4754?type=udp&critical=false&name=c1

#io.open out file-sga://test_full.sga
io.open out socket-adg://127.0.0.1:9998?name=msgwriter_local
io.sorter in 1000 1000000

process.start

The input and output channel have to be configured and the process have to be started. If multiple input channels are used the input io.sorter have to be configured for 1s sorting, and every channel have to be configured as non-critical. The JSON value in the resp parameter have to be put between ''. The application only uses filtering rules defined for its group and group "All".

The application detaches itself from the terminal on startup. It can be accessed via TCP command channel using sga-rc(1) application or TCP socket. The application also responds to OS signals (see later).

OPTIONS

The config file of the application instance is a mandatory parameter. Recommended directory for Aitia application config files is /etc/aitia, recommended naming convention for config files is executable.instance.rc, where executable is the name of the application binary and instance is a user selected custom name for the application instance.

Note: Without specifying a configuration file the application will fail on startup.

List of available options:

CONFIGS

The config file contains the same commands that are available from command interface.

Note: The application will fail on start if the specification of any mandatory parameter is missing.

Note: Time duration type config parameters need the specification of the time unit. Available time units are: ns, us, ms, s, m, h, d. Examples: 100ms, 5m.

List of available config parameters:

COMMANDS

The application can receive user commands on the specified TCP/IP interface. Command interface is using a bash like format. Every command should be in a new separate line. Commands can have parameters, the command name and parameters are separated with whitespace characters.

If the parameter value contains whitespace, it should be escaped or quoted. The backslash (\) character escapes the following character (e.g: state.load /dir\ with\ spaces/statefile). The single quote (') character can escape multiple characters (e.g: state.load '/dir with spaces/statefile').

The hash (#) symbol can be used to comment out parts of the command. The commented part starts at the comment character and ends at the end of the line (e.g: state.load /path/statefile #opens the state file).

io.sorter: io.sorter can be configured to empty sorter buffer if no message received in the last n milliseconds. After the last incoming message a real-time timeout starts based on the CPU’s timestamp-counter register (rdtsc), if no message received in the configured timeout then the sorter will be flushed.

Format: io.sorter <delay> <length> <timeout> , if timeout set for 0, then there is no flushing legacy mode

List of available commands:

COUNTERS

List of counters:

STATES

The application can load and save its states on demand (receiving corresponding commands). There is no automatic state handling.

Note: The state file is a TAR format file pack.

SIGNALS

The application handles the following Signals from the OS:

CONNECTIONS

The application can handle multiple input/output channels. The channels are composed of a transport method, a capture formatter used for packet encapsulation and optional filters. There are multiple transports and formats available, which can be used in different variations.

Channels are configured using URI format:

<transport>-<format>://<resource>?<parameters>

Examples:

Input ADG format over listen socket:

socket-adg://127.0.0.1:12345?listen=1&name=MyInput

Output ADG format over socket:

socket-adg://127.0.0.1:12345?name=MyOutput

BUGS

Report bug at http://tsplab.hu/redmine.

COPYING

Copyright © 2020 Aitia International Inc.