The OpenEdge HealthScanner is intended for use with production instances. System administrators must enable the IP filter to secure the connection used by the HealthScanner.

As an opt-in feature, system administrations must enable the HealthScanner and enable the overhead associated with data collection. To simplify the demonstration of this feature, a development instance is used.

Enable the HealthScanner

The OpenEdge HealthScanner is disabled by default. Use the tcman feature command to enable it.

  1. Create a PAS for OpenEdge development instance in the OpenEdge WRK directory, for example:
    proenv>cd %WRKDIR%
proenv>pasman create -Z dev HealthInst
    Note: The -Z dev option indicates a development security model, rather than a production security configuration.
  2. Change to the bin directory of the instance: 
    proenv>cd instance-name\bin
  3. List the feature=value pairs using the tcman feature command:
    proenv>tcman feature
VersionLoggerListener=off
SecurityListener=off
APRListener=off
PSClifecycle=on
PSCRegistry=on
HealthCheck=off
HTTP=on
HTTPS=on
AJP13=off
Cluster=off
UserDatabase=on
JAASRealm=off
LDAPRealm=off
PASInstrument=off
RemoteHostValve=on
RemoteAddrValve=on
SingleSignOn=on
AccessLog=on
CrawlerSessionManager=on
StuckSessionValve=off
    By default, the feature list indicates that HealthCheck=off, which means that the feature is disabled.
  4. Enable the HealthCheck feature with the following command:
    proenv>tcman feature HealthCheck=on
  5. To verify the change, use TCMAN to poll the HealthCheck value:
    proenv>tcman feature HealthCheck
HealthCheck=on

Turn on data collection

The data collector for the OpenEdge HealthScanner must be enabled in addition to the HealthCheck feature. The settings to enable and configure the data collector for the OpenEdge HealthScanner are located in the instance-name\conf\appserver.properties file.

When the data collector is enabled, it reads the results from the probes which are documented in the health.config file.

To enable data collection for the OpenEdge HealthScanner, perform the following steps:

  1. Enable the collector to collect data from the probes using the tcman config command:
    proenv>tcman config psc.as.health.enabled=true
    Note: To echo back the newly set value, enter the following command:
    proenv>tcman config psc.as.health.enabled
  2. To learn more about the probes that provide data to the OpenEdge HealthScanner, see the health.config file located in the instance-name\conf directory.
  3. Restart the server:
    proenv>tcman pasoestart -restart
  4. Confirm that the HealthScanner is running:
    proenv>tcman env 
proenv>tcman env
catalina home:     C:\Progress\OpenEdge\servers\pasoe
catalina base:     C:\OpenEdge\WRK\HealthInst
catalina tmpdir    C:\OpenEdge\WRK\HealthInst\temp
catalina pid:      C:\OpenEdge\WRK\HealthInst\logs\catalina-HealthInst.pid
java home:         C:\Progress\OpenEdge\jdk
jre home:
manager http port: 8810
manager https port:8811
manager shut port: 8812
manager ajp13 port: 8009
manager health port: 8899

manager URL:       http://localhost:8810/manager
config type:       instance
config alias:      HealthInst
config parent:     C:/Progress/OpenEdge/servers/pasoe
server running:    1
instance tracking: True
instance file:     C:\Progress\OpenEdge\servers\pasoe\conf\instances.windows
server process-id: 28040
window title:      PAS-HealthInst-54629
security model:    developer
service:           false
servicename:
    The line manager health port: 8899 identifies the port for the HealthScanner.

You are ready to Access HealthScanner data, which can be displayed in a variety of formats and in different configurations.