Fix (APAR):  PH24409

Status:  Fix

Release:  8.5.5.19,8.5.5.18,8.5.5.17,8.5.5.16

Operating System:  AIX,HP-UX,IBM i,Linux,Solaris,Windows,z/OS

Supersedes Fixes:  

CMVC Defect:  xxxxxx

Byte size of APAR:  1301987

Date: 2021-03-24

Abstract:  prometheus endpoint for pmi metrics on websphere application server traditional

Description/symptom of problem:  
PH24409 resolves the following problem:

ERROR DESCRIPTION:
Adding a Prometheus endpoint to scrape Performance Monitoring   
Infrastructure (PMI) metrics with an installable application    
on WebSphere Application Server traditional.                    

LOCAL FIX:

PROBLEM SUMMARY:

USERS AFFECTED:
 All users of IBM WebSphere Application
Server

PROBLEM DESCRIPTION:
A new metrics.ear application to create
a
Prometheus endpoint for your WebSphere
Application Server to display PMI
metrics
in Prometheus format.

RECOMMENDATION:
None

Previously, the PMI data can only be consumed internally using
the
Tivoli Performance Viewer (TPV) for graphing purposes, or it can
also be exposed externally using the HTTP PerfServlet (in XML
format) or via JMX MBeans. There were no available methods to
convert the existing Performance Monitoring Infrastructure (PMI)
data to Prometheus format.

PROBLEM CONCLUSION:
A new metrics.ear installable application is now available in th
WAS_HOME/installableApps directory, which                       
provides a new way to consume WebSphere Application Server      
Performance Monitoring Infrastructure (PMI) metrics data.       
                                                                
The metrics.ear application provides a way to use HTTP requests 
query the performance metrics for an entire WebSphere Applicatio
Server administrative domain. It creates a Prometheus endpoint  
(/metrics) for your WebSphere Application Server runtimes to    
display PMI metrics in Prometheus format. The metrics available 
the Prometheus endpoint correspond to the set of metrics enabled
the PMI configuration.                                          
                                                                
The fix for this APAR is targeted for inclusion in fix pack     
8.5.5.20 and 9.0.5.7. For more information, see 'Recommended    
Updates for WebSphere Application Server':                      
https://www.ibm.com/support/pages/node/715553                   


Directions to apply fix:  Fix applies to Editions:
Release 8.5
X Application Server (Express or BASE)
X Network Deployment (ND)
__ Liberty Core
__ Edge Components
X Developer

Install Fix to all WebSphere installations unless special instructions are included below.

Special Instructions: None

NOTE:
The user must:
* Logged in with the same authority level when unpacking a fix, fix pack or refresh pack.
* Be at V1.4.3 or newer of the Installation Manager. Certain iFixes may require a newer version of the Installation Manager and the Installation Manager will inform you during the installation process if a newer version is required.

The IBM Knowledge Center can provide details, if needed, on the use of the Installation Manager to apply the iFixes.
http://publib.boulder.ibm.com/infocenter/install/v1r4/index.jsp.  Shutdown WebSphere Application Server before applying the iFixes.  Restart WebSphere Application Server after applying the iFixes.

Directions to remove fix:  

The IBM Knowledge Center can provide details, if needed, on the use of the Installation Manager to remove the iFixes.
http://publib.boulder.ibm.com/infocenter/install/v1r4/index.jsp.  Shutdown WebSphere Application Server before removing the iFixes.  Restart WebSphere Application Server after removing the iFixes.

Directions to re-apply fix:  
1) Shutdown WebSphere Application Server.

2) Follow the Fix instructions to apply the fix.

3) Restart WebSphere Application Server.



Additional Information: