healthMonitor parameter

Use the health monitor parameter to monitor and manage the status of the application, agent, integration servers that are registered with the system.

  • If a registered server is not reachable, the health monitor takes care of updating the status to terminated so that the cache propagation overhead is minimized.
  • Used for healthMonitor service configuration.
  • It can use serverProfile and serverProperties by referring group name.
  • This configuration is optional if health monitor is not required. However, it is recommended to run health monitor because of the advantages listed above.
The following .yaml snippet is a sample schema of healthMonitor:
 healthMonitor:
    replicaCount: 1
    # affinityAndTolerations: ""
    # podLabels: {}
    # podAnnotations: {}
    # profile: balanced
    # property:
    #   customerOverrides: ""
    #   envVars: ""
    #   jvmArgs: ""
    # upgradeStrategy: ""
    # image: 
    #   name: ""
    #   tag: "" 
The following table explains the attributes applicable for the healthMonitor parameter of OMEnvironment.
Property Default value Value type Required Description
replicaCount   integer Yes Specify the number of server instances to be deployed. Available options are 0 and 1.
affinityAndTolerations   string No Use the name of the affinityAndTolerations from attribute affinityAndTolerations[].name to be used by the server.
image.name   string No Name of the image if different than the relevant OMEnvironment:spec.image.oms.(app/agent)DefaultName.
image.tag   string No Specify the tag of the image. It takes precedence over OMEnvironment:spec.image.oms.tag.
property.customerOverrides   string No Use the name of customerOverrides from attribute serverProperties.customerOverrides[].groupName or serverProperties.customerOverrides[].derivatives[].groupName.
property.envVars   string No Use the name of envVars from attribute serverProperties.envVars[].groupName or serverProperties.envVars[].derivatives[].groupName.
property.jvmArgs   string No Use the name of jvmArgs from attribute serverProperties.jvmArgs[].groupName or serverProperties.jvmArgs[].derivatives[].groupName.
profile balanced string No Use the name of the profile from attribute serverProfiles[].name to be used by the server.
podAnnotations   object No Specify annotations for pod as key-value pair.
podLabels   object No Specify labels for pod as key-value pair. These pod labels are also copied to deployments.
upgradeStrategy   string No Specify the deployment strategy to be used for upgrading the healthMonitor deployments. Available options are RollingUpdate and Recreate.
Note: If the key in the podLabels or podAnnotations is the same as defined in common.pod.podLabels/podAnnotations, then it overwrites the key defined in common.