PM62977: ALLOW FOR CLEANUP OF XA PARTNER LOGS

Fixes are available

APAR status

Closed as program error.

Error description

It is not recommended to delete XA partner logs.  However,
under certain circumstances, in a case where recovery cannot
complete and logs are not being cleaned up, it might be
necessary to be able to delete entries from the logs.

Some of the consequences of recovery not being able to complete
successfully is a increased CPU usage, or XA partner log filling
up, ex:

WTRN0000E: An internal error occurred in method logData in class
com.ibm.ws.Transaction.JTA.PartnerLogData; the exception stack
trace follows:
com.ibm.ws.recoverylog.spi.LogFullException
at com.ibm.ws.recoverylog.spi.MultiScopeRecoveryLog.keypoint
(MultiScopeRecoveryLog.java:1739)
...

Note, this apar is NOT a fix for the original problem that
caused the recovery to fail.

In order to be pro-active and avoid recovery issues described
here, follow this page to ensure all XA resources are recovered
before any changes to the resources are made:
https://www.ibm.com/docs/en/was-zos/9.0.5?topic=servers-updating-resources-application-server

Local fix

Problem summary

****************************************************************
* USERS AFFECTED:  All users of IBM WebSphere Application      *
*                  Server V7.0, V8.0 and V8.5                  *
****************************************************************
* PROBLEM DESCRIPTION: Periodic recovery attempted on          *
*                      resource entries in the partner log     *
*                      that can never be recovered.            *
****************************************************************
* RECOMMENDATION:                                              *
****************************************************************
An entry in a partner log that describes a resource that
cannot be recovered (for example, a resource that no longer
exists, or is no longer contactable) will remain in the
transaction partner log.  The resource is subject to periodic
attempts at recovery, which will fail, causing exception
messages to be logged to SystemOut.  Additionally, on z/OS
platforms this can cause the transaction XA partner log to
become full, as all entries will remain in the log after any
entry has failed to be recovered successfully.

Problem conclusion

Provide a method to allow for the removal of log entries from
the transaction partner log.

This functionality is controlled by the following transaction
service custom property :

Name :  REMOVE_PARTNER_LOG_ENTRY
Value : A comma-delimited set of recovery ID's of the log
entries to be removed

Examples :

REMOVE_PARTNER_LOG_ENTRY=2
REMOVE_PARTNER_LOG_ENTRY=4,13,9,7

The recovery ID's of resource entries to be removed are only
printed out with Transaction tracing enabled - the example
trace entry following shows a resource having a recovery ID
value of 4 :

index=7, recoveryID=4, recovered=true, terminating=false,
loggedToDisk=true, data=com.ibm.ejs.j2c......


REMOVE_PARTNER_LOG_ENTRY=0

A recovery ID of 0 (zero) indicates that ALL resource entries
that throw XA Exceptions during recovery are removed from the
the transaction partner log.

For each server that is required to have the new behaviour
enabled :

1. Login to the Administrative Console
2. Select Servers -> Application Servers -> server ->
Container Services -> Transaction Service
3. Select the Configuration tab
4. Select Custom Properties
5. Press new
6. Enter REMOVE_PARTNER_LOG_ENTRY as the name
7. Enter comma-delimited list of Recovery ID's as the value
8. Click Ok
9. Save changes
10. Restart the server

Once you have configured the transaction service custom
property you must start the server in recovery only mode
(server started with the -recovery option) to delete the
entries from the partner log.  No entries will be deleted if
there are transactions requiring recovery currently recorded
in the transaction log.

APAR PM62977 requires changes to documentation.

NOTE: Periodically, we refresh the documentation on our Web
site, so the changes might have been made before you read this
text. To access the latest on-line documentation, go to the
product library page at:

http://www.ibm.com/software/webservers/appserv/library

The following changes to the WebSphere Application Server
Version 7.0 Information Center will be made available in
September, 2012.

The description of the REMOVE_PARTNER_LOG_ENTRY custom
property, that is included in the topic "Transaction service
custom properties" will be updated to read as follows:

REMOVE_PARTNER_LOG_ENTRY

You can remove entries from the transaction partner log file.
To do this, set the REMOVE_PARTNER_LOG_ENTRY custom property
for the transaction service on the server that owns the
partner log.

As part of the transaction recovery process, the partner log
is checked to establish which resources are needed. If you
want to remove certain entries from the partner log, such as a
resource that no longer exists, set this custom property on
the application server that owns the transaction partner log
containing the entries you want to remove.

The REMOVE_PARTNER_LOG_ENTRY custom property is effective only
when both of the following situations apply.
   - The application server is started in recovery mode.
   - The application server has no transactions that currently
require recovery. You can establish this by checking the
SystemOut.log file.

Table 6. REMOVE_PARTNER_LOG_ENTRY custom properties

Data type:  Integer
Acceptable values:  One or more comma-delimited integer
recovery IDs. Starting with Version 7.0.0.25, if you specify a
recovery ID of 0 (zero), all resource entries that throw XA
Exceptions during recovery are removed from the the
transaction partner log.
Default:   null)

APAR PM62977 is currently targeted for inclusion in
Fix Packs 7.0.0.25, 8.0.0.5 and 8.5.0.1 of
WebSphere Application Server

Please refer to URL:
//www.ibm.com/support/docview.wss?rs=404&uid=swg27006970
for Fix Pack availability.

Temporary fix

Comments

APAR Information

APAR number

PM62977
Reported component name

WEBSPHERE FOR Z
Reported component ID

5655I3500
Reported release

700
Status

CLOSED PER
PE

NoPE
HIPER

NoHIPER
Special Attention

NoSpecatt
Submitted date

2012-04-20
Closed date

2012-06-27
Last modified date

2012-11-02

APAR is sysrouted FROM one or more of the following:
APAR is sysrouted TO one or more of the following:

Fix information

Fixed component name

WEBSPHERE FOR Z
Fixed component ID

5655I3500

Applicable component levels

R700 PSY UK81738

UP12/10/04 P F210

Fix is available

Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS7K4U","label":"WebSphere Application Server for z\/OS"},"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"7.0","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
02 September 2022

Tips

PM62977: ALLOW FOR CLEANUP OF XA PARTNER LOGS

Fixes are available

Subscribe

APAR status

Closed as program error.

Error description

Local fix

Problem summary

Problem conclusion

Temporary fix

Comments

APAR Information

APAR number

Reported component name

Reported component ID

Reported release

Status

PE

HIPER

Special Attention

Submitted date

Closed date

Last modified date

APAR is sysrouted FROM one or more of the following:

APAR is sysrouted TO one or more of the following:

Fix information

Fixed component name

Fixed component ID

Applicable component levels

R700 PSY UK81738

Fix is available

Select the PTF appropriate for your component level. You will be required to sign in. Distribution on physical media is not available in all countries.

Document Information

Share your feedback

Need support?