3DSpace Metrics

3DSpace Service Metrics: Health

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

Activation

1. Create the keystore, as explained in Starting the Monitoring Agent:

   StartMonitoringAgentSvc.sh|.bat [-keystore PATH] -setkey 3DSPACE_URL

   Enter the 3DSpace admin username and password in the console when prompted to.

2. Set the probe:

   StartMonitoringAgentSvc.sh|.bat -setProbe vpmavail space url=3DSPACE_URL vpmContext=SECURITY_CONTEXT authClassName=com.dassault_systemes.i3dx.authentication.casclient.CASClient

   where SECURITY_CONTEXT is the security context (credentials) of the user.

3. Restart the 3DMonitoringAgent service when MonitoringAgentAndProbes media is installed as a service , or start the monitoring agent from the MonitoringAgentAndProbes (installed without service) media installation path as follows:

   StartMonitoringAgentSvc.sh|.bat [-keystore PATH] -o PATH

where 3DSPACE_URL is the 3DSpace service URL you enter via the browser.

This option is only applicable if the monitoring agent has been started from the MonitoringAgentAndProbes media, and not from the 3DSpace 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 3DSpace service is not accessible. The associated message may provide a hint about the cause of the failure, such as a database issue or all 3DSpace servers being down at the same time.

See Monitoring the 3DEXPERIENCE Platform using Standard Solutions for other 3DSpace metrics like memory and database.

3DSpace Product Metrics: Usage

Product probes have been implemented for the On Premises solution. An XML file, containing Product statistics, may now be generated On Premises.

The generated XML specifies how many:

• root references (VPMReferencesRoots)
• leaf references (VPMReferencesLeaves)
• intermediate references (VPMReferencesIntermediates)
• VPMInstances
• 3D Shapes (VPMRepReferences3DShapes)

exist at a given time in a given server.

One event will be sent for each of these product probes. The information can then be used for monitoring purposes.

This section applies to measuring 3DSpace Product usage from a machine on which 3DSpace is installed, to activate all 3DSpace product usage metrics at once.

Activation

1. Activate the crontab entry to generate product statistics in an XML file.

   To do so:

   • Edit the VPLMJProductStatistics.sh file and set the user and password which will be used to extract product statistics, the path to 3DSpace install path and the path of the output XML file, for example:

     #!/bin/sh
     # script that executes mql>execute program VPLMJProductStatistics; in global tenant
     
     csr=/usr/local/MatrixRMI
     logdir=/mnt
     logfile=VPLMJProductStatistics.log
     
     user=creator
     scripts=$(cd `dirname $0` && pwd)
     password=`cat ${scripts}/pwd.txt`
     
     echo `date` : Starting VPLMJProductStatistics ...      >> $logdir/$logfile
     
     # the output filename is hardcoded in the VPLMJProductStatistics JPO
     # (An environment variable XMLFILEPATH may be used to change the path of the output XML file) 
     outputxml=/tmp/VPMProductStatistics.xml
     
     if [ -f $outputxml ];then
             rm $outputxml
     fi
     
     $csr/scripts/mql -t -c "set context user $user password $password ; execute program VPLMJProductStatistics ; quit ;" >> $logdir/$logfile 2>&1
     RC=$?
     
     echo `date` : VPLMJProductStatistics ended with RC=$RC >> $logdir/$logfile
     echo "" >> $logdir/$logfile

   • Registrer this shell in the crontab.

     For performance reasons, this shell must not be called more than once per day (parts in bold should be customized):

     10 05 * * * /usr/local/MatrixRMI/scripts/VPLMJProductStatistics.sh >> /dev/null 2>&1

2. Set the probe:

   startMonitoringAgent.sh -setProbe vpmProductStats space xmlStatsPath=XML_STATS_PATH

   where XML_STATS_PATH is the path to the XML file generated by the crontab entry to generate product statistics in an XML file.

3. Restart the 3DMonitoringAgent service if monitoring by the MonitoringAgentAndProbes media is installed as a service, or start the monitoring agent from the 3DSpace service installation path as follows:

   startMonitoringAgent.sh -o PATH

Here are the metrics:

Name	Type	Meaning
usage.physicalProducts.nbRoots	Product roots	Number of product roots measured when the VPLMJProductStatistics.sh retry was executed.
usage.physicalProducts.nbLeaves	Product leaves	Number of product leaves measured when the VPLMJProductStatistics.sh retry was executed.
usage.physicalProducts.nbIntermediates	Product intermediates	Number of product intermediates measured when the VPLMJProductStatistics.sh retry was executed. An intermediate is a node of a product assembly which is neither a root nor a leaf.
usage.physicalProducts.nbInstances	Product instances	Number of product instances measured when the VPLMJProductStatistics.sh retry was executed.
usage.3Dshapes.nb3DShapes	Number of 3DShapes	Number of 3DShapes measured when the VPLMJProductStatistics.sh retry was executed.