Diagnostics and Tools

App-Tier Caches

glog.webserver.cache.CacheDiagServlet

Provides statistics for application server caches including capacity, size, gets, and hit ratio.

The following fields are used:

• Cache: Name of the cache.

• Zone: Some caches are organized into groups called "Zones" in order to facilitate filtering on the Cache Diagnostic screens.

• Type: Describes the type of storage used for the cache (Tree Map, Hash Map, or LRU). LRU Caches have a property driven capacity that maintains the size of the cache using a Least Recently Used algorithm.

• Size: Number of elements currently in the cache.

• Capacity: The property driven size limit of an LRU cache.

• Timeout: Idle timeout for LRU caches which have been configured with an optional property driven timeout capability.

• Hit Ratio: Ratio of cache Hits to cache Gets. A Hit occurs if an item is already in the cache. A Hit Ratio of 1.0 is ideal.

• Swap Ratio: Ratio of cache Swaps to cache Gets. Similar to Hit Ratio, this metric shows if the Cache size is too small, resulting in too many swapped-out items. Hit Ratio shows performance from the standpoint of gets; Swap Ratio shows it from the standpoint of puts.

• Gets: Total number of items requested from the cache.

• Puts: Total number of items put into the cache.

• Synch: Provides the ability to temporarily change a cache to synchronize on gets. This option should only be used if directed to by technical support.

• Log: If Cache logging is enabled for a log, that log can receive detailed information about cache puts, gets, swaps and clears. Logging is not enabled by default for all caches. Clicking on the Log box in the diagnostic screen allows you to temporarily track activity within a particular cache.

• Clear: Removes all elements from the cache. The Clear button is suppressed for specialized protected caches, and the Clear All button likewise does not affect them.

• Expire: Forces all items in an LRU cache to timeout (doesn't apply to other caches).

• Note: This column shows the number of warnings about certain parameter settings or excessive logging. If there is a number in this column, the number is a hyperlink. Click the hyperlink to see the message; for example, "Excessive Logging" or "Potentially Excessive Runtime". The message is also a hyperlink. Click it for further details.

Note: Bulk Plan can warn about low hit ratios for certain App-Tier caches. See Bulk Plan Caches.

Cache Clear Utility

glog.webserver.servlet.cacheclear.CacheClearServlet

Clears all caches in the "Business" Zone.

Entity Bean Caches

glog.webserver.beancache.BeanCacheServlet

Provides statistics for Entity Bean caches including capacity, size, gets, and hit ratio.

The following fields are used on this page:

Bean: Name of the Bean in the cache.

Count: Number of elements currently in the cache.

Capacity: Property driven size limit of the cache.

Hit Ratio: Ratio of cache Hits to cache Gets. A Hit occurs if an item is already in the cache. A Hit Ratio of 1.0 is ideal.

Gets: Total number of items requested from the cache.

Misses: Total number of Gets where the item was not already in the cache.

Unload: Removes all elements from the cache.

Verify: This checks each bean data in the entity cache against the value in the database and reports on inconsistencies

The following items are captured directly from WebLogic MBean Statistics. Consult WebLogic documentation for more details.

Locks: Weblogic MBean LockEntriesCurrentCount

Waiters:  Weblogic MBean WaiterCurrentCount

Timeouts: Weblogic MBean TimeoutTotalCount

Lock Ratio: Weblogic MBean

LockManagerAccessCount-TimeoutTotalCount)/LockManagerAccessCount

Web-Tier Caches

glog.webserver.cache.WebCacheDiagServlet

This utility was designed to be used in conjunction with Tech Support.

Provides statistics for web server caches including capacity, size, gets, and hit ratio.

The Remove button forces all items out of the cache. Remove is typically used when some update to data has occurred without notifying OTM (eg direct SQL update to data tables).

The Expire button removes "old" items out of the cache where "old" is defined by the expiration date. It would be used to release unneeded memory.

Properties are available that determine when an item can be expired from the cache. They are given by:

    glog.cache.<Cache Name>.timeout=<timeout in seconds>

Note that this only applies to LRU (Least Recently Used) caches and, by default, all LRU caches have an infinite timeout. Most cache capacities are small so the LRU swapping is sufficient to limit excessive memory use. The only use case where a timeout would be useful is one where the items in the cache can be very large, or the capacity of a cache is sized for an abnormal use case. In either of these cases, expiring items in the cache after a period of disuse can free up needed memory.

The Clear button clears all items from the cache.

App-Tier Properties

glog.webserver.properties.PropertiesServlet

Provides the ability to create, view, and modify business component properties. Changes are not persisted to the glog.properties file. For more information see Property Screen.

Data Connections

glog.webserver.datasource.CPDiagServlet

Provides statistics on Connection Pool usage, including number of connections, failures, and waits.

Web-Tier Properties

glog.webserver.properties.WebPropertiesServlet

Provides the ability to create, view, and modify UI component properties. Changes are not persisted to the glog.properties file. For more information see Property Screen.

Lets you invoke an analyzer report and either view it on the screen, or export it as an HTML file. If you do not select the Display check box, then you are prompted to save the report as an HTML file. Control the timeout for the analyzer report by using the glog.diag.analyzer.timeout property.

A standard Oracle database report.

The report contains Snapshot Information and SQL Statistics.

The report requires a Start Time and End Time. The Start and End times define the enclosing database snapshots used for the report. If the system cannot find at least two snapshots within the start and end times, the report cannot be produced. The generated report will be for all of the RAC nodes of the database. If the Display option is selected, then the report for each of the RAC nodes will be shown in different frames. If the Display option is not selected, you will be prompted to download a zip file which will contain individual reports for each of the RAC nodes.

The AWR report can be displayed as HTML or text. If HTML, hyperlinks are available in the Full SQL Summary to link to AWR SQL details. For text, the SQL ID from the text report can be copied into the inputs for the AWR SQL report, which is available on the Database sub-menu.

Database Connections Diagnosis

Output for open and orphaned connections coming from the leak detector. This only permits full stack traces if the user has access to the Stack Trace - View ACL.

This is not accessible to Cloud users.

Event Queues

glog.webserver.event.EventDiagServlet

Provides statistics for Workflow Event processing, including current activity, processing time, and wait time.

The following columns and fields appear on the Event Queues page:

• Time: Date and time the collection was captured.
• Backlog: Number of events waiting to run on a thread in that group.  This indicates a backup, which may or may not be a problem.  Sometimes a backlog is just the system throttling a flood of work and preventing it from overwhelming the system.
• Current Thread Count: Number of threads for the queue
• Initial Thread Count: Number of threads for the queue at startup.  This can indicate if thread counts were changed while the system was running.
• Longest Event: Information about the longest running event on that queue.  The Maximum Process Time tells you how long this event took to run
• Process Time: Average and maximum time that events took to process on the queue.  Count is the number of events that processed on that queue (which should correlate to Throughput).  Understanding whether or not a time is too long is relative to the work.  For example, batch and report queues may have longer times, while lifetime and txComplete should be relatively quick.
• Queue Size: Average and Maximum number of events backlogged.  A high backlog may indicate events are processing too slowly, or it may indicate the queue is simply undersized.  Increasing the queue is not always the correct solution to a backlog.
• Threads: Indicates what is running at that time.  This is very useful to indicate if all threads are being utilized.  If the capture is taken at the correct time, the event running on the thread, in conjunction with comparing "Since" to the "Time" of the collection, it is possible to see which events may be running more slowly than others.
• Throughput: Number of events that processed on threads for that queue.
• Wait Time: Amount of time events waited to get a thread.  A high wait time does not necessarily indicate the queue is undersized.  If the Process Time is high, it will indicate that events are processing too slowly.
• Last Reset Time: Date and time stats were last reset.  This is important to take into account average times, longest times, and throughput.  On the actual Event Queues screen (as opposed to the collector) there is a Reset button at the bottom of the screen.  Restarts, as well as clicking this button will reset statistics.  It is useful to reset statistics after making a change so problems prior to the change do not skew the statistics.
   

Mediator

glog.webserver.mediator.MediatorDiagServlet

Provides statistics on the Mediator, which is used for Object Lock Management and Process Synchronization.

Object Locks

glog.webserver.synch.object.ObjectLockDiagServlet

Provides statistics for Object Locks, including current activity, waiters, and timeouts.

Open Processes

glog.webserver.process.walker.ProcessWalkerDiagServlet

Provides visibility to all currently open processes (running or waiting to execute).

The Release and Roll-up buttons should only be used when directed to by Support.

Release recurses up the process tree, placing each process in a Released state. Any resources acquired by each process are released. This means that object locks are released but the process is not closed. As the process finishes for real, it moves from released to closed state.

Rollup truly closes the process. If a process is truly orphaned (i.e. it's no longer running but the process object was not closed), you would need to rollup the process to free memory and get the process off of the screen. If the process is still running, you will get a state exception when it tries to close for real.

Oracle Queue Setup

glog.webserver.queue.QueueMgmtServlet

Provides Oracle Advanced Queuing Management capabilities.

Process Control

glog.webserver.processcontrol.ProcessServlet

Provides the ability to schedule recurring processes.

Threads

glog.webserver.thread.ThreadDiagServlet

Allows the monitoring and stopping of threads. Affected by glog.threadLocal.allowCrossThreadLookup. and glog.threadMonitor Properties. A monitored (non-workflow) thread maintains the last time it performed its primary task. This can be viewed on the Threads diagnostic screen.

The Last Active column gives duration, in seconds, since the thread last handled worked. If a thread is stuck, it will increase without bound.

Monitored threads support requests to manually stop the thread and spin up a new thread to handle the work. The stop button on the Thread diagnostic screen asks the specified thread to exit once it's able and starts a new thread to take it's place. The thread names have an index to track original versus replaced threads.

An optional poller can watch all monitored threads to see if the thread is stuck and should be automatically stopped and replaced. This poller is off by default but can be enabled by setting glog.threadMonitor.polling.

To set the stuck timeout for any individual thread, use the glog.threadMonitor.timeout.<thread name> property.

Topic Assignment

glog.webserver.event.TopicQueueAssignmentsServlet

Provides a view of the workflow topics associated with each workflow queue.

Domain Export

glog.integration.servlet.ExportDomainServlet

Provides the ability to export a domain to CSV files.

External System

glog.integration.servlet.ExternalSystemServlet

ExternalSystemServlet acts as a dummy HTTP URL for use in External System HTTP configuration.

The servlet is mostly used to investigate the XML content which is sent out of the OTM/GTM application for particular events.

The servlet can:

- forward the content as the body of an email

- save as a file on the filesystem of the web server

- transfer over FTP to an FTP server

- create a MessageCenterTopic.

Inbound Messages

glog.webserver.integration.InboundPerfServlet

Provides statistical data on Inbound Integration activity.

Outbound Messages

glog.webserver.integration.OutboundPerfServlet

Provides statistical data on outbound Integration activity.

Send Integration

glog.webserver.sendintegration.SendIntegrationServlet

Provides the ability to perform the Send Integration command on an arbitrary set of data.

Active Problems

glog.webserver.optimization.MonitoredSolverDiagServlet

Provides statistics for FICO Xpress-Optimizer (Dash) optimization engine executions.

Problem Tester

glog.webserver.optimization.test.SolverDiagServlet

Provides an ability to test the FICO Xpress-Optimizer (Dash) optimization engine.

App-Tier Instrumentation

glog.webserver.instrumentation.InstrumentationServlet

Provides visibility to application tier cache profiling results. This screen should only be used when directed to by Support.

App-Tier Profiling

glog.webserver.instrumentation.ProfileServlet

Provides visibility to application tier performance profiling results. This screen should only be used when directed to by Support.

App-Tier Session Calls

glog.webserver.sessionperf.SessionPerfServlet

Provides visibility to application tier performance profiling results for session bean calls. This screen should only be used when directed to by Support.

Web-Tier Instrumentation

glog.webserver.instrumentation.WebInstrumentationServlet

Provides visibility to web server tier cache profiling results.  This screen should only be used when directed to by Support.

Web-Tier Profiling

glog.webserver.instrumentation.WebProfileServlet

Provides visibility to web server tier performance profiling results. This screen should only be used when directed to by Support.

Web-Tier Queries

glog.webserver.query.QueryDiagServlet

Provides visibility to web tier query performance profiling results for session bean calls. This screen should only be used when directed to by Support.

Report Diagnostic

glog.webserver.report.ReportDiagServlet

Provides statistics on the number of reports generated, size of the reports, and the time spent generating the reports.

Web Report Diagnostic

glog.webserver.report.WebReportDiagServlet

Provides the same statistics as Report Diagnostics, but for Reports which were generated on the web tier.

Clear Scalability Caches

glog.webserver.appserver.RecheckScalabilityCaches

Forces each server to reestablish communication with any other servers it thought were down. This action is available only to users with the Administration role.

Cluster Balance

glog.webserver.sca.RouteTrackingServlet

This cluster balance provides a web server tracking routing summary, and can also be used to make sure that the weight balancing is correct between the application servers.

JMS Messages

glog.webserver.message.MessageDiagServlet

Provides statistics on JMS Message communication.

Scalable Topics

glog.webserver.processcontrol.RemoteTopicDiagServlet

Provides diagnostic information for Remote Topics, an advanced capability within OTM Scalability.

Log Viewer

glog.webserver.logview.LogViewerServlet

Provides the ability to query and view OTM logging, including Diagnostics, across all servers.

SQL Execution Interface

glog.webserver.sql.SqlServlet

Provides a SQL client interface for testing SQL statements.

The Security Context supports specification of a user role GID. It is only visible when the Show Execution Plan check box is selected. When you are running an Execution Plan, you can specify to run the execution plan of the query with this specific user role. This could help you better understand the performance of your query in the VPD context of the role specified. Use the format: < user role GID >.

You can query an Analytics database from an SQL Execution Servlet. Select OTM/GTM or Analytics from the Target Database field before running a query. You can query GLOGOWNER, REPORTOWNER and HDOWNER tables.

Producer Diagnostic

glog.webserver.session.ProducerDiagServlet

Provides statistics on the size of the XML being generated for the User Interface.

Servlet Diagnostic

glog.webserver.session.ServletDiagServlet

Provides statistics on servlet executions including number of times accessed, average response time, and longest and shortest.

Session Diagnostic

glog.webserver.session.SessionDiagServlet

Provide statistics on the Tomcat sessions, including the number of active, expired, and rejected sessions.

User Queries

glog.webserver.query.QueryDiagServlet

Diagnoses UI query performance. This screen displays identification and summary statistics for each group of queries.

Batch CSV Upload

glog.integration.servlet.BatchCSVUtilServlet

Provides the ability to upload a set of CSV files.

CSV Export

glog.integration.servlet.CSVUtilServlet

Performs the Export action of the CSV Export Utility.

Direct Integration Loading

glog.integration.servlet.DirLoadServlet

DirLoadServlet provides a faster option than WMServlet for loading data into Oracle Transportation Management by bypassing the application server. It can be used for inserting/creating data.

Export and Import DB XML data

glog.integration.servlet.DBXMLServlet

Exports and imports DB XML data remotely from the OTM application. See the Data Management Guide on the Oracle Help Center for more details.

Inbound Integration Servlet

glog.integration.servlet.WMServlet

WMServlet is the default servlet used for processing Inbound Integration. Refer to the WMServlet section of the Integration Guide on the Oracle Help Center for more details.

XSL Transformation for Inbound Integration

glog.integration.servlet.TransformerServlet

TransformerServlet is used to apply an XSL transformation to an XML to convert it into a valid Transmission XML.

Diagnostic Entity View

glog.webserver.logview.DiagEntityViewServlet

Entity View screen for Bulk Plan Diagnostics.

Diagnostics Viewer Filter

glog.webserver.logview.DiagnosticFilterServlet

In Diagnostic log viewer, there is a Filter button. When you click this button, it opens a popup window using this servlet. From there you can filter the Diagnostic viewer contents by Process Name ID, Entities, Status, etc..

Load On Startup Servlet

glog.webserver.util.startup.LoadOnStartServlet

Provides a mechanism to force startup initialization on the web-tier. OTM registers this servlet in web.xml to load on startup.

Mail File Retrieval

glog.webserver.mail.MailFileServlet

Provides external access to Mail Files that exceed a configurable maximum message size. If the message exceeds the maximum, OTM adds the message to an app-tier file cache and send the recipient a link to it. The link hits this servlet which pulls the cached file off the app server.

Remote Report View

glog.webserver.report.ViewReportLogServlet

Provides the ability to view a report which was sent out as a URL in an email.

Signed Servlet Router

glog.webserver.util.SignedServletRouter

Handles all signed servlet requests from app to web. A signed servlet is not really a servlet but a signed and sealed object sent to SIgnedServletRouter. The router validates and decrypts the contents, then routes the request to the corresponding web-side code. This servlet is only accessible from the app server. 

Test Servlet

glog.webserver.test.TestServlet

This servlet can be used to test if a web server is responsive. It does not require login. Responds with OK.

Tier Check

glog.webserver.test.TestTierServlet

Checks to see that all three tiers (web, app and database) are up and running.

- the web is up if the servlet is reached

 - the app is up if a call to SqlSession bean does not fail

- the db is up if a select from dual statement succeed

If all three tiers are up, the servlet returns 1 as plain text. Otherwise it returns 0 as plain text.