Troubleshooting - Smile CDR Documentation

Troubleshooting Smile CDR

This page contains helpful information about how to troubleshoot steps.

Logging

Smile CDR provides a rich set of logging tools. See the Logging reference documentation for details.

Thread Dumps

In cases where Smile CDR is seemingly hung, slow, unresponsive, etc., it can be useful to capture a Thread Dump, which is a snapshot of what every thread in the Smile CDR process is currently doing.

In some cases it may be helpful to review this yourself (e.g. if you are using Hybrid Providers and are looking for insight into what your Hybrid Provider code is doing) but in most cases it is good to review this with someone from the Smile CDR team.

Method 1: Via the JSON Admin API Note that this method was added in Smile CDR 2019.11.R01.

The JSON Admin API can be used to capture a thread dump on the same process as the API is running.

To capture the thread dump, you should invoke the Metrics - Thread Dump Endpoint. This is done with a URL such as the following: http://localhost:9000/metrics/local/threads

The response will be a text block consisting of the entire thread dump. It should be downloaded as a text file for sharing.

Note that you can also request that the dump be written to the logs by using the parameter writeToLog=true.

Method 2: From the Command Line To take a thread dump from the command line:

$ jps

21361 App
4988 Jps

Copy

In the example above, the process ID for Smile CDR is 21361.

kill -3 21361 > threads.txt

Copy

The command above will capture a thread dump and export it to a file called threads.txt.

kill -3 does not kill the process. It sends a SIGQUIT which the JVM understands to mean 'return a thread dump'. [More information here.](https://docs.oracle.com/en/java/javase/17/troubleshoot/handle-signals-and-exceptions.html#GUID-57C048F6-0D4B-43BD-B27C-06A613435360)

Reviewing a Thread Dump

While we generally recommend contacting Smile CDR support for assistance in reviewing Smile CDR Thread Dumps, we do recommend the excellent free tool available at https://jstack.review for this process as well.

Performance Tuning

Troubleshooting

Operating

Monitoring Basics Externalized Metrics Smile CDR Observability Performance Tuning Troubleshooting