ibm mq insight pack...ibm mq trace limitations please consider below limitations comes with mq trace...

IBM MQ Insight Pack

IBM

ii IBM MQ Insight Pack

Contents

IBM MQ Insight Pack . . . . . . . .. 1Installing the IBM MQ Insight Pack. . . . . .. 1IBM MQ Insight Pack configuration artifacts. . .. 2Configuring the IBM MQ Insight Pack. . . . .. 2IBM MQ Insight Pack splitter rules . . . . . .. 4IBM MQ Insight Pack Annotation rules and indexconfiguration . . . . . . . . . . . . .. 5

IBM MQ Insight Pack dashboard . . . . . .. 11MQ Trace dashboard . . . . . . . . . .. 11Configuring the IBM MQ Insight Pack dashboardapp . . . . . . . . . . . . . . . .. 12IBM MQ Insight Pack References . . . . . .. 12Support . . . . . . . . . . . . . .. 13

iii

iv IBM MQ Insight Pack

IBM MQ Insight Pack

An IBM® MQ Insight Pack is provided with IBM Operations Analytics - Log Analysis.

The IBM MQ Insight Pack provides the capability to index and search against IBM MQ logs files in IBM Operations Analytics - Log Analysis to enable faster problem identification in MQ-related problems.

The IBM MQ Insight Pack supports logs from the following: v IBM MQ 9.0.0.3 & 9.0.0.4 v IBM MQ 8.0 v MQ Series 7.5 v MQ Series 7.1 v MQ Series 7.0.1

The IBM MQ Insight Pack supports searching and indexing of the following:

AMQERR logs generated per Queue Manager

UNIX: At /var/mqm/qmgrs/<queueManagername>/errors

Windows: At c:\Program Files\IBM\WebSphere MQ\qmgrs\<queueManagername>\errors

AMQERR.log that is common for all queue managers.UNIX: At /var/mqm/errors

Windows: At c:\Program Files\IBM\WebSphere MQ\qmgrs\errors

The error log files, named AMQERR01.LOG, AMQERR02.LOG, and AMQERR03.LOG, containinformation that is logged by queue managers that can be used for problemdebugging.

MQ FFST files generated by Queue ManagerUNIX: At /var/mqm/errors

Windows: At c:\ProgramData\IBM\MQ\errors

The MQ FFST files are named AMQnnnnn.mm.FDC where nnnn is the ID of the processreporting the error, and mm is the sequence number.

Note: The c:\ProgramData directory is hidden by default. To change the directory,enter %PROGRAMDATA% in the Windows Explorer location bar to browse it, orconfigure Windows Explorer to show hidden files and directories.

MQ Trace files generated by Queue ManagerUNIX: At /var/mqm/trace

Windows: At %MQ_DATA_PATH%\trace

Note: Trace files must be generated manually and converted to text format.For more information, see http://www-01.ibm.com/support/docview.wss?uid=swg21174924#Network

Installing the IBM MQ Insight PackTo index and search IBM MQ logs, you must install the IBM MQ Insight Pack.

1

http://www-01.ibm.com/support/docview.wss?uid=swg21174924#Network

http://www-01.ibm.com/support/docview.wss?uid=swg21174924#Network

About this task

The IBM MQ Insight Pack is installed by using the pkg_mgmt utility that is shippedwith IBM Operations Analytics - Log Analysis.

Procedure1. Upload the IBM MQ Insight Pack archive file, IBMMQInsightPack_<version>.zip

to the system where IBM Operations Analytics - Log Analysis is installed.2. Install or Upgrade IBM MQ InsightPack

Install command: Install IBM MQ Insight Pack by using the pkg_mgmt.sh command:<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -install <path>/IBMMQInsightPack_<version>.zipWhere:<HOME> is the directory where IBM Operations Analytics - Log Analysis is installed.Note - Before performing the upgrade please take a back of dashboard apps under <HOME>/AppFramework/Apps/IBMMQInsightPack_<version>/ if required, And restore it back once upgrade is done.Upgrade Command: Upgrade IBM MQ Insight Pack if already lower version of IBM MQ Insight Pack is installed, by using the pkg_mgmt.sh command:<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -upgrade<path>/IBMMQInsightPack_ <version>.zipWhere:<HOME> is the directory where IBM Operations Analytics - Log Analysis is installed.<path> is the path where you saved the IBMMQInsightPack_<version>.zip.

3. (Optional) If you are using the Log File Agent to load the data into IBM Operations Analytics - Log Analysis, deploy the log file agent configuration files with the following command:<HOME>/IBM/LogAnalysis/utilities/pkg_mgmt.sh -deploylfa<path>/IBMMQInsightPack_ <version>.zipWhere:<HOME> is the directory where IBM Operations Analytics - Log Analysis is installed.<path> is the path where you saved the IBMMQInsightPack_<version>.zip.

IBM MQ Insight Pack configuration artifacts

The IBM MQ Insight Pack created artifacts when it is installed.

The following artifacts are created when the IBM MQ Insight Pack is installed: WMQAMQERRSplitter , WMQFDCSplitter, WMQTRCSplitter

Splitter file set.WMQAMQERRAnnoator,WMQFDCAnnoator,WMQTRCAnnotator

Annotator file set

WMQ_AMQERR, WMQ_FDC, WMQ_TRC

Source typeWMQAMQERR_C1, WMQFDC_C1, WMQTRC_C1

Configuring the IBM MQ Insight Pack1. (Optional) To modify the default timestamp format for AMQERR files:

a. The default timestamp format supported by the source type installed withthe IBM MQ Insight Pack is MM/dd/yyyy HH:mm:ss. If the timestampformat in the AMQERR file is different, create a new source type by copyingand modifying the contents of the WMQ_AMQERR source type. To change thetimestamp format, edit the dateFormats parameter. For example:

2 IBM MQ Insight Pack

"timestamp": {"dataType": "DATE","retrievable": true,"retrieveByDefault": true,"sortable": true,"filterable": true,"searchable": true,"source": {

"paths": ["metadata.timestamp"

],"dateFormats": [

"yyyy-MM-dd HH:mm:ss.SSS"]

}},

b. Save the changes to the timestamp format.2. (Optional) To modify the default timestamp format for FDC files:

a. The default timestamp format supported by WMQ_FDC source type installedwith the IBM MQ Insight Pack is EEE MMMMM dd yyyy HH:mm:ss zzzz. If thetimestamp format in the FDC file is different, create a new source type bycopying and modifying the contents of the WMQ_FDC source type. To changethe timestamp format, edit the dateFormats parameter. For example:"timestamp": {

"dataType": "DATE","retrievable": true,"retrieveByDefault": true,"sortable": true,"filterable": true,"searchable": true,"source": {"paths": ["metadata.timestamp"

],"dateFormats": ["yyyy-MM-dd HH:mm:ss.SSS"

]}},

b. Save the changes to the timestamp format.

3. (Optional) To modify the default timestamp format for MQ Trace files:a. The default timestamp format supported by WMQ_TRC source type installed

with the IBM MQ Insight Pack is MM/dd/yy HH:mm:ss.SSS z. If the timestamp format in the trace file is different, create a new source type by copying and modifying the contents of the WMQ_TRC source type. To change the timestamp format, edit the dateFormats parameter. For example:"timestamp": {

"dataType": "DATE","retrievable": true,"retrieveByDefault": true,"sortable": true,"filterable": true,"searchable": true,"source": {"paths": ["metadata.timestamp"

],"dateFormats": ["MM/ddyy HH:mm:ss.SSS z" ]

}},

IBM MQ Insight Pack 3

b. Save the changes to the timestamp format.For information on valid timestamp formats, see https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

4. To index AMQER logs:a. Navigate to the IBM Operations Analytics - Log Analysis settings

workspace.b. Create a log source for the log file to be monitored. The source type must

be WMQ_AMQERR or the source type that is created in step 1a, if different.5. To index FDC files:

a. Navigate to the IBM Operations Analytics - Log Analysis settingsworkspace.

b. Create a log source for the log file to be monitored. The source type mustbe WMQ_FDC or the source type that is created in step 2a, if different.

6. To index MQ Trace files:a. Navigate to the IBM Operations Analytics - Log Analysis settings

workspace.b. Create a log source for the log file to be monitored. The source type must

be WMQ_TRC or the source type that is created in step 3a, if different.7. (Optional) To configure the IBM Tivoli® Monitoring Log File Agent to stream MQ

AMQERR logs to the IBM Operations Analytics - Log Analysis server, see theConfiguring IBM Tivoli Monitoring Log File Agents topic in the IBM TivoliMonitoring Log File Agent configuration scenarios section of Loading and streamingdata in the Configuring IBM Operations Analytics - Log Analysis guide.

IBM MQ Insight Pack splitter rulesSplitting describes how IBM Operations Analytics - Log Analysis separatesphysical log file records in to logical records by using a logical boundary such astime stamp or a new line.

The IBM MQ Insight Pack splits log records on timestamps. For example, in thefollowing log record the critical utility task manager has started the LOGGER-IO task.This task was run once. The ACTION is None.4/2/2015 12:52:16 - Process(8456.3) User(user1) Program(amqzmuc0.exe)

Host(HOST1) Installation(Installation5)VRMF(7.1.0.0) QMgr(QM_71)

AMQ5051: The queue manager task ’LOGGER-IO’ has started.EXPLANATION:The critical utility task manager has started the LOGGER-IO task. This task has now started 1 times.ACTION:None.

The IBM MQ Insight Pack splits FDC records on based on the timestamp.

The IBM MQ Insight Pack splits trace records on new lines. Every new line in atrace file is a new record


https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

IBM MQ Trace Limitations please consider below limitations comes with MQ trace files before start indexing.

1. The IBM MQ Insight Pack splits trace records on new lines. Every new line in a trace file is anew record

2. Each trace file comes with unique timestamp value, partial trace append / copy from onetrace to another trace is not allowed as trace line have only time value. Date and timezone values can beextracted from the header content “Date/Time” filed and appended to the each trace line along withtime.

For Example:

Date/Time :- 10/19/18 11:48:54 CST

11:48:54.244235 21658.3 : Thread type 27 (ECHealth)

Timestamp value for Trace Line : 10/19/18 11.48.54.244 CST

IBM MQ Insight Pack Annotation rules and index configurationAfter the log records are split, the logical records are sent to the annotation engine.The engine uses rules to extract important pieces of information that are sent to theindexing engine.

The IBM MQ Insight Pack annotates the log records based on the following fields:

Table 1. Field description and index configuration for WMQ_AMQERR source type

Field Description Attributes

timestamp Time that IBM MQ generatedthe log record.

dataType = DATEretrievable = trueretrieveByDefault = truesortable = truefilterable = TRUEsearchable = truesource = metadata

Process The Queue manager processgenerating the log record.

dataType = TEXTretrievable = trueretrieveByDefault = truesortable = FALSEfilterable = falsesearchable = truesource = annotations

User The Queue manager username.

dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = truesearchable = truesource = annotations

MessageID AMQXXXX logged by thequeue manager.

dataType = TEXTretrievable = trueretrieveByDefault = truesortable = truefilterable = truesearchable = truesource = annotations

MessageText The message followed byAMQXXXX in the log record.

dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

SystemName The host running the Queuemanager.


ProgName The IBM MQ internalprogram generating the logrecord



Table 1. Field description and index configuration for WMQ_AMQERR source type (continued)


Qmgr The name of the Queuemanager generating the logrecord.


VRMF The IBM MQ version dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

logRecord Entire log record dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = metadata

Table 2. Field description and index configuration for WMQ_AMQERR source type


timestamp The time in FDC.

Format: EEE MMMMM ddyyyy HH:mm:ss zzzz

dataType = DATEretrievable = trueretrieveByDefault = truesortable = truefilterable = TRUEsearchable = truesource = metadata

logRecord Entire log record. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = metadata



VRMF The IBM MQ version. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations




ProbeID The probe ID of the FDC. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = truefilterable = truesearchable = truesource = annotations

ApplicantName The name of the applicationgenerating FDC.


Component The IBM MQ componentgenerating FDC.


SCCS Source Code Control System. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

LineNumber The source code line number. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

BuildLevel The IBM MQ build level. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

User The Queue manager username.


ProcessName The process name generatingFDC.





Process The process ID generatingFDC.


Thread The IBM MQ threadgenerating FDC.


Qmgr The name of the Queuemanager generating the logrecord.


MajorErrorCode The major error codereported in FDC.


Operating System The operating systemrunning Qmgr.


MessageID AMQXXXX logged by thequeue manager.


MessageText The message followed byAMQXXXX in the log record.


Comment1 The comment from FDC. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations




Comment2 The comment from FDC. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

MQMFunctionStack The function stackgenerating FDC.


TraceHistory The trace history from FDC. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

EnvVariables The EnvVariables reported inFDC.


Table 3. Field description and index configuration for WMQ_TRC source type


timestamp The timestamp in the tracefile. The timestamp is createdby combining local date andtimezone information presentin the trace header andpresent time in the trace line.

dataType = DATEretrievable = trueretrieveByDefault = truesortable = truefilterable = truesearchable = truesource = metadata

logRecord The entire trace record. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = metadata

Qmgr The name of the Queuemanager generating the tracerecord.



Table 3. Field description and index configuration for WMQ_TRC source type (continued)




VRMF The IBM MQ version. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

Counter The counter present in eachtrace line.


ProcessName The process name generatingthe trace file.


Process The process ID generatingthe trace file.


Thread The IBM MQ threadgenerating trace.


MessageText The message in the trace file. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

FunctionName IBM MQ function. dataType = TEXTretrievable = trueretrieveByDefault = truesortable = falsefilterable = truesearchable = truesource = annotations


Table 3. Field description and index configuration for WMQ_TRC source type (continued)


RC Return code from thefunction.


Depth Depth of function call. dataType = LONGretrievable = trueretrieveByDefault = truesortable = falsefilterable = falsesearchable = truesource = annotations

Indent Indent present in the traceline.


IBM MQ Insight Pack dashboardYou can use the IBM MQ Insight Pack dashboard example app to visualize datafrom MQ logs.

Use the IBM MQ Insight Pack dashboard to find MQ-related problems in theshortest time, and drill down into the problem to identify the root cause.

The IBM MQ Insight Pack app contains the following charts:

Which are top MessageIDsPlots a pie chart of MessageIDs from the selected log records.

Which MessageID occurred the most and when?Plots a bar graph that shows how MessageIDs are distributed over aselected time frame.

Which Qmgr logged these MessageIDs?Plots a bubble chart that shows which Qmgr logged most of the MessageIDs.

Which MQ program logged these MessageIDs?Plots a bar graph that shows which MQ program logged the MessageIDs.

MQ Trace dashboardYou can use the MQ Trace dashboard to find the root cause of problems using MQTrace data.

Use the MQ Trace dashboard to use MQ Trace data to drill down into the problemto identify the root cause.

The MQ Trace dashboard.app contains the following charts:

Not OK ReturnCodeDistribution of Not OK codes returned in the trace file.


FunctionName, ReturnCodeBar graph displaying the functions that return the Not OK return codes.

timestamp,ReturnCodePlots a bubble chart that displays the Not OK return codes over time.

Qmgr, FunctionName, ReturnCodeA treemap that displays how many Not OK return codes are generated bywhich queue manager and FunctionName.

Configuring the IBM MQ Insight Pack dashboard appTo use the IBM MQ Insight Pack dashboard, you must configure the IBM MQInsight Pack dashboard app.

Procedure

To configure and customize the IBM MQ Insight Pack dashboard app, complete thefollowing steps.1. Copy the MQDash.app or MQ Trace Dashboard.app from the <HOME>/IBM/

LogAnalysis/AppFramework/Apps/IBMMQInsightPack_<version> directory to anew directory. For example MQDashboard1.app.

2. The dashboard name must be unique. To change the dashboard name, modifythe name parameter in the MQDashboard1.app.

3. The default log source that is used by the IBM MQ Insight Pack dashboard appis MQ_80. You must change the log source for each chart. To change the logsource, modify the logsources parameter. For example:"logsources":[{"type":"logSource","name":"\/MQ_80.log"}],

4. The default time interval is the last year, and the last number is 1 or 2. Tochange the time interval for each chart, modify the timefilters parameter. Forexample:"filter": {

"timefilters": {"granularity": "year","lastnum": 2,"type": "relative"

}},

The granularity can be specified as second, minute, hour, day, week, month, oryear.

5. Save the changes. Refresh the Search Dashboards panel on IBM OperationsAnalytics - Log Analysis UI to see the new dashboard.

IBM MQ Insight Pack ReferencesImportant references for your IBM MQ Insight Pack.

IBM WebSphere MQ library: http://www-01.ibm.com/software/integration/wmq/library/


http://www-01.ibm.com/software/integration/wmq/library/

SupportTo get support from the IBM support team, you can open a Problem ManagementRecord (PMR).

When you open a PMR to report an Insight Pack specific issue, the followinginformation must be included in the PMR:

Insight Pack and product informationBasic Insight Pack and product information.

Insight Pack nameThe name of the Insight Pack.

Insight Pack versionThe Insight Pack version.

Product nameThe product name.

Product versionThe version of product on which you are using the Insight Pack.

Product log file nameThe product log file name specific to the issue.

Provide details for the issue that you are reporting. For example:v Include sample log files, which are used against this insight pack.v Provide a screen capture of the error message that is generated when you use

the Insight Pack.v Describe the specific use case scenarios when the problem occurred while you

were using the Insight Pack.v Include IBM Operations Analytics - Log Analysis log files, such as

GenericReceiver.log, or UnityApplication.log, for the problem window.


ibm mq insight pack...ibm mq trace limitations please consider below limitations comes with mq trace...

Documents