Troubleshooting Tools and Resources

Enabling Glowroot on PaaS

Liferay DXP 2023.Q4+/Portal GA100+

Glowroot is included with Liferay in the /opt/liferay/glowroot folder.

Glowroot stores profiling and transaction data on the filesystem. On Liferay PaaS, this data must be persisted using a configured volume.

Warning

Do not store Glowroot data in container-local paths (for example, /opt/liferay/glowroot) or in /mnt/persistent-storage. Containers on Liferay PaaS use ephemeral file systems that can be regenerated at any time.

Store Glowroot data only in a configured persistent file storage volume mounted into the container so the data persists across container life cycles.

Before enabling Glowroot with persistence, follow the instructions in Configuring Persistent File Storage Volumes to configure a persistent file storage volume for the Liferay service.

Enabling Glowroot

If you’re running Liferay in a clustered environment, enable Glowroot with JVM options:

"env": {
   "LIFERAY_JVM_OPTS": "-javaagent:/opt/liferay/glowroot/glowroot.jar -Dglowroot.enabled=true"
}

If your Liferay instance is not clustered and you want to persist Glowroot data, configure Glowroot to use the mounted volume.

  1. Mount the configured volume to a fixed path in the Liferay container (for example, /opt/glowroot).

    "volumes": {
       "glowroot": "/opt/glowroot"
    }
    
  2. Enable Glowroot and point it to the mounted directory:

    "env": {
       "LIFERAY_JVM_OPTS": "-javaagent:/opt/liferay/glowroot/glowroot.jar -Dglowroot.data.dir=/opt/glowroot -Dglowroot.enabled=true"
    }
    

Accessing Glowroot

  1. Visit the site and log in.

  2. Append /o/glowroot to the end of the site’s URL. For example, if the site’s URL is https://webserver-acme-dev.lfr.cloud, navigate to https://webserver-acme-dev.lfr.cloud/o/glowroot.

  3. Create an Administrator user with a username and secure password. Then delete the anonymous user.