mqsichangetrace command - Windows, Linux, and UNIX systems

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

Syntax

User trace

Read syntax diagramSkip visual syntax diagrammqsichangetraceintegrationNodeName -e integrationServerName -u  -c size -f messageFlow -k applicationName -l level -m mode -r  -y libraryName

Service trace

Read syntax diagramSkip visual syntax diagrammqsichangetraceintegrationNodeName -t  -b  -e integrationServerName -f  messageFlow -r  -c size -k applicationName -l level -m mode -y libraryName

Trace nodes

Read syntax diagramSkip visual syntax diagrammqsichangetraceintegrationNodeName -n  switch -e integrationServerName -f messageFlow -k applicationName -y libraryName

Parameters

integrationNodeName
(Required) Specify the name of the integration node that you want to trace. All names are case sensitive on Linux® and UNIX systems.
-c 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. The maximum value you can specify depends on how you subsequently intend to read the log, by using the mqsireadlog command;
  • If you use the mqsireadlog command with the -f option set, the log file is read directly from the file system. In this case, the maximum value that you can specify is 2097151, which allows a trace file up to 2 GB (gigabyte) to be created.
  • If you use the mqsireadlog command without setting the -f option, a WebSphere® MQ message is sent to the integration node to retrieve the log. In this case, do not allow the trace file to exceed 70 MB (megabytes). The maximum value that you can set is 70000.

On HP-UX, set the size value below 500 MB.

However you intend to retrieve the trace file, you might want to keep its size small, either by using a low value for this parameter, or by using the reset (-r) option on this command to clear the trace log. The benefit of adopting this approach is that the formatting process (mqsiformatlog) is much faster and requires less resource to carry out its task.

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

-e 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).

-f messageFlow

(Optional) Identifies the message flow for which trace options are to be modified. This option is valid only if you have specified an integration server (flag -e).

-k applicationName
(Optional) This parameter specifies the name of the application that contains the message flow for which trace options are to be modified.

When you set this parameter, you must also set the -f (message flow) parameter. To change trace options for a named message flow in a specific application, set the -k and -f parameters.

You can use this parameter with the -y (library name) parameter to specify that the message flow is contained in a library referenced by the application.

-l 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.

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 have successfully changed this value, it is persistent.

-m mode
(Optional) Indicate the way 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.
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 have specified one), or for the agent component (if you have not specified an integration server).

-r

(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
(Required for user trace)

Specifies that user trace options are to be modified.

-y libraryName
(Optional) This parameter specifies the name of the library that contains the message flow for which trace options are to be modified.

When you set this parameter, you must also set the -f (message flow) parameter. To change trace options for a named message flow in a specific library, set the -y and -f parameters.

Additional parameters exclusive to service trace

Use these options only when directed to do so by your IBM® Support Center, or by a BIPxxxx message.

-b

(Required) Specifies that service trace options for the agent subcomponent of the integration node 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.
-m mode
(Optional) In addition to the safe and fast modes available for user trace, there is a third temp mode available with integration server service trace only:
  • temp. This mode is the same as safe mode, but trace is automatically switched off when the component restarts. You can also specify BIP numbers to stop the trace automatically. You can specify up to 10 BIP numbers, separated by commas, as shown in the following examples:
    mqsichangetrace IB9NODE -e default -t -l debug -m temp
    mqsichangetrace IB9NODE -e default -t -l debug -m temp=BIP2213E
    mqsichangetrace IB9NODE -e default -t -l debug -m temp=BIP4395E,BIP2213E
-t

(Required) Specifies that service trace options are to be modified.

Additional parameters exclusive to Trace nodes

-n switch
(Required) Specifies the mode for trace flow. Valid values are on and off.

Examples

To collect and process a user trace for the default integration server use the command:
mqsichangetrace IBNODE -u -e default -l normal -c 5000
To collect and process a service trace for flow f1 in the default integration server use the command:
mqsichangetrace IBNODE -t -e default -m fast
To collect and process a service trace for an agent use the command:
mqsichangetrace IBNODE -t -b -m safe -l normal
To switch off Trace nodes in the default integration server, use the command:
mqsichangetrace IBNODE -n off -e default