Adapter (tibpromgateway) Command Line Reference

-h

-g

The adapter application sends its data output to the Prometheus Pushgateway at this location.

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

-rs

URL of the realm server. The adapter application receives both its realm definition and monitoring data from the realm server.

The adapter 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).

-s

URL of the backup realm server.

If the regular realm server is unavailable, the adapter 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).

-x

When present, the adapter application removes the client's sampling interval time stamp from the data samples before sending it to the Prometheus Pushgateway.

When the clocks of the clients' host computers are not approximately synchronized, then Prometheus queries that refer to the time stamp field can yield unexpected results. Excluding the time stamp causes the Prometheus Pushgateway to supply a new time stamp value, representing the time that the adapter posted the data sample to the Pushgateway process. (This posting time is necessarily later than the time the client collected the monitoring sample.)

Supply a human-readable string that denotes the source of the monitoring data. The adapter process tags data with this string.

This name becomes the value in the Prometheus exported_job label. You can use this value in Prometheus queries to distinguish data from different sources, for example, primary and satellite realm servers.

When absent, the default value is the URL of the ream server, that is, the value of the -⁠-⁠realmserver command line parameter.

-a

When the adapter stops receiving monitoring data about a client, the adapter waits for this time (in seconds) before instructing the Pushgateway to reclaim the memory that held data about that client.

When absent, the default value is 1800 seconds (30 minutes).

-pf

When present, the adapter 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.

When present, the adapter 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.

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

-t

When present, the adapter 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.

When present, the adapter 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 adapter application sends log output to the console, ignoring the parameters --max-log-size and --max-logs.

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).

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