Customizing the Trace for IBM Sterling Transformation Extender Rest Execution
About this task
To customizing the trace for IBM Sterling Transformation Extender Rest execution, complete the following steps:
Procedure
- Locate the config/config.yaml file in the data directory of the product. The data directory is configurable on Windows during the installation. On Unix, it is defined with DTX_DATA_DIR environment variable.
- Open the config.yaml file using a yaml editor.
- Find the /rest/logging path in the config.yaml file. This is where you can configure the trace settings for the REST API execution.
-
To enable verbose logging, set the trace level to "ALL" or
"TRACE" by updating the value associated with the trace
level setting. For example:
/rest/logging: trace_level: ALL
For informational messages, set the trace level to "INFO":/rest/logging: trace_level: INFO
To trace errors only, set the trace level to "ERROR":/rest/logging: trace_level: ERROR
Note: Trace level specifies the verbosity level of execution logs. The options range from least verbose to most verbose: ALL, TRACE, INFO, ERROR, and NONE. Also, to Include a header that explains each row in the trace file, set the Header value as true. -
Customize the information displayed in the log file by selecting desired
columns. Use the /rest/logging/columns path to include or
exclude specific trace file columns. For example, if you want to include
specific columns:
/rest/logging/columns: (This section specifies which columns of information to show in the log entries. Each column has its own sub-settings, if any values set to false, so that column would not be shown.) - time (Displays the time of the log entry in UTC with milliseconds) - uuid (Displays the UUID of each instance.) - rc (Displays the return code associated with the log entry.) - rcText (Displays a text description of the error code.) - msgID (Displays the ID of a trace message.) - flowName (Displays the flow, node, or adapter name that generated the message.) - msg (Displays the actual trace message.) -funcName (Displays the function name) - sourceInfo (Displays source file and line information).
- Save the changes to the config.yaml file.
-
The trace file will be saved in the product logs directory
(<DATA_DIR>/logs) with a naming format such as
flowexecredis_<PID>_<DATE>.log.
Note: Make sure that any modifications you make to the config.yaml file is valid. To verify the config.yaml file, see How to verify the config.yaml file for detailed instructions.