Enabling the Metrics Monitoring framework in a development environment

In order to use the Version 9.1 metrics monitoring framework, activate it in each of the Transaction, Search, xC and Store servers.

Enabling metrics on the Transaction server

  1. Configure the WebSphere Application Server.
    1. Define a new port (Application servers > server1 > Web container transport chains). Provide the following values in the corresponding fields:
      • Transport chain name: monitor
      • template: (not secure)
      • create new port:
      • name: monitor
      • host: *
      • port: 5280 (ensure it is not used)
    2. Add the port to WC_default_host (Environment à Virtual hosts)
      host Name: *
       port: 5280
    3. Set up generic JVM arguments in WAS
      dd -Dexpose_metrics=true (
      For more information, see Setting generic JVM arguments in WebSphere Application Server.
  2. Restart the Transaction Server

Enabling metrics on the Search server

  1. Add the following in jvm.options:
    -Dexpose_metrics=true
  2. dd the following in server.xml:
    <httpEndpoint host="*" httpPort="3280" httpsPort="3243" id="defaultMonitorEndpoint"/>
  3. Restart the Search server

Enabling metrics on the Store server

  1. Add the following in jvm.options:
    -Dexpose_metrics=true 
  2. Add the following in server.xml:
    <httpEndpoint host="*" httpPort="8280" httpsPort="8243" id="defaultMonitorEndpoint"/>
  3. Restart the Search server

Enabling metrics on the xC server

  1. Add the following in jvm.options:
    -Dexpose_metrics=true
  2. Add the following in server.xml:
    <httpEndpoint host="*" httpPort="9280" httpsPort="9243" id="defaultMonitorEndpoint"/>
  3. Restart the Search server

Enabling Cache Provider configuration on toolkit

Perform the following actions from the traditional WebSphere Application Server.
  1. Create a new Docker container named redis.
    docker run --name redis -e ALLOW_EMPTY_PASSWORD=yes bitnami/redis:latest
  2. Open the toolkit/setup/hcl-cache/cache_cfg.yaml file, and ensure that the redis container's yamlConfigentry has the correct location for redis_cfg.yaml.
  3. Set the following environment variable.
    CACHE_MANAGER_CONFIG=cache 
    Where cache is the location of the cache_cfg.yaml file. For example, W:\WCDE_V9\setup\hcl-cache\cache_cfg.yaml.

    For more information, see Setting generic JVM arguments in WebSphere Application Server.

  4. Define the HCL Cache provider. Run the following command:
    WCDE_installdir\wasprofile\bin\wsadmin.bat -conntype NONE -f toolkit\setup\setCacheProvider.py\defineHCLCacheProvider.py
    For example:
    W:\WCDE_V9\wasprofile\bin\wsadmin.bat -conntype NONE -f toolkit\setup\setCacheProvider.py\defineHCLCacheProvider.py
  5. Configure all caches with the new cache provider.
    <toolkit>\wasprofile\bin\wsadmin.bat -conntype NONE -f toolkit\setup\setCacheProvider.py\setCacheProvider.py provider_name all | filename 
    For example:
    W:\WCDE_V9\wasprofile\bin\wsadmin.bat -conntype NONE -f toolkit\setup\setCacheProvider.py\setCacheProvider.py hcl-cache all
Perform the following actions on the Liberty server.
  1. 1. Set the environment variable in the server.env file.
    CACHE_MANAGER_CONFIG=cache
    Where cache is the location of the cache_cfg.yaml file. For example,
    W:\WCDE_V9\setup\hcl-cache\cache_cfg.yaml
  2. Update the server.xml file.
    <distributedMap id="services/cache/SearchDistributedMapCache" memorySizeInEntries="2001" highThreshold="98" lowThreshold="95" cacheProviderName="hcl-cache"/>