IBM Support

PH01810: PROVIDE CONNECTIVITY WITH IBM CLOUD PRIVATE METERING

Subscribe to this APAR

By subscribing, you receive periodic emails alerting you to the status of the APAR, along with a link to the fix after it becomes available. You can track this item individually or track all items by product.

Notify me when this APAR changes.

Notify me when an APAR for this component changes.

 

APAR status

  • Closed as new function.

Error description

  • WebSphere Application Server should register with
    IBM Cloud Private metering and provide usage metrics.
    

Local fix

Problem summary

  • ****************************************************************
    * USERS AFFECTED:  All users of IBM WebSphere Application      *
    *                  Server                                      *
    ****************************************************************
    * PROBLEM DESCRIPTION: Provide connectivity with IBM Cloud     *
    *                      Private metering                        *
    ****************************************************************
    * RECOMMENDATION:                                              *
    ****************************************************************
    IBM WebSphere Application Server should provide a mechanism to
    register and provide metrics to the IBM Cloud Private metering
    service.
    

Problem conclusion

  • APAR PH01810 provides support for registering a WebSphere
    Application server with an instance of the IBM Cloud Private
    metering service.
    
    The IBM Cloud Private metering service allows you to connect
    your IBM WebSphere Application Server to report registration
    and usage information. This includes application servers hosted
    both in IBM Cloud and in other environments. When an
    application server is configured to connect to the metering
    service, the following information is reported and can be
    viewed on the metering service dashboard:
    
    - Number of active servers
    - Host location of each server
    - Product edition and version of each server
    - Product metrics which indicate how busy each server is
    - The virtual processor cores available to each server
    
    After installing the APAR, before you connect an IBM WebSphere
    Application Server traditional server to IBM Cloud Private
    metering, you must have an IBM Cloud Private installation
    configured to support metering. WebSphere customers are
    entitled to use IBM Cloud Private Foundation at no charge
    for metering restricted use.
    
    Ensure that you have the URL and API key values of the
    IBM Cloud Private metering service that you want WebSphere
    Application Server to register to.
    
    Once the IBM Cloud Private installation is complete and the
    URL and API key are known, then configure the WebSphere
    Application Server traditional server using the following
    procedure:
    
    1 - Create a was-usage-metering.properties file with the
        following contents, substituting the URL and API key
        from the service credentials.
    
        # required
        url=<URL for IBM Cloud Private metering service>
        apiKey=<API key for IBM Cloud Private metering>
    
        ## One of the following is required for SSL
        # sslRef=<SSL alias name of server SSL configuration>
        # Or the following 3 properties
        # trustStore=<trustStore JKS file name>
        # trustStorePassword=<trustStore password>
        # httpsProtocol=<TLS protocol , defaults to TLSv1.2>
    
        # optional - to use, remove #
        # group=<group>
        # logData=<csv|json|all>
    
        On the url and apiKey properties, specify the URL and
        API key credentials that you noted when you configured
        the IBM Cloud Private metering service.
    
        SSL is required to connect with the IBM Cloud Private
        metering service and can be provided one of two ways.
        The sslRef property can be specified and set to the SSL
        alias name corresponding to an SSL configuration for the
        server, or use the trustStore, trustStorePassword and
        httpProtocol properties to specify the name of the .jks
        truststore file that contains the IBM Cloud Private
        certificate, the truststore password, and HTTP protocol.
        When you are building a docker image, the suggested
        action is to copy the trustStore file with the
        was-usage-metering.properties files.
    
        A truststore JKS file can be created with the wasadmin
        createKeyStore command. From your traditional profile,
        run wsadmin to run the following AdminTasks:
    
        AdminTask.createKeyStore('[-keyStoreName
           metering_keystore_name -keyStoreType JKS
           -keyStoreLocation path_to_keystore_JKS_file_to_create
           -keyStorePassword keyStorePassword
           -keyStorePasswordVerify keyStorePassword
           -keyStoreDescription "ICP metering truststore file" ]')
    
        The metering certificate can be added to the truststore
        file by using the retrieveSignerFromPort command.
    
        AdminTask.retrieveSignerFromPort('[-keyStoreName
           metering_keystore_name -host ICP_host_or_IP_Address
           -port ICP_Port -certificateAlias certificateAlias]')
    
        On the optional group attribute, you can define sets of
        servers to be grouped for reporting purposes. You can
        define multiple nested group levels by specifying
        highest-level groups first and specify nested groups in
        the format <parentGroup>/<nestedGroup>, as shown in the
        following example:
    
            group=WASGroup1/subgroupA/smallGroupx
    
        In this example, smallGroupx is nested inside subgroupA,
        which is nested inside WASGroup1. Grouped servers are
        displayed hierarchically on the metering service dashboard.
    
        Use the option logData property to generate logs containing
        all registration and usage metering data in the specified
        file format. Log files are written to the application server
        logs directory.  Log files may be generated in the csv
        format, json format, or both.
    
    2 - Add the was-usage-metering.properties file to your
        installation.
    
        - For WebSphere Application Server (base), place the file
          in the directory:
    
    
    <wasInstallRoot>/profiles/<profileName>/config/cells/<cellName>
    
    
        - For WebSphere Application Server Network Deployment or
          WebSphere Application Server for z/OS, place the file in
          any of the following directories. You can configure
          Product Insights at the server, cluster, node, or cell
          level, depending on which directory is used.
    
          - Server directory:
    <wasInstallRoot>/profiles/<profileName>/config/cells/<cellName>/
    nodes/<nodeName>/servers/<servername>
          - Cluster directory:
    <wasInstallRoot>/profiles/<profileName>/config/cells/<cellName>/
    clusters/<clustername>
          - Node directory:
    <wasInstallRoot>/profiles/<profileName>/config/cells/<cellName>/
    nodes/<nodeName>
          - Cell directory:
    <wasInstallRoot>/profiles/<profileName>/config/cells/<cellName>
    
          If your environment uses a deployment manager, place the
          file in the directory tree for the deployment manager
          profile. Then, propagate the file to each of the
          managed nodes by starting wsadmin and running the
          following commands:
    
          repository=
    AdminControl.queryNames('type=ConfigRepository,process=dmgr,*')
          AdminControl.invoke(repository, 'refreshRepositoryEpoch')
          AdminNodeManagement.syncActiveNodes()
    
          If your environment does not use a deployment manager,
          place the file in the corresponding directory for
          each server, node, or cell that you want to register.
    
          After you add the file, if the server is running or the
          next time it starts, the server registers with the
          Product Insights service instance.
    
    
    Each registered WebSphere Application Server traditional
    server - or for Network Deployment, each registered cluster,
    node, or cell - reports usage metrics to your metering
    service instance.
    
    If you no longer want to report metrics to the metering
    service, remove the was-usage-metering.properties
    file from your WebSphere Application Server installation.
    
    For additional details, the IBM Knowledge Center topic
    "Registering WebSphere traditional servers with the metering
    Service in IBM Cloud Private".
    
    The fix for this APAR is currently targeted for inclusion in
    fix packs 9.0.0.9 and 8.5.5.15. Please refer to the Recommended
    Updates page for delivery information:
    http://www.ibm.com/support/docview.wss?rs=180&uid=swg27004980
    

Temporary fix

Comments

APAR Information

  • APAR number

    PH01810

  • Reported component name

    WEBSPHERE APP S

  • Reported component ID

    5724J0800

  • Reported release

    850

  • Status

    CLOSED PER

  • PE

    NoPE

  • HIPER

    NoHIPER

  • Special Attention

    NoSpecatt / Xsystem

  • Submitted date

    2018-08-17

  • Closed date

    2018-09-20

  • Last modified date

    2018-09-20

  • 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 APP S

  • Fixed component ID

    5724J0800

Applicable component levels

[{"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSCVS22","label":"General"},"Component":"","ARM Category":[],"Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"850","Edition":"","Line of Business":{"code":"","label":""}}]

Document Information

Modified date:
20 September 2018