Troubleshooting Azure SQL Edge deployments

This article provides information about possible errors seen when deploying and using Azure SQL Edge containers, and provides troubleshooting techniques to help resolve these issues.

Azure SQL Edge supports two deployment models:

Troubleshooting IoT Edge device and deployments

If you get error while deploying SQL Edge through Azure IoT Edge, make sure that the iotedge service is properly configured and running. The following documents can be helpful when troubleshooting issues related to Azure IoT Edge:

Docker command errors

If you get errors for any docker commands, make sure that the docker service is running, and try to run with elevated permissions.

For example, on Linux, you might get the following error when running docker commands:

Cannot connect to the Docker daemon. Is the docker daemon running on this host?

If you get this error on Linux, try running the same commands prefaced with sudo. If that fails, verify the docker service is running, and start it if necessary.

sudo systemctl status docker
sudo systemctl start docker

On Windows, verify that you are launching PowerShell or your command-prompt as an Administrator.

Azure SQL Edge container startup errors

If the SQL Edge container fails to run, try the following tests:

  • If you are using Azure IoT Edge, make sure that the module images were downloaded successfully and that the environment variables and container create options are correctly specified in the module manifest.

  • If you are using docker or kubernetes based deployment, make sure that the docker run command is correctly formed. For more information, refer Deploy Azure SQL Edge with Docker and Deploy an Azure SQL Edge container in Kubernetes.

  • If you get an error such as failed to create endpoint CONTAINER_NAME on network bridge. Error starting proxy: listen tcp 0.0.0.0:1433 bind: address already in use., you are attempting to map the container port 1433 to a port that is already in use. This can happen if you're running SQL Edge locally on the host machine. It can also happen if you start two SQL Edge containers and try to map them both to the same host port. If this happens, use the -p parameter to map the container port 1433 to a different host port. For example:

    sudo docker run --cap-add SYS_PTRACE -e 'ACCEPT_EULA=1' -e 'MSSQL_SA_PASSWORD=yourStrong(!)Password' -p 1433:1433 --name azuresqledge -d mcr.microsoft.com/azure-sql-edge-developer.
    
  • If you get an error such as Got permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Get http://%2Fvar%2Frun%2Fdocker.sock/v1.30tdout=1&tail=all: dial unix /var/run/docker.sock: connect: permission denied when trying to start a container, then add your user to the docker group in Ubuntu. Then logout and login again as this change will affect new sessions.

      usermod -aG docker $USER
    
  • Check to see if there are any error messages from container.

    docker logs e69e056c702d
    
  • If you are using any container management software, make sure it supports container processes running as root. The sqlservr process in the container runs as root.

  • By default Azure SQL Edge containers run as a non-root user named mssql. If you are using mount points or data volumes to persist data, ensure that the mssql user has appropriate permissions on the volume. For more information, see Run as non-root user and Persist Data.

  • If your SQL Edge Docker container exits immediately after starting, check your docker logs. If you are using PowerShell on Windows with the docker run command, use double quotes instead of single quotes. With PowerShell Core, use single quotes.

  • Review the SQL Edge error logs.

SQL Edge connection failures

If you can't connect to the SQL Edge instance running in your container, try the following tests:

  • Make sure that your SQL Edge container is running by looking at the STATUS column of the docker ps -a output. If not, use docker start <Container ID> to start it.

  • If you mapped to a non-default host port (not 1433), make sure you are specifying the port in your connection string. You can see your port mapping in the PORTS column of the docker ps -a output. For more information on connecting to Azure SQL Edge, refer Connect and query Azure SQL Edge

  • If you had previously deployed SQL Edge with mapped data volume or data volume container, and are now using the existing mapped data volume or data volume container, SQL Edge ignores the value of MSSQL_SA_PASSWORD environment variable. Instead, the previously configured SA user password is used. This happens because SQL Edge reuses the existing master databases files in the mapped volume or data volume container. If you run into this issue, you can use the following options:

    • Connect using the previously used password, if it's still available.
    • Configure SQL Edge to use a different mapped volume or data volume container.
    • Remove the existing master database files (master.mdf and mastlog.mdf) from the mapped volume or data volume container.
  • Review the SQL Edge error logs.

SQL Edge setup and error logs

By default, SQL Edge error logs are present in the /var/opt/mssql/log directory within the container and can be accessed using any of the following ways:

  • If you mounted a host directory to /var/opt/mssql when you created your container, you can instead look in the log subdirectory on the mapped path on the host.

  • By using an interactive command-prompt to connect to the container. If the container is not running, first start the container. Then use an interactive command-prompt to inspect the logs. You can get the container ID by running the command docker ps.

    docker start <ContainerID>
    docker exec -it <ContainerID> "/bin/bash"
    

    From the bash session inside your container, run the following commands:

    cd /var/opt/mssql/log
    cat errorlog
    
  • If the SQL Edge container is up and running and you are able to connect to the instance using client tools, then you can use the stored procedure sp_readerrorlog to read the contents of the SQL Edge error log.

Execute commands in a container

If you have a running container, you can execute commands within the container from a host terminal.

To get the container ID run:

docker ps -a

To start a bash terminal in the container run:

docker exec -it <Container ID> /bin/bash

Now you can run commands as though you are running them at the terminal inside the container. When finished, type exit. This exits in the interactive command session, but your container continues to run.

Enabling verbose logging

If the default log level for the streaming engine does not provide enough information, debug logging for the streaming engine can be enabled in SQL Edge. To enable debug logging add the RuntimeLogLevel=debug environment variable to your SQL Edge deployment. After enabling debug logging, attempt to reproduce the problem and check the logs for any relevant messages or exceptions.

Note

The Verbose Logging option should only be used for troubleshooting and not for regular production workload.

Next steps