Skip to main content

Veritran Docs

Log Realms

Log Realms is a feature that allows you to modify log levels on different objects within VT-NET to obtain more detailed information for troubleshooting or diagnostic purposes.

With Log Realms, you can increase log levels for processes, lines, stations and queues filtering by specific categories, also known as realms. These categories are:

  • TRANSACTIONS: Data associated with the transactions that are running.

  • TRANSACTION-trxCode: Data associated with a specific transaction code.

  • SERVICES: Data associated with the services that are running on the platform.

  • SERVICE-serviceCode: Data associated with a specific service code.

  • TERMINAL-terminalId: Data associated with the transactions that are being processed on a specific terminal ID.

  • PERIODIC: Data associated with a specific periodic task.

These categories can also be combined to obtain more detailed results. The terminal realm can be combined with either the transactions or the services realms

Important

To use Log Realms, you must meet the following version requirements:

  • VT-Middleware 1.13.5.37

  • VT-Notif 1.13.5.43

  • VT-AS 1.13.5.10 / 1.13.4.XXX

Modify Log Levels

To change a log level, type the following command, replacing placeholder values with the corresponding values:

logger [OBJECT] [name reg exp], [key=LoggerKey] | [realm=LogRealm], [ [level=N]

  • Replace the [OBJECT] parameter with proc/process, line, station or qserv/qservice, as needed.

  • Replace the [name reg exp] with the name of the object selected in the previous parameter.

  • LoggerKey should be some valid logger key, for development purposes only. This value is optional.

  • The LogRealm parameter should be replaced with one of the realms or categories listed above. See Log Realms to read about these realms.

  • The N parameter or level can be a number between 1 and 50. This value will impact on the log real specified in this command, and not on the whole platform. See the table on Changing Log Levels to learn about each level and their meaning.

You can delete one or all Log Realms configurations and revert to default values by adding the clear parameter to the code, as shown below.

"logger [OBJECT] [name reg exp], [key=LoggerKey] | [realm=LogRealm], [clear]"
"logger [OBJECT] [name reg exp], [key=LoggerKey] | [realm=all], [clear]"
Verify Log Realms Log Level

You can also verify the Log Realms settings for a process. To do this, send a subcommand to the process, as shown below:

/veritran/vt-net/bin/vtNetQShell -e [ENVIRONMENT] -n [NODE] -c "send proc [PROCESS],cmd=getLogRealms"

As with every "send" command, the result will display in the command (CMD) log. Go to the CMD log to see which Log Realm level is applied to the corresponding process.

In this section: