Monitoring Spotfire Service for Python using JMX

The Spotfire Service for Python supports JMX monitoring integration. JMX monitoring is turned off by default.

1. Stop the Spotfire Service for Python.
2. Export and edit the custom.properties, setting the following properties.

   jmx.rmi.username: username
   jmx.rmi.password: password
   jmx.rmi.host: <IP address of the Node Manager running Python service>
   jmx.rmi.port: 1099
   jmx.active: TRUE

   See Configuring Spotfire Service for Python for detailed instructions.
3. Start the Spotfire Service for Python.
4. Check the INFO logs for the connection string.
   If the setup and connection are successful, a JMX connection string is printed to logs at the INFO level.

   2018-06-08T21:03:11,520 | INFO  | [main] c.s.s.t.ServiceConfig: Service configured JMX Connection string: service:jmx:rmi://10.10.100.60:1099/jndi/rmi://10.10.100.60:1099/jmxrmi

   • If jmx.rmi.username, jmx.rmi.password, or jmx.rmi.host are blank, then a log message is printed indicating that the property is blank, and that the JMX connection is not created.
   • If jmx.rmi.port is blank or undefined, then the port value defaults to 1099.
   • If the jmx.rmi.host is configured incorrectly, the connection times out and the service fails to start. An error message is printed to the admin UI and the logs.

   A successful client connection is printed to logs at the DEBUG level. An unsuccessful client connection attempt due to bad or missing username or password is printed at the ERROR level.

   Note: If you are connecting to a remote host, the port must be opened in the firewall to allow the connection.
5. Open JConsole, and in the remote process field, provide the JMX connection string provided by the logs as shown.

   service:jmx:rmi://10.10.100.60:1099/jndi/rmi://10.10.100.60:1099/jmxrmi

6. Provide the user name and password that you set in custom.properties.
   Note: If a message is displayed indicating the connection could not be made using SSL. Would you like to try without SSL?, then click Insecure connection.
   JConsole should now display information from the service.
7. To view metrics specific to the Spotfire Service for Python, click the tab MBeans.
8. In the left panel, expend the group labeled metrics.
   Metrics are listed, including many JVM metrics. Some of the metrics specific for Spotfire Service for Python are as follows.

   serviceQueueCurrentSize - total number of engines currently waiting in the queue
   serviceQueueEnginesDestroyed - total number of engines destroyed after successful use
   serviceQueueEnginesFailed - total number of engines that failed on startup due to configuration, environmental, or other exceptions
   serviceQueueEnginesInUse - total number of engines currently executing
   serviceQueueEnginesStarted - total number of successful engines started
   serviceQueueEnginesStarting - total number of engines currently initializing
   serviceQueueIdealSize - the ideal queue size as defined by engine.queue.size in custom.properties
   serviceQueueLastPortSelected - the last port chosen for engine creation
   serviceUsageBytesDownloaded - total bytes downloaded through the service
   serviceUsageBytesUploaded - total bytes uploaded through the service
   serviceUsageCapacity - the current capacity of the service as a percentage: current session over maximum allowed concurrent sessions
   serviceUsageJobs - total number of jobs the service has created and run
   serviceUsageSessions - total number of sessions the service has created
   serviceUsageMillisInUse - total time spent executing successful jobs, in milliseconds