Configure XMS .NET trace using XMS environment variables

Configure XMS .NET trace using XMS environment variables

We can turn on trace using XMS environment variables such as XMS_TRACE_ON.

About this task

If we are using IBM MQ classes for XMS .NET Framework, we can turn on trace using XMS environment variables an alternative to using an application configuration file. The environment variables are only used if there is no trace specification in the application configuration file.

If we are using IBM MQ classes for XMS .NET Standard, we must configure trace from the XMS environment variables. Using an application configuration file is not supported for IBM MQ classes for XMS .NET Standard.

Procedure
To configure trace for an XMS .NET application, set the following environment variables before running the application:

Environment variables Default Sets Meaning

XMS_TRACE_ON Not applicable Not applicable: the value of this variable is ignored If XMS_TRACE_ON is set, all trace is enabled by default.

XMS_TRACE_FILE_PATH Current working directory /dirpath/ The directory path that trace and FFDC records are written to.
XMS creates FFDC and trace files in the current working directory, unless you specify an alternative location. We can specify an alternative location by setting the environment variable XMS_TRACE_FILE_PATH to the fully qualified path name of the directory where we want XMS to create the FFDC and trace files. We must set this environment variable before you start the application that we want to trace. We must make sure that the user identifier under which the application runs has the authority to write to the directory where XMS creates the FFDC and trace files.

XMS_TRACE_FORMAT BASIC BASIC, ADVANCED Specifies the required trace format, which can be either BASIC or ADVANCED. The default format is BASIC. The ADVANCED format is compatible with trace analyzer tools.

XMS_TRACE_SPECIFICATION Not applicable See Configure XMS .NET trace using an application configuration file (IBM MQ classes for XMS .NET Framework only) Overrides the trace specification, which follows the format specified in Configure XMS .NET trace using an application configuration file. (IBM MQ classes for XMS .NET Framework only)

Parent topic: Configure trace for XMS .NET applications

Related tasks

Configure XMS .NET trace using an application configuration file

Last updated: 2020-10-04

Environment variables	Default	Sets	Meaning
XMS_TRACE_ON	Not applicable	Not applicable: the value of this variable is ignored	If XMS_TRACE_ON is set, all trace is enabled by default.
XMS_TRACE_FILE_PATH	Current working directory	/dirpath/	The directory path that trace and FFDC records are written to. XMS creates FFDC and trace files in the current working directory, unless you specify an alternative location. We can specify an alternative location by setting the environment variable XMS_TRACE_FILE_PATH to the fully qualified path name of the directory where we want XMS to create the FFDC and trace files. We must set this environment variable before you start the application that we want to trace. We must make sure that the user identifier under which the application runs has the authority to write to the directory where XMS creates the FFDC and trace files.
XMS_TRACE_FORMAT	BASIC	BASIC, ADVANCED	Specifies the required trace format, which can be either BASIC or ADVANCED. The default format is BASIC. The ADVANCED format is compatible with trace analyzer tools.
XMS_TRACE_SPECIFICATION	Not applicable	See Configure XMS .NET trace using an application configuration file (IBM MQ classes for XMS .NET Framework only)	Overrides the trace specification, which follows the format specified in Configure XMS .NET trace using an application configuration file. (IBM MQ classes for XMS .NET Framework only)