Overview

This guide provides solutions for common issues you may encounter when setting up, developing, or deploying the Definable backend.

When troubleshooting issues with the Definable backend, it’s helpful to categorize the problem:

Quick Solutions for Common Issues

Problems with setting up the development environment

Database connection, migration, and query problems

Common API errors and their solutions

Problems with JWT, RBAC, and user authentication

When troubleshooting, follow this general process:

Identify the symptoms - What exactly is happening? What error messages are you seeing?
Check the logs - Application logs, database logs, and error messages often contain valuable information
Isolate the problem - Is it a configuration issue, code bug, or infrastructure problem?
Check for recent changes - Did the issue appear after a recent code change or environment modification?
Test simple solutions first - Often, restarting services or clearing caches can resolve issues
Consult documentation - Check this troubleshooting guide for common solutions

The Definable backend uses the loguru library for logging. To enable more detailed logs:

# In your local development environment
from loguru import logger
logger.add("debug.log", level="DEBUG")

If you’re unable to resolve an issue using this documentation:

Check for similar issues in the GitHub repository
Contact the development team through the appropriate channels
Provide detailed information about the issue, including:
- Error messages
- Steps to reproduce
- Environment details
- Recent changes to your setup

For detailed solutions to specific problems, refer to these guides: