How To Debug Working Docker Containers
Picture by Editor | Midjourney & Canva
Containers can generally behave unexpectedly attributable to configuration points, software bugs, or useful resource constraints. On this tutorial, we’ll go over the totally different strategies to debug operating containers by taking the instance of a Postgres container.
Conditions
To comply with alongside to this tutorial:
- You must have Docker put in in your growth setting. Get Docker if you happen to haven’t already.
- You ought to be comfy with how Docker works and fundamental instructions to tug photographs, begin, cease, and handle containers.
Pull and Begin a PostgreSQL Container
First, let’s pull the newest PostgreSQL picture from DockerHub and begin a container. Right here, we pull postgres:16 utilizing the docker pull
command:
$ docker pull postgres:16
As soon as the pull is full, you can begin the postgres container with the next docker run command. Be aware that the POSTGRES_PASSWORD
is the required setting variable you might want to begin the container:
$ docker run --name my_postgres -e POSTGRES_PASSWORD=my_postgres_password -d postgres
This command begins a brand new container named my_postgres
with PostgreSQL operating inside it. You possibly can confirm it by operating the docker ps
command:
Which outputs:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
5cb6fabbbc8b postgres:16 "docker-entrypoint.s…" 18 seconds in the past Up 9 seconds 5432/tcp my_postgres
1. Examine the Container
You need to use the docker examine
command to retrieve detailed details about a container. This may be helpful for checking the container’s configuration, community settings, and state:
$ docker examine my_postgres
This command outputs a JSON object with all the small print concerning the container. You need to use instruments like jq to parse and extract particular info of curiosity from this output.
Truncated output of docker examine my_postgres
2. View Container Logs
The docker logs
command fetches the logs from a operating container. That is helpful for troubleshooting points associated to the appliance operating contained in the container.
$ docker logs my_postgres
Truncated output of docker logs my_postgres
3. Execute Instructions Contained in the Container
Typically it’s useful to get into the container and run a bunch of diagnostic instructions. You are able to do this with the docker exec
command that means that you can run instructions inside a operating container. That is helpful for inspecting the container’s filesystem, checking setting variables, or the like.
Right here’s how one can begin an interactive shell session contained in the operating container:
$ docker exec -it my_postgres /bin/bash
This command opens an interactive bash shell contained in the my_postgres
container. So you possibly can run instructions from inside the container.
4. Examine Working Processes
The docker high
command reveals the operating processes inside a container. This might help you establish if any processes are consuming extra assets than anticipated or if there are any sudden processes operating:
UID PID PPID C STIME TTY TIME CMD
ollama 8116 8096 0 09:41 ? 00:00:00 postgres
ollama 8196 8116 0 09:41 ? 00:00:00 postgres: checkpointer
ollama 8197 8116 0 09:41 ? 00:00:00 postgres: background author
ollama 8199 8116 0 09:41 ? 00:00:00 postgres: walwriter
ollama 8200 8116 0 09:41 ? 00:00:00 postgres: autovacuum launcher
ollama 8201 8116 0 09:41 ? 00:00:00 postgres: logical replication launcher
5. Connect to the Container
The docker connect
command means that you can connect your terminal to a operating container’s most important course of. This may be helpful for debugging interactive processes:
$ docker connect my_postgres
Be aware that attaching to a container is totally different from docker exec
because it connects you to the container’s most important course of and streams its normal output and normal error to your terminal.
6. View Useful resource Utilization
With the docker stats
command, you may get real-time statistics on container useful resource utilization together with CPU, reminiscence, and community. Which is useful if you wish to analyze efficiency points:
$ docker stats my_postgres
This is a pattern output:
CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS
5cb6fabbbc8b my_postgres 0.03% 34.63MiB / 3.617GiB 0.94% 10.6kB / 0B 38.4MB / 53.1MB 6
CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS
5cb6fabbbc8b my_postgres 0.03% 34.63MiB / 3.617GiB 0.94% 10.6kB / 0B 38.4MB / 53.1MB 6
CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS
5cb6fabbbc8b my_postgres 0.03% 34.63MiB / 3.617GiB 0.94% 10.6kB / 0B 38.4MB / 53.1MB 6
...
Debugging Docker containers includes inspecting container config, viewing logs, executing instructions contained in the container, and monitoring useful resource utilization. With these methods, you possibly can successfully troubleshoot and resolve points together with your containerized purposes. Comfortable debugging!
Further Sources
Take a look at the next assets if you happen to’d prefer to discover additional:
Bala Priya C is a developer and technical author from India. She likes working on the intersection of math, programming, information science, and content material creation. Her areas of curiosity and experience embrace DevOps, information science, and pure language processing. She enjoys studying, writing, coding, and occasional! At the moment, she’s engaged on studying and sharing her information with the developer neighborhood by authoring tutorials, how-to guides, opinion items, and extra. Bala additionally creates participating useful resource overviews and coding tutorials.