3DSearch Metrics

3DSearch Service Metrics: Health

Applies to checking 3DSearch service health from a load balancer machine, to activate all 3DSearch service health metrics at once.

Activation

Create the keystore, as explained in Starting the Monitoring Agent:
StartMonitoringAgentSvc.sh|.bat [-keystore PATH] -setkey 3DSEARCH_URL
where 3DSEARCH_URL is the 3DSearch service URL you enter via the browser.

Enter the 3DSearch admin username and password in the console when prompted to.
Set the probe:
StartMonitoringAgentSvc.sh|.bat -setProbe fsavail search fedSearchUrl=3DSEARCH_URL fedSearchContext=SECURITY_CONTEXT fedSearchAuthClassName=com.dassault_systemes.i3dx.authentication.casclient.CASClient fedSearchMode=onpremise
where SECURITY_CONTEXT is the security context (credentials) of the user.
Restart the 3DMonitoringAgent service if monitoring by the MonitoringAgentAndProbes media is installed as a service, or start the monitoring agent from the 3DSearch service installation path as follows:
StartMonitoringAgentSvc.sh|.bat [-keystore PATH] -o PATH

This option is only applicable if the monitoring agent has been started from the MonitoringAgentAndProbes media, and not from the 3DSearch media.


Metric Name	Unit	Description
serviceHealthCheck.status	Boolean	Status (OK\|KO) of login health check.
serviceHealthCheck.elapsed	ms	Duration, in ms, of login health check.
Alert Criteria	An alert with highest priority must be raised by the monitoring solution if the `serviceHealthCheck.status` metric is received with a KO status. In this case, the 3DSearch service is not accessible. The associated message may provide a hint about the cause of the failure.