Skip to content

How to debug

ViktarStarastsenka edited this page Apr 10, 2024 · 2 revisions

If you have any issues occurring in RedisInsight, you can follow the steps below to get more information about the errors and find their root cause.

Connection issues

If you experience connection issues, try these steps.

I. Launch RedisInsight in debug mode

Run the following command to launch RedisInsight in debug mode to investigate connection issues:

  1. Windows OS:

cmd /C “set DEBUG=ioredis* && .\RedisInsight.exe”

  1. MacOS (from the /Applications folder):

DEBUG=ioredis* open RedisInsight.app

  1. Linux OS:

DEBUG=ioredis* redisinsight

II. Investigate logs

Open logs to investigate errors. Usually, they are located here:

users/local_user/.redisinsight

Other issues

I. To debug issues, other than connectivity ones:

  1. Windows OS:

cmd /C “set DEBUG=* && .\RedisInsight.exe”

  1. MacOS (from the /Applications folder):

DEBUG=* open RedisInsight.app

  1. Linux OS:

DEBUG=* redisinsight

II. Get detailed RedisInsight logs

  1. Windows OS:

cmd /C “set STDOUT_LOGGER=true && set LOG_LEVEL=debug && set LOGGER_OMIT_DATA=false && .\RedisInsight.exe”

  1. MacOS (from the /Applications folder):

LOG_LEVEL=debug LOGGER_OMIT_DATA=false open RedisInsight.app

  1. Linux OS:

LOG_LEVEL=debug LOGGER_OMIT_DATA=false redisinsight

NOTE: if you use LOGGER_OMIT_DATA=false, logs may contain sensitive data.

III. To log everything

  1. Windows OS:

cmd /C “set STDOUT_LOGGER=true && set LOG_LEVEL=debug && set LOGGER_OMIT_DATA=false && set DEBUG=* && .\RedisInsight.exe”

  1. MacOS (from the /Applications folder):

LOG_LEVEL=debug LOGGER_OMIT_DATA=false DEBUG=* open RedisInsight.app

  1. Linux OS:

LOG_LEVEL=debug LOGGER_OMIT_DATA=false DEBUG=* redisinsight

NOTE: if you use LOGGER_OMIT_DATA=false or DEBUG=*, logs may contain sensitive data.