mqsichangetrace command - Windows, Linux, and AIX systems

Use the mqsichangetrace command to set the tracing characteristics for an integration node or integration server.

Syntax

Some parameters have alternative long names; for example, -e and --integration-server are alternative parameter names for an integration server name. The long names available are listed in the Parameters section.

Syntax (1) Change integration server user trace, service trace, or trace node settings

Read syntax diagramSkip visual syntax diagrammqsichangetraceintegrationNodeName -e integrationServerName -u -t -non | off -l level -m mode -c size -r  --non-persist  -v traceFileName

Syntax (2) Change service trace for all integration servers under an integration node

Read syntax diagramSkip visual syntax diagrammqsichangetraceintegrationNodeName -b  -t   -l level -m mode -c size -r  --non-persist  -v traceFileName

Parameters

integrationNodeName | --integration-node integrationNodeName
(Required) Specify the name of the integration node that you want to trace. All names are case-sensitive on Linux® and AIX® systems.
-c size | --size size

(Optional) The size of the trace file in KB (kilobytes). If you do not specify this parameter, the current value is left unchanged.

Each integration node starts with a default value of 102400 KB. Specify this option to reset the value.

If you change this value, it affects tracing for the integration server (if you specify one), or for the component (if you do not specify an integration server).

-e integrationServerName | --integration-server integrationServerName
(Required for user trace. Required for service trace if you do not specify the -b flag)

Identifies the integration server for which trace options are to be modified (for example, started or stopped).

-l level | --level level
(Optional) Set the level of the trace. The following options are supported:
  • normal. This option provides a basic level of trace information.
  • none. This option switches tracing off.
  • debug. This option provides a more comprehensive trace.
  • debugTree. This option provides debug tracing with the addition of message details.
  • diagnostic. This option provides a highly detailed trace, which must be used only when explicitly required.
  • diagnosticTree. This option provides diagnostic tracing with the addition of message details.

Each integration node is created with a default value of none. If you do not specify this parameter, the current value is unchanged. When you successfully change this value, it is persistent.

-m mode | --mode mode
(Optional) Indicate the way that trace information is to be buffered:
  • safe. This mode causes trace entries to be written to file when they are generated.
  • fast. This mode causes trace entries to be buffered, and written to file in batches.
  • temp= A comma-separated list of BIP messages to disable trace on occurrence of any one of them. You can specify up to 10 BIP messages.
Each integration node starts with a default value of safe. If you do not specify this parameter, the current value is unchanged.

If you change this value, it affects tracing for the integration server (if you specify one), or for the component (if you do not specify an integration server).

-r | --reset

(Optional) This option requests that the trace log is reset: that is, all current records are discarded. Use this option when you start a new trace to ensure that all records in the log are unique to the new trace.

-u | --user-trace
(Required for user trace)

Specifies that user trace options are to be modified.

--non-persist
(Optional) Specifies that changes will not be preserved after the node or server is restarted.
-v | --trace traceFileName
(Optional) Use this parameter to direct service trace of the mqsichangetrace command to a specified file.
-b | --component

Specifies that service trace options for the subcomponent of the integration node that is specified are to be modified (for example, started or stopped). You can specify this flag only if -t is also specified.

You must specify the -b flag or the -e flag, but not both.
-t | --service-trace
(Required) Specifies that service trace options are to be modified. By default, the service trace is output to a default directory as follows:
  • If you included the --work-path parameter on the ibmint create node command, service trace is output to the directory that you specified. For more information, see ibmint create node command.
  • If you did not include the --work-path parameter on the ibmint create node command, service trace is output to a default directory as follows:
    • Windows:%PROGRAMDATA%\IBM\MQSI\Common\log, where %PROGRAMDATA% is the environment variable that defines the system working directory.
    • Linux /var/mqsi/common/log.
For a node-managed integration server, you can redirect the service trace to your specified directory by adding the following entry to the server.conf.yaml file:

# Set the directory to store trace files:
traceDirectory: C:\temp\myTraceDir
For an independent integration server, you can redirect the output of the service trace by specifying a value for traceDirectory in the server.conf.yaml file. For example:
traceDirectory: '/var/mqsi/myTraceDir' # Set the directory to store trace files
-n | --trace-nodes
Specifies the mode for trace flow. Valid values are on and off.
This command, with this flag or combination of flags, is not yet enabled for use with an integration node.

Examples

Collect and process a user trace for the integration server N101ISAA:
mqsichangetrace INODE -u -e N101ISAA -l normal -c 5000
Collect and process a service trace for flow f1 in the integration server N101ISAA:
mqsichangetrace INODE -t -e N101ISAA -m fast
Collect and process a service trace for a component:
mqsichangetrace INODE -t -b -m safe -l normal