30 Troubleshooting Using System Tools

A wide range of diagnostic tools is available for you on the System Tools node under the Admin node of the General Admin tree. With these diagnostic tools, you can configure log4j loggers, access various types of system information, manage caches, and test the performance of the shared file system.

Topics:

30.1 Using the Configure Log ODL Tool

By default WebCenter Sites is set up to use the Oracle Diagnostic Logging (ODL) system. The Configure Log ODL tool enables you to view current logger levels, change logger levels, and add new loggers directly from the Admin interface. In addition, since changes to logger levels and added loggers remain in effect only until WebCenter Sites is restarted, you can retain your changes by manually adding new loggers to the logging-config.xml file.

The following topics provide information about using the Configure Log ODL tool in the Admin interface:

30.1.1 Viewing Loggers

You can view a list of WebCenter Sites loggers and their verbosity levels. The list includes the following:

  • Loggers that are registered in the logging-config.xml file, in the <sites-shared>/config directory. The file is read only on system startup. If, during runtime, you make changes to the logging-config.xml file and save them, your changes are not displayed in the Log ODL Configuration form. They are applied and displayed when WebCenter Sites is restarted.

  • Loggers that are detected during runtime. The loggers are detected when:

    • System features or add-on components are accessed for the first time.

    • The loggers are added to the system manually by developers using the Add Logger feature, as shown in Adding New Loggers.

The collapsed view of the list shows the root logger and parent loggers, all of which are explicitly assigned verbosity levels. If you require a more granular view, you can expand the list to also show loggers that inherit levels from the root logger or parent loggers.

To view loggers:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click Configure Log ODL.

    The list of loggers with explicitly assigned levels is shown in the following figure.

    Figure 30-1 Log ODL Configuration Form

    Description of Figure 30-1 follows
    Description of "Figure 30-1 Log ODL Configuration Form"
  2. To expand the list to include loggers that inherit levels, click Show All Known Loggers at the bottom of the form.

    Loggers that inherit levels are listed below their parent loggers.

  3. To view only loggers with explicitly assigned levels again, click Show Configured Loggers at the bottom of the form.

30.1.2 Changing Logger Levels

You can temporarily change logger levels to define the type and number of statements that get written to the WebCenter Sites log specified in the logging-config.xml file. Your changes are applied right away; as soon as the loggers are executed, you can track the impact of their new levels in the log. The new levels remain in effect only until WebCenter Sites is restarted, but if you wish to retain the changes, you can change the logger value manually in the logging-config.xml file, in the <sites-shared>/config directory on your application server.

This option is particularly

Note:

Log4j log levels set by users cannot be migrated to ODL logs. Users must set these levels manually after the upgrade.
useful when you want to temporarily override inherited logger levels. For example, if a parent logger is set to a high-verbosity level such as TRACE:16 and you want to prevent one of its child loggers from inheriting that level, you can assign the child logger a different level.

The following logger levels are available, listed in order of decreasing verbosity:

ERROR:1, WARNING:1, NOTIFICATION:1, TRACE:16, TRACE:1, OFF

OFF indicates that a logger does not write any statements to the log. For more information about logger levels, see the Oracle Diagnostic Logging (ODL) documentation.

To change a logger level:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click Configure Log ODL.

    The list of loggers with explicitly assigned levels opens. If you require a more granular view, you can click Show All Known Loggers at the bottom of the form to expand the list to include loggers that inherit levels from parent loggers.

  2. Find the logger to change and select a new logger level in the Set New Level column.

    The new level opens in the Level column.

    When the logger is executed, you can track the impact of the new level in the log. See Viewing the Log.

  3. If you want the new logger level to remain in effect after WebCenter Sites is restarted, you must manually change the logger level in the logging-config.xml file. For instructions, see Changing Logger Levels in Property Files Reference for Oracle WebCenter Sites.

30.1.3 Adding New Loggers

If you wish to add new loggers to the ODL framework in your WebCenter Sites system and you do not want them to inherit verbosity levels from the root logger or parent logger, you can add the loggers through the Admin interface and assign each of them a verbosity level. (If you add your own custom loggers, be sure to deploy the supporting class and jar files.)

Assigned verbosity levels remain in effect only until WebCenter Sites is restarted, but if you wish to apply the levels permanently, you can manually add the logger properties to the logging-config.xml file in the <sites-shared>/config directory on your application server.

To add a new logger:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click Configure Log ODL.

    The list of loggers with explicitly assigned levels is shown.

  2. In the field below the list of loggers, enter the name of the logger you want to add and select its verbosity level.

  3. Click Add Logger.

    The new logger is added to the list. As soon as the logger is executed, you can track the impact of the assigned level in the log (see Viewing the Log).

  4. If you want the added logger to remain in effect after WebCenter Sites is restarted, add the logger to the logging-config.xml file. For instructions, see Adding Loggers in Property Files Reference for Oracle WebCenter Sites.

30.2 Using the System Information Tool

The System Information tool provides immediate access to various types of WebCenter Sites, database, and thread information for troubleshooting and checking the health of your application. You can download information to a file or view information directly in the administrator's interface.

This section covers the following topics:

  • Viewing WebCenter Sites Information

  • Viewing Database Information

  • Viewing Thread Information

    Note:

    You can download all available system information and a list of all WebCenter Sites directories and files on the application server by right-clicking the System Information tool and selecting Download. If Sigar is configured, you can also download Sigar information to send to Technical Support by right-clicking the tool and selecting System Details (Sigar).

30.2.1 Viewing WebCenter Sites Information

You can download or view the following types of WebCenter Sites information:

  • Memory Information – The amount of free memory in the application server Java Virtual Machine, the total amount of memory free and in use, and the maximum amount of memory that the Java Virtual Machine will attempt to use.

  • Sites Properties – The ini, xml, and properties files in the WebCenter Sites installation directory.

  • Web Apps Properties – The xml and properties files in the WEB-INF and WEB-INF/classes directories on the application server.

  • Other Sites Info – The jar files in the WEB-INF/lib directory on the application server, the session variables for the user currently logged in to WebCenter Sites, and the Java run-time properties.

To download or view WebCenter Sites information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, then expand the System Information node, and then double-click Sites Info.

    The WebCenter Sites Information form is shown.

    This form shows memory information and additional information that you can select to download or view.

  2. In the Sites Properties and Web Apps Properties sections, select the files that you are interested in and click Add.

  3. In the Other Sites Info section, do the following:

    • To obtain information about the jar files in the WEB-INF/lib directory on the application server, select the Jar Versions check box.

    • To obtain the session variables for the user currently logged in to WebCenter Sites, select the Sites Session Variables check box.

    • To obtain Java run-time properties, select the System Variables check box.

  4. To download the selected WebCenter Sites information as a text file, click Download and then open or save SysInfo.zip. The text file is inside SysInfo.zip.

  5. To view the selected WebCenter Sites information in the administrator's interface, click Show Results.

    1. The selected files and information are displayed directly in the administrator's interface.

    2. To view the details of a file or type of information, click its "plus" icon.

      For ini and properties files, and WebCenter Sites session variables and system variables, the properties and values are shown in the following figure.

      Figure 30-2 Properties and Values for cas.properties

      Description of Figure 30-2 follows
      Description of "Figure 30-2 Properties and Values for cas.properties"

      For xml files, the code is shown in the following figure.

      Figure 30-3 XML File Code Display

      Description of Figure 30-3 follows
      Description of "Figure 30-3 XML File Code Display"

      For Jar Versions, the jar names, versions, and implementation vendors are shown in the following figure.

      Figure 30-4 Jar Versions and Vendors

      Description of Figure 30-4 follows
      Description of "Figure 30-4 Jar Versions and Vendors"

      NA : NA indicates that a jar file does not provide its version and vendor.

30.2.2 Viewing Database Information

You can download or view the following types of database information:

  • Basic Information – The database engine and version, default transaction isolation level, JDBC driver, URL, and version, and JNDI data source.

  • System Tables – Tables that store core WebCenter Sites data. The ElementCatalog table, for example, lists all of the XML or JSP elements used in your system.

  • Tree Tables – Tables that store parent-child relationships between objects. The AssetRelationTree, for example, stores information about the associations between assets.

  • Sites Object Tables – Tables that store uniquely identified objects, such as asset types, asset attributes, and asset definitions.

  • Other Sites Tables – Tables that store flat data that cannot be organized into parent-child relationships and the foreign tables that WebCenter Sites does not manage.

    Note:

    You have permission to access a database table if at least one Access Control List (ACL) assigned to the table is assigned to your user. See Access Control Lists (ACLs) and Types of Database Tables in Developing with Oracle WebCenter Sites.

To download or view database information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the System Information, and then double-click DB Info.

    The Database Information form is displayed with basic information about your database and the tables that you can select to download or view.

  2. In the System Tables, Tree Tables, Sites Object Tables, and Other Sites Tables sections, select the tables to view and click Add.

  3. To download the selected database information as a spreadsheet file, click Download and then open or save SysInfo.zip. The spreadsheet file is inside SysInfo.zip.

  4. To view the selected database information in the administrator's interface, click Show Results.

    1. For each selected table that you have permission to access, the following information opens:

      • Table Name

      • Primary key

      • Number of rows

      • CSz (number of resultsets to cache in memory)

      • Timeout (number of minutes to keep a resultset cached in memory)

      • Abs (how to calculate the expiration time for resultsets)

      • Time to run SQL

      • Special table key

    2. To view a table's column and indices, click its "plus" icon. If an index is listed more than one time, it extends across multiple rows, as illustrated in the following figure.

      Figure 30-5 Tree Tables Information

      Description of Figure 30-5 follows
      Description of "Figure 30-5 Tree Tables Information"

30.2.3 Viewing Thread Information

You can download or view thread dumps to analyze the runtime state of the application server. This can be especially useful when trying to detect problems that could result in resource starvation or thread hangs.

To download or view thread information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the System Information node, and then double-click Thread Info.

    The Thread Information form is shown.

  2. The Regular Expression check box is selected by default. This option enables you to use Java regular expressions to search for thread names.

    Examples:

    • Thread.* to find Thread-0, Thread-1, and Thread-3

    • .*thread.* to find pool-6-thread-1, pool-8-thread-1, and pool-14-thread-2

    If you deselect the check box, you must search for exact thread names.

  3. In the Thread Name field, enter the thread name or text string to search for.
  4. To limit your search to one or more thread states, select the state(s) in the States field. If you do not select a state, all states are searched.
  5. To download the selected thread information as a text file for use with a thread dump analyzer, click Download and then open or save SysInfo.zip. The text file is inside SysInfo.zip.

    Note:

    Downloading thread information is possible only in the following cases:

    • JDK includes a compatible jstack utility.

    • The first JDK listed in your operating system's library path includes a jstack utility that is compatible with JDK.

    If a compatible jstack is not found, the following message is shown: "Thread dump feature is not supported for this platform."

  6. To view the selected thread information in the administrator's interface, click Show Results.

    For each thread matching the search, the following information opens:

    • Name

    • ID

    • State

    • Total time the CPU executed the thread

    • Total time the thread was in user mode

    • Number of times it was blocked and waited

    • How long it was blocked and waited

    • Object for which it is waiting

    • Stack trace

30.3 About Using the Cache Management Tool

If the inCache framework is set up for page caching, asset caching, or both, the Cache Management tool enables you to monitor the caching processes on cluster members and their co-resident Satellite Servers. Features include cache searching, force writing to disk, and flushing individual pages, assets, dependencies, and entire caches.

Note:

The Cache Management tool provides caching information only for cluster members and their co-resident Satellite Servers. To access cache information for remote Satellite Servers, use the following URL:

http://<server>:<port>/<application_context_path>/Inventory?username=<SatelliteServer>&password=<password>&detail=debug

30.4 Working with Cache Management - CAS Cache

This section shows you cache management for CAS Cache.

This section includes the following topics:

30.4.1 Overview of the CAS Cache Summary Form

The CAS Cache Summary form lists the following basic data for each cache (values are estimates):

  • Total Count (total number of cached elements)

  • Memory Store Count (number of cached elements in memory)

  • Disk Store Count (number of cached elements on disk)

  • Cache Hits (number of cached elements retrieved from both memory and disk)

  • In Memory Hits (number of cached elements retrieved from memory)

  • On Disk Hits (number of cached elements retrieved from disk)

  • Cache Misses (number of times elements were not found in the cache)

  • Eviction Count (number of elements evicted from the cache)

  • Average Get Time (average number of milliseconds for retrieving an element)

  • Max Elements In Memory (maximum number of elements allowed in memory)

  • Max Elements On Disk (maximum number of elements allowed on disk)

  • Overflow to Disk (whether elements are written to disk when memory is full)

This form also provides the following options. They should be used with caution, especially on a delivery system, as they can impact the performance of your site.

  • Writing a cache's entire memory store to disk. This option can be particularly useful if is not set up to automatically write a cache's memory store to disk before shutting down.

  • Flushing a cache's entire memory and disk stores.

Note:

If legacy page caching is enabled, cached page data is stored in the SystemPageCache table and information about the stored data is not displayed in the Summary window.

To view and work with summary cache information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the CAS Cache node, and then double-click Summary.

    The Summary page is shown in the following figure.

  2. Select the check box for the Ticket Cache or the Session Cache (or both) and click Write To Disk to write the selected cache's entire memory store to disk.
  3. Select the check box for the Ticket Cache or the Session Cache (or both) and click Flush Cache to flush the memory and disk stores for the selected caches.

30.4.2 Working with Cluster Information

If Sigar is configured, this form lists the name, URL, port, and GUID of each additional WebCenter Sites cluster member.

To view and work with cluster information:

  1. In the General Admin tree, expand the Admin, and then expand the System Tools node.
  2. Under the System Tools node, expand the Cache Management node, expand the CAS Cache node, and then double-click Cluster Info.

The Cluster Info page is shown in the following figure.

30.5 Working with Cache Management - Resultset Cache

Oracle WebCenter Sites caches resultsets to help optimize system performance. Caching prevents overloading the database with repeated queries for the same information, and serving from cache is always faster than performing another database lookup.

By default, WebCenter Sites stores resultsets within the inCache framework, instead of hash tables. Both caching frameworks use Java memory. You can switch between frameworks by using the Property Management Tool in the Admin interface to set the rsCacheOverInCache property (in wcs_properties.json) to either true or false.

When resultset caching over inCache is enabled, the System Tools node shows the Resultset Cache tool, which provides statistical information about the caches and their contents as described in this section. Additional information about resultset caching is available in Working with Resultset Caching and Queries in the Developing with Oracle WebCenter Sites.

This section covers the following topics:

30.5.1 Enabling and Configuring Resultset Caching over inCache

If resultset caching over inCache is not enabled, caching in hash tables is enabled by default.

To enable and configure resultset caching:

  1. Enable resultset caching:

    1. Make sure the linked-cache.xml configuration file is present in the application server's classpath (WEB-INF/classes directory).

    2. In the Admin interface, access the Property Management Tool, find the rsCacheOverInCache property, and set its value to true. (For instructions about using the Property Management Tool to modify properties, see Properties in the Cache Category in Property Files Reference for Oracle WebCenter Sites.

  2. Configure resultset caching:

    In the Property Management Tool, set values for the following resultset caching properties:

    • cc.cacheResults – Specify the default number of resultsets to cache.

    • cc.cacheResultsTimeout – Specify the number of minutes to keep a resultset cached.

    • cc.cacheResultsAbs – Specify how expiration time is calculated for cached resultsets.

30.5.2 Summary View

The summary view of resultset cache shows statistical information about all caches. You can select a cache from the summary table to view the database queries it contains. You can further view the resultset elements of the database queries contained in a cache.

To view cache information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Resultset Cache node, and then double-click Summary.

    The Resultset Cache Over InCache form is shown.

  2. Click a buttons, located above the summary table:
    • Refresh refreshes the results of the summary table.

    • Filter (caches) narrows down the results shown in the summary table to only selected caches.

    • Clear clears selected caches.

    • Invalidate invalidates selected caches. All invalidated resultset elements are purged by the cleaning thread, which runs periodically.

      Each resultset element contains a list of tables on which it depends. When an invalidated resultset element is requested, it is read from the database and reloaded into cache.

    The following figure shows how each column value is calculated.

    Table 30-1 Descriptions of Columns in the Summary Table

    Column Name Description

    Cache

    Name of the cache.

    Count

    Number of resultset elements in the cache. A resultset element is a key-value pair, where the key is the query and the value is the result returned by the query.

    MaxCount

    Capacity of the cache (maximum number of resultset elements allowed in the cache).

    Fill Ratio

    Percentage of cache filled: (Count / MaxCount) x 100

    Hits

    Total number of times all resultset elements were read from the cache.

    Misses

    Number of times the resultset element was not found in cache.

    Hit ratio

    Percentage of hits: [Hits / (Hits + Misses)] x 100

    Misses Exp

    Number of misses due to resultset elements that are expired but not removed.

    Get time

    Average time (in ms) for get operations.

    Puts

    Number of times resultset elements were placed in the cache following a database query.

    Updates

    Number of times individual resultset elements in the cache have been updated.

    Expired

    Number of expired resultset elements. They are removed by a cleaning thread that runs periodically in the background.

    Removed

    Number of resultset elements removed for any reason (such as a manual clear operation or cleaning thread).

    Evicted

    Number of evicted resultset elements. Eviction occurs when the capacity of the cache is exceeded.

    Eternal

    Indicates whether all resultset elements in the cache have infinite expiration time.

    TTL

    Time to live. Length of time (in seconds) that resultset elements will remain in cache.

    TTI

    Time to idle. If a resultset element is not hit (read from cache) within this time period, it is marked as idle.

  3. To view detailed information about the contents of a cache, click the cache name in the summary table.

    The detail view opens to show the keys (queries), their related statistics, and a search field for locating the cache's content by key, expiration time, and dependency (in the following figure.).

    Figure 30-8 Detail View for Cache Contents

    Description of Figure 30-8 follows
    Description of "Figure 30-8 Detail View for Cache Contents"

    To refresh your form, click Search.

    The following table describes the columns in the Cache Detail.

    Table 30-2 Descriptions of Columns in the Cache Detail Table

    Column Name Description

    Key

    Key (query) for the resultset element.

    Dependencies

    List of tables against which the query was run.

    Created time

    When this resultset element was placed in the cache.

    Last accessed time

    When this cached resultset element was last accessed.

    Expired time

    When this resultset element will expire.

  4. To view the resultset element for a key, click the key (query).

    A ResultSet form is shown.

    Columns in the table that opens are dynamic and depend on your site's data model and how the query is set up.

30.5.3 Viewing Cluster Information

If Sigar is configured, the Cluster Info form lists the name, URL, port, and GUID of each additional cluster member.

To view and work with cluster information:

  1. In the General Admin tree, expand the Admin node, expand System Tools, select Cache Management, expand Resultset Cache, and then double-click Cluster Info.

    The Cluster Info form is shown (in the following figure.).

30.6 Working with Cache Management - Sites Cache

The following topics provide information about cache management for Sites Cache:

30.6.1 Overview of the Sites Cache Summary Form

The Sites Cache Summary form lists the following basic data for each cache (values are estimates):

  • Total Count (total number of cached elements)

  • Memory Store Count (number of cached elements in memory)

  • Disk Store Count (number of cached elements on disk)

  • Cache Hits (number of cached elements retrieved from both memory and disk)

  • In Memory Hits (number of cached elements retrieved from memory)

  • On Disk Hits (number of cached elements retrieved from disk)

  • Cache Misses (number of times elements were not found in the cache)

  • Eviction Count (number of elements evicted from the cache)

  • Average Get Time (average number of milliseconds for retrieving an element)

  • Max Elements In Memory (maximum number of elements allowed in memory)

  • Max Elements On Disk (maximum number of elements allowed on disk)

  • Overflow to Disk (whether elements are written to disk when memory is full)

This form also provides the following options. They should be used with caution, especially on a delivery system, as they can impact the performance of your site.

  • Writing a cache's entire memory store to disk. This option can be particularly useful if WebCenter Sites is not set up to automatically write a cache's memory store to disk before shutting down.

  • Flushing a cache's entire memory and disk stores

Note:

If legacy page caching is enabled, cached page data is stored in the SystemPageCache table and information about the stored data is not displayed in the Summary window. This window also shows the Clear Page Cache button, which allows you to flush the stored data in System Page Cache and Co-Res SS Cache.

As System Page Cache is legacy, it must be enabled for use. This is done by disabling Ehcache by including the following as a JVM parameter of appserver:

-Dcs.useEhcache=false

To view and work with summary cache information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Sites Cache node, and then double-click Summary.

    The Summary form is shown (in the following figure).

    Figure 30-10 Sites Cache Summary

    Description of Figure 30-10 follows
    Description of "Figure 30-10 Sites Cache Summary"
  2. Select the check box for the PageCache, Cache Dependencies, Asset Cache, or URL Cache and click Write To Disk to write the selected cache's entire memory store to disk.
  3. Select the check box for the PageCache, Cache Dependencies, Asset Cache, or URL Cache and click Flush Cache to flush the memory and disk stores for the selected caches.

If you have enabled System Page Caching, a button labeled Clear Page Cache will appear underneath the Flush Cache button. Click Clear Page Cache to flush the SystemPageCache table and Co-Res SS Cache.

30.6.2 Working with Page Cache

This form lists statistics for each cached page, such as visit count, time of creation/last access/expiration, and dependencies. The table legend identifies which types of information are tracked: invalidated pages, updates to dependencies, and changes to the dependency generation count. The form also provides the following options:

  • Searching the cache for specific pages – Searches are CPU intensive and should be used with caution on a delivery system.

  • Flushing pages from the cache.

  • Viewing html information for pages.

  • Looking up page dependencies.

The view and work with items in the Page Cache:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Sites Cache node, and then double-click Page Cache.

    The Pages form is shown (in the following figure).

  2. At the top of the form is the Search area. Select to search by Key, Expired Time, or by Dependency. If you enter an expired time to search by, use the forms mm/dd/yyyy or mm/dd/yyyy hh:mm:ss to enter a date and time. Click Search.
  3. In the displayed items in the cache, click the header title to sort the items by that criteria.

    All items are shown when initially loading the Pages form. The Search form limits what opens, making it easier to find items in the cache.

  4. Underneath each item in the Key column, a view page details link opens. Click view page details to open a new window that shows the page's HTML information.
  5. To flush selected assets from the cache, select the check box on the left side of each asset. Select the check box in the header to select all displayed assets. Click Flush Cache to flush the memory and stores of the assets.
  6. To view the pages for a specific item within the cache, select the check box on the right side of each item. Select the check box in the header to mark all displayed dependencies. Click Page Lookup to show the pages for the dependency or dependencies.

    Note that each item in cache can have multiple check boxes on the right side, reflecting multiple dependencies.

Note:

After WebCenter Sites is restarted, this form does not show page cache information until the cache engine is initialized. The cache engine is initialized when the first page or asset is requested.

30.6.3 Working with the Dependency Cache

This form lists the contents of the dependency cache and the generation count for each dependency. In addition, it provides the following options:

  • Searching the cache for specific dependencies – Searches are CPU intensive and should be used with caution on a delivery system.

  • Flushing dependencies from the cache

  • Looking up page dependencies

The view and work with items in the Dependency Cache:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Sites Cache node, and double-click Dependency.

    The Dependencies form is shown (Figure 30-12).

    Figure 30-12 Sites Cache Dependencies

    Description of Figure 30-12 follows
    Description of "Figure 30-12 Sites Cache Dependencies"
  2. In the displayed items in the cache, click the header title to sort the items by that criteria.

    All items are shown when initially loading the Dependencies form. The Search form limits what opens, making it easier to find items in the cache.

  3. To flush selected assets from the cache, select the check box on the left side of each asset. Select the check box in the header to select all displayed assets. Click Flush Cache to flush the memory and stores of the assets.
  4. To view the pages for a specific item within the cache, select the check box on the right side of each item. Select the check box in the header to mark all displayed dependencies. Click Page Lookup to show the pages for the dependency or dependencies.

Note:

After is restarted, this form does not show dependency cache information until the cache engine is initialized. The cache engine is initialized when the first page or asset is requested.

30.6.4 Working with the Asset Cache

This form lists statistics for each cached asset, such as visit count, time of creation/last access, and dependencies. The table legend identifies which types of information are tracked: invalidated assets, updates to dependencies, and changes to the dependency generation count. The form also provides the following options:

  • Searching the cache for specific assets. Searches are CPU intensive and should be used with caution on a delivery system.

  • Flushing assets from the cache

  • Looking up asset dependencies

The view and work with items in the Asset Cache:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Sites Cache node, and then double-click Asset Cache.

    The Assets form is shown (in the following figure).

  2. At the top of the form is the Search area. Select to search by Key or by Dependency, and to show All or Any assets with the entered search value. Click Search.
  3. In the displayed items in the cache, click the header title to sort the items by that criteria.

    All assets are shown when initially loading the Assets form. The Search form limits what opens, making it easier to find items in the cache.

  4. To flush selected assets from the cache, select the check box on the left side of each asset. Select the check box in the header to select all displayed assets. Click Flush Cache to flush the memory and stores of the assets.
  5. To view the assets for a specific dependency within the cache, select the dependency check box on the right side of each asset. Select the dependency check box in the header to mark all the displayed assets. Click Asset Lookup to show the dependencies.

Note:

After WebCenter Sites is restarted, this form does not show asset cache information until the cache engine is initialized. The cache engine is initialized when the first page or asset is requested.

30.6.5 Working with the URL Cache

All the Vanity URLs are cached after the resolution is done in a web page in inCache. The cache can be looked up and managed in the Cache Management node under System Tools.

The view and work with items in the URL Cache:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Sites Cache node, and then double-click URL Cache.

    The URLs form is shown (in the following figure).

    Figure 30-14 URLs form, URL Cache

    Description of Figure 30-14 follows
    Description of "Figure 30-14 URLs form, URL Cache"
  2. The Search area is at the top of the form. Select to search by Key or by Dependency with the entered search value. Click Search.
  3. In the displayed items in the cache, click the header title to sort the items by that criteria.

    All items are shown when initially loading the URL form. The Search form limits what opens, making it easier to find items in the cache.

  4. To flush selected URLs from the cache, select the check box on the left side of each URL. Select the check box in the header to mark all displayed URLs of the assets. Click Flush Cache to flush the memory and stores of the URLs.
  5. To view the URL for a specific dependency within the cache, select the dependency check box on the right side of each URL. Select the check box in the header to mark all displayed URLs of the assets. Click Asset Lookup to show the dependencies.

30.6.6 Viewing Cluster Information

If Sigar is configured, The Cluster Info form lists the name, URL, port, and GUID of each additional cluster member.

To view and work with cluster information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Sites Cache node, and then double-click Cluster Info.

    The Cluster Info form is shown (in the following figure).

30.7 Working with Cache Management - Co-Res Cache

The following topics provide information about cache management for the Co-Res Cache:

30.7.1 Overview of the Co-Res SS Cache Summary Form

The cache summary form for the Co-Res Satellite Server lists the following basic data for each cache (values are estimates):

  • Total Count (total number of cached elements)

  • Memory Store Count (number of cached elements in memory)

  • Disk Store Count (number of cached elements on disk)

  • Cache Hits (number of cached elements retrieved from both memory and disk)

  • In Memory Hits (number of cached elements retrieved from memory)

  • On Disk Hits (number of cached elements retrieved from disk)

  • Cache Misses (number of times elements were not found in the cache)

  • Eviction Count (number of elements evicted from the cache)

  • Average Get Time (average number of milliseconds for retrieving an element)

  • Max Elements In Memory (maximum number of elements allowed in memory)

  • Max Elements On Disk (maximum number of elements allowed on disk)

  • Overflow to Disk (whether elements are written to disk when memory is full)

This form also provides the following options. They should be used with caution, especially on a delivery system, as they can impact the performance of your site.

  • Writing a cache's entire memory store to disk. This option can be particularly useful if WebCenter Sites is not set up to automatically write a cache's memory store to disk before shutting down.

  • Flushing a cache's entire memory and disk stores.

Note:

If legacy page caching is enabled, cached page data is stored in the SystemPageCache table and information about the stored data is not displayed in the Summary window.

To view and work with summary cache information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Co-Res SS Cache node, and then double-click Summary.

    The Summary page is shown (in the following figure).

    Figure 30-16 Co-Res SS Cache Summary

    Description of Figure 30-16 follows
    Description of "Figure 30-16 Co-Res SS Cache Summary"
  2. Select the check box for the PageCache, Cache Dependencies, or URL Cache and click Write To Disk to write the selected cache's entire memory store to disk.
  3. Select the check box for the PageCache, Cache Dependencies, or URL Cache and click Flush Cache to flush the memory and disk stores for the selected caches.

30.7.2 Working with the Page Cache

This form lists statistics for each cached page, such as visit count, time of creation/last access/expiration, and dependencies. The table legend identifies which types of information are tracked: invalidated pages, updates to dependencies, and changes to the dependency generation count. The form also provides the following options:

  • Searching the cache for specific pages – Searches are CPU intensive and should be used with caution on a delivery system.

  • Flushing pages from the cache.

  • Viewing html information for pages.

  • Looking up page dependencies.

The view and work with items in the Page Cache:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Co-Res SS Cache node, and then double-click Page Cache.

    The Pages form is shown (in the following figure).

    Figure 30-17 Co-Res SS Pages Cache

    Description of Figure 30-17 follows
    Description of "Figure 30-17 Co-Res SS Pages Cache"
  2. At the top of the form is the Search area. Select to search by Key, Expired Time, or by Dependency. If you enter an expired time to search by, use the forms mm/dd/yyyy or mm/dd/yyyy hh:mm:ss to enter a date and time. Click Search.
  3. In the displayed items in the cache, click the header title to sort the items by that criteria.

    All items are shown when initially loading the Pages form. The Search form limits what opens, making it easier to find items in the cache.

  4. Underneath each item in the Key column, a view page details link opens. Click view page details to open a new window that shows the page's HTML information.
  5. To flush selected assets from the cache, select the check box on the left side of each asset. Select the check box in the header to select all displayed assets. Click Flush Cache to flush the memory and stores of the assets.
  6. To view the pages for a specific item within the cache, select the check box on the right side of each item. Select the check box in the header to mark all. Click Page Lookup to show the pages for the dependency or dependencies.

    Note that each item in cache can have multiple check boxes on the right side, reflecting multiple dependencies.

Note:

After is restarted, this form does not show page cache information until the cache engine is initialized. The cache engine is initialized when the first page or asset is requested.

30.7.3 Working with the Dependency Cache

This form lists the contents of the dependency cache and the generation count for each dependency. In addition, it provides the following options:

  • Searching the cache for specific dependencies. Searches are CPU intensive and should be used with caution on a delivery system.

  • Flushing dependencies from the cache.

  • Looking up page dependencies.

The view and work with items in the Dependency Cache:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Co-Res SS Cache node, and then double-click Dependency.

    The Dependencies form is shown (in the following figure).

    Figure 30-18 Co-Res SS Cache Dependencies

    Description of Figure 30-18 follows
    Description of "Figure 30-18 Co-Res SS Cache Dependencies"
  2. In the displayed items in the cache, click the header title to sort the items by that criteria.

    All items are shown when initially loading the Dependencies form. The Search form limits what opens, making it easier to find items in the cache.

  3. To flush selected assets from the cache, select the check box on the left side of each asset. Select the check box in the header to select all displayed assets. Click Flush Cache to flush the memory and stores of the assets.
  4. To view the pages for a specific item within the cache, select the check box on the right side of each item. Select the check box in the header to mark all displayed dependencies. Click Page Lookup to show the pages for the dependency or dependencies.

Note:

After is restarted, this form does not show dependency cache information until the cache engine is initialized. The cache engine is initialized when the first page or asset is requested.

30.7.4 Working with the URL Cache

All the Vanity URLs are cached after the resolution is done in a web page in inCache. The cache can be looked up and managed in the Cache Management node under System Tools.

The view and work with items in the URL Cache:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Co-Res SS Cache node, and then double-click URL Cache.

    The URLs form is shown (in the following figure).

    Figure 30-19 URLs form, URL Cache

    Description of Figure 30-19 follows
    Description of "Figure 30-19 URLs form, URL Cache"
  2. At the top of the form is the Search area. Select to search by Key or by Dependency with the entered search value. Click Search.
  3. In the displayed items, click the header title to sort the items by that criteria.

    All items are shown when initially loading the URLs form. The Search form limits what opens, making it easier to find items in the cache.

  4. To flush selected URLs from the cache, select the check box on the left side of each URL. Select the check box in the header to mark all displayed URLs of the assets. Click Flush Cache to flush the memory and stores of the URLs.
  5. To view the URLs for a specific dependency within the cache, select the dependency check box on the right side of each URL. Select the check box in the header to mark all displayed URLs of the assets. Click Asset Lookup to show the dependencies.

30.7.5 Viewing Cluster Information

If Sigar is configured, the Cluster Info form lists the name, URL, port, and GUID of each additional cluster member.

To view and work with cluster information:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Cache Management node, expand the Co-Res SS Cache node, and then double-click Cluster Info.

    The Cluster Info form is shown (in the following figure).

30.8 Using the Log Viewer

The Log Viewer tool enables you to view, tail, download, and search the contents of the WebCenter Sites log specified in the logging-config.xml file directly from the WebCenter Sites Admin interface. Since the total size of the log affects the tool's performance, if the log size exceeds 100 megabytes, you are informed and given the choice to proceed or cancel.

The following topics provide information about using the Log Viewer tool:

30.8.1 Viewing the Log

You can browse the entire contents of the WebCenter Sites log, starting with statements written most recently or written at a specific time.

To view the contents of the log:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click Log Viewer.

    The Log Viewer form shows the most recent 100 lines in the log.

  2. To jump to statements written at a specific time, do the following:

    1. Click the calendar icon and select a date and time, or enter the date and time manually in the yyyy-mm-dd hh:mm:ss format.

      Note:

      This feature operates only on log statements that were written with the timestamping pattern specified in the logging-config.xml file.

    2. Click View Logs.

      The Log Viewer form is shown.

      The form shows the statements written at and after the specified date and time.

30.8.2 Tailing the Log

You can tail the WebCenter Sites log in a separate window. This option is particularly useful when you want to keep track of the statements written to the log while executing an action that causes an exception.

To tail the contents of the log:

  1. In the General Admin tree, expand the Admin node, expand System Tools, and then double-click Log Viewer.

    The Log Viewer form is shown (in the following figure).

  2. Click Tail Logs.

    The most recent 100 lines in the log are shown in a new window and are refreshed every five seconds.

30.8.3 Downloading the Log

You can download a compressed file containing the entire contents of the log.

To download the contents of the log:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click Log Viewer.

    The Log Viewer form is shown (Figure 30-21).

  2. Click Download Logs.
  3. Open or save the compressed file containing the log. If the log is spread over several files, each file is included.

30.8.4 Searching the Log

You can search the contents of the WebCenter Sites log for specific information.

To search the contents of the log:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click Log Viewer.

    The Log Viewer form is shown (Figure 30-21).

  2. To enable case-sensitive matching, select the Case Sensitive check box. By default, case-sensitivity covers only US-ASCII characters. If you want case-sensitivity to apply to Unicode characters, select the Unicode Case check box as well. The Unicode Case check box opens when the Case Sensitive check box is selected.
  3. If you want the search to allow the usage of Java regular expressions, select the Regular Expression check box. When the Regular Expression check box is selected, the Dot All and Multi Line check boxes appear. Use these to refine the regular expression settings:
    • If you want a dot (.) to match any characters and line terminators, select the Dot All check box. If this check box is not selected, a dot matches only characters.

    • If you want a caret ( ^) to match the beginning of a line and a dollar sign ($) to match the end of a line, select the Multi Line check box.

      Note:

      If you search with regular expressions, a single search result is restricted to a maximum of 40 lines of the log.

  4. In the search field, enter the expression to find in the log.
  5. In the Results per page field, select the number of results to list on each page.
  6. Click Search Logs.

    The Log Viewer form shows the lines in the log that match your search.

  7. To view a search result in its larger context, click View log below the result line.

    100 lines of the log, starting with the line matching the search, are displayed in a new window.

30.9 Performance Test

You can determine performance of File System and Lucene Indexing by tools provided in WebCenter Sites under System Tools in Admin tab.

The performance test tools in WebCenter Sites include:

30.9.1 File System Test

The File System Test tool enables you to test the local application server directory and the central directories in the shared file system (<cs_install_dir>/Shared) to compare their performance with provided benchmarks.

Table 30-3 Tested File Systems

FileSystem Description

spc

Shared page cache directory for all WebCenter Sites cluster members.

Sample path:

\cs76\Shared\SystemPageCache\

local

Temporary directory for servlet context information.

Sample path:

\apache-tomcat-6.0.16\work\Catalina\localhost\cs

data

Shared blob data directory for all WebCenter Sites cluster members.

Sample path:

\cs76\Shared\ccurl

sync

Shared synchronization directory for all WebCenter Sites cluster members.

Sample path:

\cs76\Shared\clustersync

A test suite is made of several tests performed on the local application server directory and the shared file system directories. Each of these tests executes multiple threads. Each thread creates an empty file and then writes to, reads, and deletes the file. The following test suites are available:

  • Short Test that runs a total of 16 tests (4 tests are performed on each of the directories listed in the table above).

  • Medium Test that runs a total of 64 tests (16 tests are performed on each of the directories listed in the table above).

  • Extensive Test – runs a total of 384 tests (96 tests are performed on each of the directories listed in the table above).

To test the file system:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Performance Test node, and then double-click File System Test.

    The File System Test form is shown.

  2. Select the type of test you want to perform and click Start Test.

    Note:

    • If the test takes too long or affects performance too much, you can click Stop Test.

    • The results of a file system test can be compared with the provided benchmark only when the test is completed.

  3. Once the test is complete, review the overall results in the Performance Summary table. The following information is shown for each directory:

    • Numbers displayed in bold are benchmarks. The benchmarks were calculated by running standard tests on an Oracle Secure Linux 5.4 system connected to a 10K RPM SAS300 HD through NFS version 4. Both the client and server were on the same network switch and there was no additional traffic at the time of the test.

    • FileSystem specifies the directory the test was performed on.

    • Path specifies the path to the directory a file system test was performed on.

    • Create specifies the average number of microseconds a create operation was performed.

    • Write specifies the average number of microseconds a write operation was performed.

    • Read specifies the average number of microseconds a read operation was performed.

    • Delete specifies the average number of microseconds a delete operation was performed.

  4. For detailed information about each test, review the graph (located under the Performance Summary table) and the test results table (located under the graph).

  5. To view the results of a single test, either hover over a point on the graph or navigate to the row in the test results table.

    The following information is shown in the table for each test:
    • Test lists a serial number for each test.

    • Threads lists the number of threads created during the test.

    • Files lists the number of files created per thread.

    • Size lists the number of bytes per file.

    • Reads lists the number of times each file was read by a test.

    • Lock lists if each file was locked (random access lock operation).

    • Attributes lists whether each file's attributes were read during the test.

    • Mode lists the Java I/O random access mode for accessing the files in the thread.

    • FileSystem lists the directory on which the test was performed.

    • Create lists the minimum, maximum, and average number of microseconds in which the test performed a create operation.

    • Write lists the minimum, maximum, and average number of microseconds in which the test performed a write operation.

    • Read lists the minimum, maximum, and average number of microseconds in which the test performed a read operation.

    • Delete lists the minimum, maximum, and average number of microseconds in which the test performed a delete operation.

    • Total Test Time lists the total number of microseconds in which a test was completed.

    In the test results table, expand a row to view detailed information about each thread that was created during a specific test. The following information is shown in the thread detail table:
    • Thread lists a serial number for each thread.

    • Create lists the total number of microseconds the thread created an empty file.

    • Write lists the total number of microseconds the thread finished writing to the file.

    • Read lists the total number of microseconds the thread read the file it created.

    • Delete lists the total number of microseconds the thread deleted the file.

    Note:

    • Each point on a graph and row in a table shows information for a single test.

    • To view the details of a single test, when you hover over a point in the graph, use a browser other than Internet Explorer.

30.9.2 Lucene Indexing Test

You can use the Lucene Indexing Test tool to test the performance of Lucene indexing, either on shared file system, that is (<cs_install_dir>/Shared/lucene) or on NIO (Non-blocking I/O), that is sharefs://Shared/lucene. The results of these tests are compared against benchmark results.

A test suite that is composed of a number of tests is performed on the Lucene index files on shared file systems or NIO. Each of these tests creates indexing for 20 assets, re-indexing for 20 assets, and deletes indexing for 20 assets. The following test suites are available:
  • Short test suite that runs a total of 16 tests.

  • Medium test suite that runs a total of 64 tests.

  • Extensive test suite that runs a total of 384 tests.

To test Lucene indexing:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, expand the Performance Test node, and then double-click Lucene Indexing Test.
  2. In the Lucene Indexing Test form, select the type of test you want to perform and click Start Test.

    Note:

    • If the test takes too long or affects performance, you can click Stop Test.

    • The results of the Lucene Indexing Test can be compared with the provided benchmark only when the test is completed. These benchmarks are provided by running standard tests on an Oracle Linux 7u1 (Intel 64-bit, 16GB RAM) and 12.1.0.2 Oracle Database with no additional traffic during the test.

  3. Once the test is complete, review the overall results in the Performance Summary table.
    The following information is shown in the Performance Summary:
    • Numbers displayed in bold specify benchmarks. The benchmarks were established by internal testing.

    • FileSystem specifies the directory on which the test was performed.

    • Path specifies the path to the directory on which a Lucene Indexing Test was performed.

    • Index specifies Min/Max/Average of Index operation for 20 asserts in microseconds for all the tests performed.

    • Reindex specifies Min/Max/Average of Re-index operation for 20 asserts in microseconds for all the tests performed.

    • Delete specifies Min/Max/Average of delete operation for 20 asserts in microseconds for all the tests performed.

  4. For detailed information about each test, review the graph (located under the Performance Summary table) and the test results table (located under the graph).
  5. To view the results of a single test, either hover over a point on the graph or navigate to the desired row in the test results table.
    The following information is shown in the graph
    • Thread specifies the number of threads created. In Lucene Indexing Test is Single threaded.

    • Index specifies the time taken in 1000 μS to create indexing for 20 assets.

    • Reindex specifies the time taken in 1000 μS to re-index 20 assets.

    • Delete specifies the time taken in 1000 μS to delete indexing for 20 assets.

    The following information is shown in the table for each test:
    • Test specifies a serial number for each test.

    • Thread specifies the number of threads created. In Lucene Indexing Test, a test is single threaded.

    • Index specifies the time taken in μS to create indexing for 20 assets.

    • Reindex specifies the time taken in μS to re-index 20 assets.

    • Delete specifies the time taken in μS to delete indexing for 20 assets.

    • Total Test Time specifies the total number of microseconds in which a test was completed.

    Note:

    • Each point on the graph and row in the table shows information about a single test.

    • In the test results table, the values in each column index, reindex, and delete represents time taken for indexing, re-indexing, and deleting indexes for 20 assets in micro seconds.

30.10 Working with Slots Assets

Slots assets are used to store presentation changes made when editing a website in context. Slots assets are managed transparently, they are not available in the user interfaces. The Slots node in System Tools where you void or delete existing slot data.

A deleted slot asset has its rows removed from the database table. A voided slot asset is an asset that has had its status changed to VO. However, it is not removed from the database so it will also not show up in any searches and similar inquiries. Voided assets can be physically removed in a purge. See Working with the Purge Voided Assets Node.

To void Assets or delete Assets:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click the Slots node.

    The Slot Assets Utility form opens.

  2. The Slot Assets Utility form shows the slot assets. Click a table heading to re-organize based on that criteria (that is, by Slot Name, by Site, by Context, by Template, or by Primary Asset Id). Alternately, you can search by selecting one of those criteria as a search parameter and entering a value to search.
  3. Select one or more assets by selecting the check boxes.
  4. Click Void Asset to void the selected assets (for a later purge), or click Delete to delete the assets.

    Note:

    When either deleting or voiding the slot assets, no confirmation message opens. The list of remaining assets redisplay.

When an asset is voided, it doesn't appear in any lists of assets or searches for assets. However, it is still taking space in the database. In some cases, the space taken up by voided assets must be reclaimed; this is handled through purging voided assets. For information about how to purge voided assets, see Working with the Purge Voided Assets Node.

30.11 Working with the URL Node

The URL node allows you to search, view, and delete custom URLs, also known as vanity URLs. These URLs are domains used to redirect to a certain section of your website, which may or may not be accessible to the rest of the hosted website. Often these vanity URLs are used to prevent a long URL that has coded strings within it, making it easier for the web user to view your page.

To view and manage vanity URLs:

  1. In the General Admin tree, expand the Admin node, expand the System Tools node, and then double-click URL.

    The URL Utility form is shown (in the following figure).

    All vanity URLs, including auto-generated URLs, are shown.

  2. You can limit the list by entering the search criteria for Host, URL, Template, Wrapper, or HTTP Status, then click Search.
  3. The displayed vanity URLs can be sorted by clicking the column headers - Host, URL, Template, Wrapper, and HTTP Status.
  4. To delete a vanity URL, select the check box and click Delete.

30.12 Working with the Purge Voided Assets Node

The Purge Voided Assets node allows you to remove those assets which have been marked void. You can choose between purging all voided assets or purging those voided assets of a specific asset type.

To purge voided assets:

  1. Expand the System Tools node, then double-click Purge Voided Assets.
  2. Select the asset type, or all asset types, to purge the voided assets.
  3. Click Purge.

    If assets were purged, a confirmation message will display:

    Purged n assets of type asset type

    If no assets were purged, a message will display:

    No voided Assets of type asset type found

    If All was selected, then a message will display for each type, stating if assets were purged or if no assets were available to purge for that type.