Configure runtimes

Semarchy xDI Analytics connects runtimes to monitor their status, activity and sessions.

Configure a runtime

To add a runtime to Semarchy xDI Analytics, and configure it, follow these steps:

  1. In the Analytics toolbar, go to the user menu.

  2. Select Administration to open the administration editor.

  3. In the Administration editor, select the Runtimes tab.

  4. Click the Add button to start a new runtime configuration.

A configuration panel opens where you can enter the details for the new runtime. Enter the configuration details as described below, and save your changes when you are finished.

ana parameters runtime

Configure standard details

  1. Specify the Name for the runtime

  2. Enter the Host and the Port on which to connect
    The host must include the protocol, such as http://hostname or https://hostname

    Although deprecated, the RMI protocol is still supported for compatibility with legacy Semarchy xDI Runtime versions. Use HTTP instead when possible. However, if you are in a situation where using RMI is necessary, make sure the target Semarchy xDI Runtime supports it and use rmi://hostname or rmis://hostname

  3. Optionally set a User and Password if you have configured authenticated access for this runtime.

  4. Test the connection through the Test Runtime Connection button.

  1. Make sure to configure your network to allow the Analytics server to access the runtime host on its service port (Default: 42200)

If the Runtime is accessed with HTTPS, ensure that the certificate is accepted by the JVM:

  1. If the HTTPS certificate is delivered by a trusted certificate authority, the JVM should accept it without any additional configuration.

  2. If the HTTPS certificate is a self-signed or JVM-unknown certificate, additional configuration is required in the JVM used by the application server hosting Analytics.

    1. Consult the documentation of your application server to find out how to pass additional Java options. The following Java options must be added and modified according to your configuration:

      • -Djavax.net.ssl.trustStore=<keystore_with_selfsigned_certificate_name.jks>

      • -Djavax.net.ssl.trustStorePassword=<Certificate_Password>

      • -Djavax.net.ssl.trustStoreType=<JKS_or_PKCS12>

    2. As an example, with Apache Tomcat, this is known to be done by adding and/or configuring the following line in the setenv file (setenv.bat or setenv.sh depending on the OS):
      set JAVA_OPTS="-Djavax.net.ssl.trustStore=<keystore_with_selfsigned_certificate_name.jks>" "-Djavax.net.ssl.trustStorePassword=<Certificate_Password>" "-Djavax.net.ssl.trustStoreType=<JKS_or_PKCS12>"

Configure the log database

If you want to configure which database to use for logs, select the appropriate option from the Log Database list. You can select from the following options:

  • A database defined in the Log Databases administration tab.

  • The runtime’s built-in configuration (Configuration provided by the Runtime (built-in)).

In general, it is recommended to use a database defined in the Log Databases tab for better manageability and consistency.

When you have set the database, use the Test Log Connection button to test the connection to the database.

  • If your runtime uses a different log database than the default one, make sure to add the corresponding JDBC drivers in the /jdbc subdirectory of the folder defined in the XDI_ANALYTICS_WEBAPP_HOME variable.

Configure display information

  • Select Show in logs selection to have this runtime appear in the profile selector.

  • Select Hide in navigator to hide this runtime from the Navigator view.