Monitoring Gateway Command Line Reference (tibmongateway)

The monitoring gateway service (tibmongateway) stores monitoring data and log messages in an InfluxDB database.

Location

The tibmongateway executable file is located in the bin directory of the product installation tree.

Help

Parameter Arguments Description
--help

-h

  Display a help message describing the command line parameters and options.

Realm Server Communications

Parameter Arguments Description
--realmserver

-rs

URL Required.

URL of the realm server. The gateway application receives its realm definition from the realm server.

The gateway application contacts the realm server at this location. Supply the location of the primary realm server or a satellite server (see "Connect Port" in TIBCO FTL Administration).

--secondary-realmserver

-s

URL Optional.

URL of the backup realm server.

If the regular realm server is unavailable, the gateway application contacts the backup realm server at this location to receive its realm definition. Supply the location of the backup realm server (see "Connect Port" in TIBCO FTL Administration).

--password-file

-pf

path Optional. (Required for JAAS authentication to the realm server.)

When present, the gateway application reads a user name and password from the file at path, and authenticates itself to the realm server using those credentials. For details, see "Password File" in TIBCO FTL Admistration.

--trust-file path Optional. (Required for TLS communication with a secure realm server.)

When present, the gateway application reads a trust file from path, and uses that trust data in communications with the secure realm server. See "Running a Secure Realm Server" in TIBCO FTL Admistration.

--trust-everyone Optional.

The gateway application trusts any realm server without verifying trust in the server's certificate.

Warning: Do not use this parameter except for convenience in development and testing. It is not secure.
--client-label label Optional.

When present, the gateway process uses this string as its client label. You can use this string to identify the gateway process in the realm server GUI.

InfluxDB Communications

Parameter Arguments Description
--influx-server

-i

URL Required.

The gateway connects to the InfluxDB server at this location.

Supply an IP address and port number, separated by a colon character (:).

When the URL specifies the https:// protocol, then the gateway initiates a secure connection. Otherwise the connection is not secure.

When the port is absent, the gateway uses 8086 as the default port.

--username user The gateway authenticates itself to InfluxDB server with this user name credential.
--password pw The gateway authenticates itself to InfluxDB server with this password credential.
--influx-trust-file filepath When the gateway uses SSL to communicate with the InfluxDB server (see --influx-server), supply the location of a trust file for the InfluxDB server's public certificate.
--influx-trust-everyone Optional.

The gateway application trusts any InfluxDB server without verifying trust in the server's certificate.

Warning: Do not use this parameter except for convenience in development and testing. It is not secure.

Tracing and Logging

The gateway can also produce log messages that reflect its own behavior, which it also forwards to the realm server. The parameters in this table govern this intrinsic logging behavior (rather than writing the log stream to a database, which is the gateway's primary function).

Parameter Arguments Description
--trace

-t

level Optional.

When present, the gateway application outputs trace messages to stderr.

You may specify any of the standard log level strings (see “Tuning the Log Level” in TIBCO FTL Development).

When absent, the default trace level is info.

--logfile logfile_prefix Optional.

When present, the gateway application logs to a rolling set of log files instead of the console. The logfile_prefix argument may denote a path. All of the directories in the path must already exist.

For more information about rotating log files, see “Log Output Targets” in TIBCO FTL Development.

When absent, the gateway application sends log output to the console, ignoring the parameters --max-log-size and --max-logs.

--max-log-size size Optional.

Limits the maximum size, in bytes, of log files. The value must be greater than 100 kilobytes (102400). The default value is 2 megabytes (2*1024*1024).

--max-logs Optional.

Limits the maximum number of rolling log files. The default is 50.