Log Service Command Line Reference (tiblogsvc)
The log service (tiblogsvc) retrieves monitoring data and log messages from an InfluxDB database to respond to REST requests.
Location
The tiblogsvc executable file is located in the bin directory of the product installation tree.
Web API
The log service accepts REST requests through an HTTP interface. For details see Log Service Web API.
| Parameter | Arguments | Description |
|---|---|---|
| -http | URL | Optional.
The log service accepts requests at this location. Specify host:port. When absent, the default location is localhost:8085. |
| -h-cert
--http-certificate |
path | Optional.
The log service identifies itself to HTTP clients using the public certificate in this file (PEM format). |
| -h-key
--http-key |
path | Optional.
The log service secures client communications using the private key in this file (PEM format). |
| -h-pf
--http-password-file |
password_file | Optional.
The log service uses the password in this file to decrypt the private key file. Format the file as one line of text, containing either the password or mangled password. |
| -h-pass
--http-password |
password | Optional.
The log service uses this password to decrypt the private key file. |
Realm Server
| Parameter | Arguments | Description |
|---|---|---|
| -rs
--realmserver |
URL | Required.
URL of the realm server. The log service application receives its realm definition from the realm server. The log service 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
--secondary-realmserver |
URL | Optional.
URL of the backup realm server. If the regular realm server is unavailable, the log service 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). |
| -rs-pf
--realmserver-password-file |
path | Optional. (Required for JAAS authentication.)
When present, the log service 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. |
|
-rs-user
--realmserver-username |
user_name | Optional.
When present, the log service authenticates itself to the realm server using this user name credential. |
| -rs-pass
--realmserver-password |
password | Optional.
When present, the log service authenticates itself to the realm server using this password credential. |
|
-rs-tf
--realmserver-trust-file |
path | Optional. (Required for TLS communication with a secure realm server.)
When present, the log service 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. |
| -rs-te
--realmserver-trust-everyone |
Optional.
The log service application trusts any realm server without verifying trust in the server's certificate. |
InfluxDB
| Parameter | Arguments | Description |
|---|---|---|
| -i
--influx-server |
URL | Required.
URL of the InfluxDB server. The log service application contacts the InfluxDB server at this location. Supply the location in the form host:port. |
| -i-pf
--influx-password-file |
path | Optional. (Required for JAAS authentication.)
When present, the log service application reads a user name and password from the file at path, and authenticates itself to the InfluxDB server using those credentials. The password file consists of two lines. The first line contains the user name. The second line contains the password string. |
|
-i-user
--influx-username |
user_name | Optional.
When present, the log service authenticates itself to the InfluxDB server using this user name credential. |
| -i-pass
--influx-password |
password | Optional.
When present, the log service authenticates itself to the InfluxDB server using this password credential. |
|
-i-tf
--influx-trust-file |
path | Optional. (Required for TLS communication with an InfluxDB server.)
When present, the log service application reads a trust file from path, and uses that trust data in communications with the InfluxDB server. |
| -i-te
--influx-trust-everyone |
Optional.
The log service application trusts any InfluxDB server without verifying trust in the server's certificate. |
Tracing and Logging
The log service 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 of the retrieval service (rather than the logs it retrieves from the database).
| Parameter | Arguments | Description |
|---|---|---|
| -t
--trace |
level | Optional.
When present, the log service 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. |
| -l
--logfile |
logfile_prefix | Optional.
When present, the log service 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 log service application sends log output to the console, ignoring the parameters - -max-log-size and - -max-logs. |
| -ls
--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). |
| -lf
--max-logs |
Optional.
Limits the maximum number of rolling log files. The default is 50. |
Configuration
| Parameter | Arguments | Description |
|---|---|---|
| -c
--config-file |
path | Optional.
When present, the log service reads additional command line arguments from this configuration file. The configuration file can specify any number of optional command line parameters and their arguments. If you specify both a configuration file and command line options, the command line options override those in the file (where they conflict). |