TM1 Monitoring Tools

29
© 2015 IBM Corporation IBM Cognos Open Mic TM1 Monitoring Tools 13 th April, 2016

Transcript of TM1 Monitoring Tools

Page 1: TM1 Monitoring Tools

© 2015 IBM Corporation

IBM Cognos Open Mic

TM1 Monitoring Tools

13th April, 2016

Page 2: TM1 Monitoring Tools

© 2015 IBM Corporation2

IBM Cognos Open Mic Team

Gracy Mendonca – IBM Cognos Support Engineer

Presenter/Facilitator

Shashwat Dhyani – IBM Cognos Support Engineer

Technical Panel Member

Page 3: TM1 Monitoring Tools

© 2015 IBM Corporation3

Agenda

TM1 Server Monitoring using a JMeter Visualizer

TM1 Application Server Monitoring using TM1 Operations Console

Watchdog in TM1 Operations Console

How to monitor user activity on the TM1 server

WER (Windows Error Reporting)

Page 4: TM1 Monitoring Tools

© 2015 IBM Corporation4

Monitoring a TM1 Server with JMeter

JMeter is an open source Apache Java application designed to load test functional

behavior and measure performance. (Not specific to TM1)

However IBM provides a TM1 plugin that runs on JMeter and that’s how you can monitor

the TM1 server

This TM1 plugin for JMeter can be downloaded from developerworks:

http://www.ibm.com/developerworks/library/ba-pp-infrastructure-cognos_specific-page675/

JMeter can be used in 2 modes:

Dynamic – Similar to Operations Console

Helps Monitor a live running TM1 server

Static – Reading a Operations Console log files

Helps Analyze data from an existing log file

Page 5: TM1 Monitoring Tools

© 2015 IBM Corporation5

Installation:

Just a simple download of JMeter and unzip of the files to the required location is all you need as

part of installation

Pre-requisites:

Compatible version of JRE. If installed on the TM1 server it can make use of the JRE that IBM

provides for TM1. No need for an additional JRE

Launch JMeter by running the jmeter.bat

Eg. C:\apache-jmeter-2.13\bin\jmeter.bat

However since JRE is installed in one directory and JMeter in another, you need to run the .bat

file using the following method:

C:\jre\7.0\bin>C:\apache-jmeter-2.13\bin\jmeter.bat

If you get the error below inspite of having a jre installed, it means the Jre is not recognized or the

version of Java is incompatible

Not able to find Java executable or version. Please check your Java installation errorlevel=2

Press any key to continue . . …

Install and Configure JMeter with the TM1 plugin

Page 6: TM1 Monitoring Tools

© 2015 IBM Corporation6

Install and Configure JMeter with the TM1 plugin

Copy the com.ibm.cognos.jmeter.tm1.top.visualizer JAR file into the <jmeter_root>/lib/ext

directory. This will install the core components for the plug-in, including the Classic viewer.

Copy the com.ibm.cognos.tm1.api.wrapper JAR file into the <jmeter_root>/lib directory. This will

allow the plug-in to monitor server activity in real-time, and is required to run.

Copy the TM1JavaApi JAR file from the TM1 installation into the <jmeter_root>/lib directory.

This file is typically found under the <tm1_install>/bin/classes directory.

Add the Applix certificate to the Java keystore, by following the instructions found in the IBM

Technote at

http://www.ibm.com/support/docview.wss?uid=swg21414527

This is necessary for real-time monitoring.

Additional viewers can also be installed by copying their respective JAR files into the

<jmeter_root>/lib/ext directory. (More Details in the developer work article)

Analysis Viewer, Graph Viewer, Summary Viewer, Timeline Viewer

Page 7: TM1 Monitoring Tools

© 2015 IBM Corporation7

Launch Apache JMeter

From the tree, locate the node to which the listener is to be added.

Right-click on the node and from the context menu, select Add > Listener > IBM Cognos

TM1 Server Monitor Plug-in for Apache JMeter.

In the Settings tab, set the appropriate adminhost, servername, and refresh values as

you would when launching the TM1Top utility, where adminhost is the name or IP address

of the machine on which the TM1 server is running

servername is the name of the TM1 server to be monitored

refresh is the interval, in seconds, at which the polling is to take place

Install and Configure JMeter with the TM1 plugin

Page 8: TM1 Monitoring Tools

© 2015 IBM Corporation8

Install and Configure JMeter with the TM1 plugin

Page 9: TM1 Monitoring Tools

© 2015 IBM Corporation9

Install and Configure JMeter with the TM1 plugin

Dynamic Mode

Page 10: TM1 Monitoring Tools

© 2015 IBM Corporation10

Install and Configure JMeter with the TM1 plugin

For load testing of TM1 Contributor or TM1 web, you would need to write/generate test scripts

The web has demos/videos that demonstrate how the load test scripts can be generated for

Cognos TM1 testing

Note: IBM does not provide any such scripts

Page 11: TM1 Monitoring Tools

© 2015 IBM Corporation11

Static Mode

JMeter can be used to analyse a saved Log file. (.csv or .log format )

Click on the Cognos TM1 Server Monitor Plug-in and then click on browse to the log file

from the disk location

Install and Configure JMeter with the TM1 plugin

Page 12: TM1 Monitoring Tools

© 2015 IBM Corporation12

TM1 Operations Console

TM1 Operations Console replaced TM1Top in 10.2

For TM1 version 10.2.0 through 10.2.2 Fix Pack 3 (10.2.2.3), functionality that was previously

available through TM1 Top is available only through the TM1 Operations Console interface.

TM1 Operations Console also provides some additional functionality not available through

TM1 Top.

NOTE: TM1 Top is restored to IBM Cognos TM1 10.2.2.4 (10.2.2 Fix Pack 4) and later

versions.

www.ibm.com/support/docview.wss?uid=swg27046383

We would be discussing the below 2 features of Operations Console

TM1 Application Server Monitoring

Watchdog

Page 13: TM1 Monitoring Tools

© 2015 IBM Corporation13

Most common things we monitor on a TM1 server are the user activity in terms of threads and

processes running.

However it is also possible to monitor the TM1 Application server (default runs on Tomcat)

Reason for setting to false

http://www-01.ibm.com/support/docview.wss?uid=swg21653515

TM1 Ops Console : Application Server Monitoring

Page 14: TM1 Monitoring Tools

© 2015 IBM Corporation14

TM1 Ops Console : Application Server Monitoring

Memory usage on the TM1 Application Server

Page 15: TM1 Monitoring Tools

© 2015 IBM Corporation15

TM1 Ops Console : Application Server Monitoring

CPU/RAM/OS details on Application Server

Page 16: TM1 Monitoring Tools

© 2015 IBM Corporation16

TM1 Ops Console : Watchdog

Watchdog feature is to establish a set of criteria that identifies specific states in the servers

being monitored so that you can specify an action of "Kill" on the identified process or "log"

the event to a trail file.

Login to TM1 Operations Console

Click on Watchdog tab. You can see the TM1 servers added to TM1 Operations Console

and their Watchdog status showing if (Configuration Mode)

The Watchdog is setup for the TM1 server

If Setup, if the Watchdog is currently running or not

Page 17: TM1 Monitoring Tools

© 2015 IBM Corporation17

TM1 Ops Console : Watchdog

To be able to add a watchdog rule you need to first verify your access

Page 18: TM1 Monitoring Tools

© 2015 IBM Corporation18

TM1 Ops Console : Watchdog

Add a rule

Page 19: TM1 Monitoring Tools

© 2015 IBM Corporation19

TM1 Ops Console : Watchdog

Page 20: TM1 Monitoring Tools

© 2015 IBM Corporation20

TM1 Ops Console : Watchdog

Run the process to be monitored and killed on execution

Page 21: TM1 Monitoring Tools

© 2015 IBM Corporation21

TM1 Ops Console : Watchdog

When the watchdog rule criteria matched, The process will be killed by

watchdog within frequency time set and you will see the message box

confirming the same in Architect client who launched the process.

Page 22: TM1 Monitoring Tools

© 2015 IBM Corporation22

How to monitor user activity on the TM1 server

If you want to see who all have logged on through the course of the day, or last few days,

then you can enable the LOGIN Logger which will write the login and logout of all users into

TM1Server.log file

If you already have a tm1s-log.properties file, then you’d need to add this line to it.

log4j.logger.TM1.Login=DEBUG

Page 23: TM1 Monitoring Tools

© 2015 IBM Corporation23

How to monitor user activity on the TM1 server

If you want to know the current active users logged into the TM1 server, then you can do so

by checking the STATUS Value from the }ClientProperties cube.

The STATUS field is not automatically updated, so you will need to enable a background

thread to keep the STATUS field up-to-date by setting the ClientPropertiesSyncInterval

configuration parameter in tm1s.cfg file.

Page 24: TM1 Monitoring Tools

© 2015 IBM Corporation24

How to monitor user activity on the TM1 server

Housekeeper thread causes IX locks on }ClientProperties cube, leading to process looping.

message in the log :

3496 [d] DEBUG 2015-10-12 14:39:17.332 TM1.Lock.Exception Lock conflict acquiring 'IX'

lock. Thread '3172' holds 'IX' lock. Object '}ClientProperties' , type 'Cube'. Thread 3172 is

housekeeper thread.

This thread wakes up periodically to keep the STATUS field of the }ClientProperties cube

updated.

Frequent updating can cause unnecessary consumption of CPU time and may cause users

from connecting/disconnecting until operation completes.

Resolving the problem

Set ClientPropertiesSyncInterval to a higher value, or even disable it during batch periods,

when many processes are run to update data and security objects.

Example: Set ClientPropertiesSyncInterval to 1800 seconds to update cube every 30 minutes.

Since ClientPropertiesSyncInterval is a dynamic parameter in tm1s.cfg, a server restart is not

necessary : any change on that parameter is taken into account in less than one minute.

Page 25: TM1 Monitoring Tools

© 2015 IBM Corporation25

WER (Windows Error Reporting)

WER is used to capture crash dumps (generic Windows Utility, not specific to TM1 only)

No additional software needs to be installed. WER is included with Windows Server 2008 and

2012.

No process to start before the TM1 Server crash.

A user does not need to remain logged into the system running TM1.

Needs to be be done by Windows Admin as it involves changes to Windows registry

Adplus is widely used to capture TM1 capture crash dumps

Steps to configure and use Adplus can be found in the document below:

http://www-01.ibm.com/support/docview.wss?uid=swg21417409

http://www-01.ibm.com/support/docview.wss?uid=swg21686483

Page 26: TM1 Monitoring Tools

© 2015 IBM Corporation26

WER (Windows Error Reporting)

WER is configured using Windows registry settings. Please see:

https://msdn.microsoft.com/en-

us/library/windows/desktop/bb787181%28v=vs.85%29.aspx

In this example we assume a directory D:\WER has been created to capture any

crash dump files.

DumpType 2 is recommended to capture a full crash dmp file.

The new registry key is

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error

Reporting\LocalDumps\tm1sd.exe

Crash dump files may be very large. Please ensure the drive containing your

DumpFolder directory has sufficient free disk space to capture any crash dumps

files.

Page 27: TM1 Monitoring Tools

© 2015 IBM Corporation27

This screenshot provides an example of the registry keys and values required to capture

crash dumps for the tm1sd.exe process.

WER (Windows Error Reporting)

Page 28: TM1 Monitoring Tools

© 2015 IBM Corporation28

References

Ops console

http://www-01.ibm.com/support/docview.wss?uid=swg21636388

Watchdog

http://www-01.ibm.com/support/docview.wss?uid=swg21654154&aid=1

http://www.ibm.com/support/knowledgecenter/SS9RXT_10.2.2/com.ibm.swg.ba.cognos.tm1_

ops_console.10.2.2.doc/c_tm1_ops_console_emailalerts_overview.html?lang=en

http://www-01.ibm.com/support/docview.wss?uid=swg27044446

Page 29: TM1 Monitoring Tools

© 2015 IBM Corporation29