Trisul Hub Configuration File

All configuration parameters for the Trisul Hub are stored in a single XML file called trisulHubConfig.xml.



for context named data1 the path would be …hub0/context_data1/trisulHubConfig.xml

Root privileges needed to edit
Also see trisulProbeConfig.xml for editing Probe node parameters


Click on a section to see the config parameters inside that section.
Section What part of trisul does it configure
App The hub process level params
Logging Logging policy – file sizes and rotation
StatsEngine Database cluster tuning
Server For TRP – server parameters
Probes List of probes allowed to connect and mapping to layers
IPDR IP Flow Detail Record (IPDR) application parameters
DBTasks Setting for various database maintenance tasks


Settings for the Trisul daemon process

Commonly modified parameters are Setuid, TrisulMode, LicenseFile
Parameters Defaults Description
User trisul.trisul Which user/group should trisul run as after dropping root privileges.
TempFolder /tmp
DBRoot /usr/local/var/lib/trisul-hub/ domain0/hub0/context0 The base directory under which Trisul stores all its data.
TrafficDBRoot /usr/local/var/lib/trisul/domain0 /hub0/context0/meters The directory under which Trisul stores traffic and flow statistics.
ConfigDB /usr/local/var/lib/trisul/ domain0/hub0/context0/ config/TRISULCONFIG.SQDB Location of the configuration database.
BinDirectory /usr/local/bin Where trisul looks for executable binaries
DataDirectory /usr/local/share/trisul-hub Data files
LicenseFile /usr/local/etc/trisul-hub/LicenseKey.txt Location of the license file.
DebugMode false Debug mode is used when trying to develop LUA probe scripts. If DebugMode == True then all streaming metrics from all probes are just sunk to /dev/null. Hence this is used for probe testing


The two components in a Hub node are flushers and query servers. This section configures their log files with prefix fs and qs respectively.

Parameters Defaults Description
Logdir /usr/local/var/log/trisul Where the log files are stored.
Logfile ns-???.log Log file pattern. The default is ns-001.log, ns-002.log, etc.
LogRotateSize 5000000 Size of each log file is allowed to grow to this size before Trisul moves to the next file.
LogRotateCount 5 The number of files in the log ring.
FlusherLogFile fs-???.log log file pattern.
FlusherLogLevel DEBUG All messages higher than this level are logged. The available log levels in order of severity (most severe one first is).
WARN — this level after a few weeks of smooth running
DEBUG — Recommended default level
FlusherLogRotateSize 5000000 Max size of each log file
FlusherogRotateCount 5 Number of files in ring
TrpLogFile qs-???.log log file pattern.
TrpLoglevel DEBUG log level
TrpLogRotateSize 5000000 Max size of each log file
TrpogRotateCount 5 Number of files in ring
IpdrdLogFile is-??? IPDR log file pattern. These parameters are for the IPDR query service
IpdrdLoglevel DEBUG IPDR service logging level.
IpdrdLogRotateSize 5000000 Max size of each file in bytes
IpdrdLogRotateCount 5 Number of log files


Controls the database storage and retention policy for Trisul.

Parameters Defaults Description
FTSFlushBudget 5 Trisul FTS (Full Text Resources) need to complete the Flush operation within these many seconds. Since Trisul is a Real time system, we have a total about about 60 seconds for the entire snapshot window to flush.
JournalMode WAL Trisul Resources are stored in SQLITE3 leaf nodes.
OfflineAnalysisQueueSize 2000000 When importing PCAPs or other offline formats, this parameter controls the Hi Water mark of the items on the queue of the Hub. This helps to control memory usage on the Hub Node.


Controls data location and retention policy.

Parameters Defaults Description
SliceWindow DAILY How much data is contained in a single slice. The available choices are :
HOURLY From 00 Min to 59 Min every hour
DAILY From 12:00 AM to 11:59 PM every day


Parameters Defaults Description
SliceCount 32 32 slices are kept in the operational area. Combined with the default SliceWindow of DAILY. This means 32 days worth of data in the oper area. Slices older than 32 days will slide over to the reference area.
UsageRedMark Generate an alert when the disk usage percent exceeds this value for admin purposes. Leave blank or zero to disable disk usage alerting. Default disabled.


Parameters Defaults Description
SliceCount 32 Controls how many slices are kept in the reference area. If you set this to 0, the slices will then move straight from operational to archive.
UsageRedMark Generate an alert when the disk usage percent exceeds this value for admin purposes. Leave blank or zero to disable disk usage alerting


For long term storage mostly for compliance purposes.

Parameters Defaults Description
SliceCount 32 Controls how many slices are kept in the archive area. If you set this to 0, slices move directly to /dev/null (ie are deleted).
UsageRedMark 95 Generate an alert when the disk usage percent exceeds this value for admin purposes. Leave blank or zero to disable disk usage alerting

Extra archives

An optional feature for advanced users allows for extra archives for example to be mounted to slower storage. These are disabled by default. Change the name of the node from ExtraArchives_Disabled to ExtraArchives to activate this feature.

Parameters Defaults Description
ID 1 This ID is used to access the archive mount point. ID of 1 would lead to mount point xarchive_1
SliceCount 32 Number of days data in this extra archive


This section controls how many backend flushers are used. The default number of flushers used by Trisul is TWO. This is an advanced tuning parameter. You can increase the number of flushers up to eight for large to very large deployments of Trisul.

Parameters Defaults Description
ServerImage Path to trisul_flushd
PIDFile Where the PID for the running trisul_flushd process is stored
AutoStart true Automatically start flushd process
ControlChannel Internal IPC channel
Flushers For each flusher instance specify the connection and DB instance number. Sequentially from 0..8 (MAX)


Controls the TRP Server Process used for database querying functionality. The process that provides the query API is called trisul_trpd@

Parameters Defaults Description
ZmqConnection The port running the TRP Protocol where you can connect and query the trisul database. By default, this is an IPC socket ipc:///usr/local/var/lib/trisul-hub/domain0/hub0/context0/run/trp_0. You can change this parameter to allow a remote TCP connection.

Example: To allow queries using TCP Port 12004

  1. Change this parameter to tcp:// where is the IP address of the HUB node

  2. Then restart the context like so trisulctl_hub restart context default@hub0

PIDFile Where the PID of the running trisul_trpd process is stored
NumServers 6 Number of backend servers to start.
ParallelQueries false Whether parallel queries must be turned on for all queries. The defautl is false, use this only when you have the database stored on different spindles.


Add probes that are allowed to connect to this context.

Each probe is a line with the following details.

Parameters Defaults Description
Layer Layer number allocated to the probe.
ProbeID ProbeID eg, probe0 this probe must be authenticated by a CURVE certificate earlier for the domain this hub belongs to. See trisulctl_hub install probe


Control the various database maintenance tasks. These tasks are scheduled internally by Trisul at fixed intervals.


Archiver is responsible for sliding old data.

Parameters Defaults Description
Enable TRUE Archiving is enabled.


Slices data is summarized so that reporting on total entities are fast.

Parameters Defaults Description
Enable TRUE Fine grained daily summary calculation of per group disk storage.


Database optimizer task to pack frequently used keys to speed up long range time series operations.

Parameters Defaults Description
Enable TRUE Archiving is enabled
TopKeyCount 25 The top 25 keys in each metric can be selected for faster retrieval
InKeyCount 100 In addition to the toppers, these many keys can be selected for caching


This section controls the automatic IP address resolver.

How IP Address resolution works

  • Runs at fixed intervals automatically, typically every 15 minutes or so.
  • In Packet Capture mode , all IP address to hostnames are harvested from DNS packets automatically
  • In Netflow mode , the most important IP addresses that appears in “topper lists” are resolved using DNS lookup.

        <Enable> True </Enable>
        <Debug> True </Debug>

Parameters Defaults Description
Enable TRUE Most important / visible IPs are resolved using DNS lookup
Debug TRUE Prints resolved IPs for debugging purposes in t_resolveip.log file
Candidates Number of Top-K items per meter for Internal IPs vs External IPs. Internal IPs are those which fall into your Home Network
AlwaysRefreshExternal false Do a full refresh of External IPs. Normally, the resolver does not keep trying to resolve IPs that fail to resolve or those IPs which have already been recently resolved.
AlwaysRefreshInternal false Do a full refresh of Internal IPs. Use this option if you have an enterprise with dynamically changing IP → User names.


The persist storage area collects key related information – such as IP to host name mappings etc. Over a long period of time this can grow to huge proportions. The CleanPersist process prunes this storage area by randomly deleting 2% of keys each run.

Parameters Defaults Description
Enable TRUE Archiving is enabled


A database packer algorithm to speed up database reads and to defragement files.

Parameters Defaults Description
Enable TRUE Archiving is enabled


These paramters are for the IPDR Service. IPDR is the IP Detailed Record logging service. This is a mode of storing very large number of raw flows for compliance and query purposes.

OutputDirectory SQCONTEXTROOT/run Directory where the IPDR record query result is dumped
ControlDB SQCONTEXTROOT/config/IPDRCONTROL.SQDB The control database location
ReportFormat full The format of the IPDR records. Available values are
  • full – The full record in columnar report format
  • fullcsv – Full report in CSV format
  • trai – Format for TRAI

Advanced DB Parameters

Database parameters to optimize. Generally these need to be only changed for very large deployments which are facing significant performance issues.

The following table lists some parameters that might be useful.

Under the node : DBParameters > FlowStream

Parameters Defaults Description
MicroSecondTimestamps TRUE Does the flow database need microsecond timestamps. Use case : Compliance for large flow stores. Disabling microsecond timestamps for start and end time can save about 8 bytes / per flow
ZFLOWBLOCK_COMPRESSOR_CODE lz4 The compressor type for the flow database. Available parameter values are

  • lz4

  • lz4-fast16 : Advanced compression use only if necessary. Also supported lz4-fast5, and lz4-fast10

  • lz4-ipv4-call-log-with-nat-pro : Use this for IPv4 only IPDR application with NAT IP. Max compression

  • lz4-ip-call-log-with-nat-pro-max : For both IPv4 and IPv6 with NAT IP, Port, userid for full log

kFLOWS_PER_BLOCK The number of flows per block. Default 4096
kBLOOM_AGG_SIZE The number of flow blocks per bloom filter.
kBUMPX_AGG_SIZE The number of flow blocks per full bitmap filter index.