Instance setup

Simple diagnosis tool

Since version 0.4.18, our agent provides a command line tool to check most common setup issues. This tool currently works with Linux, but does not work on Windows.

java -jar sqreen.jar <command>

Where <command> is :

Command Description
version show agent version
status display status for all running JVMs
status <pid> display status for JVM whose PID is <pid>
log-archive create an archive of all running Sqreen agents logs
debug-log-archive <d> same as log-archive plus toggles log_level=DEBUG log for <d> seconds

JVM parameters

Ensure the -javaagent parameter is passed to the JVM prior the -jar parameter.

A simple way to do this is to look at the parameters provided to the Java process:

ps -ef | grep java

The resulting line should include the -javaagent: parameter with path to the Sqreen agent JAR. Else, the application startup file was not setup as expected.

Adding or changing this parameter requires to restart the JVM to take effect.

Sqreen agent log

By default, Sqreen agent logs to /tmp/sqreen.log.

The log file should be created when the agent starts, if not:

  • check configured log location, see configuration.
  • check that the JVM process has the proper rights to write to it.

You can change the log_level parameter set by default to INFO for more details.

Providing agent log with log_level=DEBUG when reaching us for support is recommended to ease troubleshooting.

-Dsqreen.log_level='DEBUG' -Dsqreen.log_location=/tmp/sqreen.log

Application server logs

When using an application server, check their logs:

  • look for any unexpected error during startup or while executing requests.
  • some of them report JVM arguments, thus you should have the -javaagent parameter

Agent unable to communicate with Sqreen

Some application containers like Websphere require advanced configuration to be able to communicate with our servers.

If you see error messages about SSL/TLS and encryption in agent logs, this is the most probable cause.

Please refer to advanced configuration for details.

No monitored HTTP requests on Sqreen

Check application traffic

Since Sqreen passively monitors your application, you need to have some traffic on your application.

Sqreen does not show anything under the 'DB requests' field

  • Is your database supported?
  • Is there any data protection plugin enabled?

Contact support if you answered 'yes' to any of the above questions.

Contacting support

When contacting support, please provide the following items for faster diagnosis:

  • type and version of application server (if any)
  • type and version of database server (if any)
  • Sqreen agent log with log_level=DEBUG (see Simple diagnosis tool above)
  • list of your application dependencies from your pom.xml, build.gradle or build.xml
  • output of command java -jar sqreen.jar status