{"id":126333,"date":"2024-07-21T19:56:59","date_gmt":"2024-07-21T19:56:59","guid":{"rendered":"https:\/\/linuxiac.com\/?p=126333"},"modified":"2024-07-22T14:38:38","modified_gmt":"2024-07-22T14:38:38","slug":"reducing-docker-logs-file-size","status":"publish","type":"post","link":"https:\/\/linuxiac.com\/reducing-docker-logs-file-size\/","title":{"rendered":"Reducing Docker Logs Size: A Practical Guide to Log Management"},"content":{"rendered":"\n

Docker is an excellent tool for quickly setting up and running our needed applications. However, we often overlook a crucial aspect of its operation: the logs it produces.<\/p>\n\n\n\n

Why do I say that? Recently, I discovered that one of my servers was running out of free disk space, almost hitting a critical low. Upon investigating, I found that a Docker container had accumulated a 14 GB log file over just a year.<\/p>\n\n\n\n

So that you don’t fall into a similar situation, this guide will help you learn how to check the sizes of all Docker log files quickly, shrink them if needed, and set up Docker to prevent them from getting too big in the future.<\/p>\n\n\n\n

Docker containers are stateless, meaning their logs are deleted when the container is recreated. But many overlook a crucial detail here. So, before we proceed, let’s clarify an important point.<\/p>\n\n\n\n

Restart vs. Recreate Docker Container<\/h2>\n\n\n\n

Let’s return to the case above. Over the past year, the server has been restarted multiple times, meaning that Docker containers have also been stopped and started. However, their log files have persisted and continued to grow.<\/p>\n\n\n\n

The answer to why this happened is that we are talking about restarting here and not recreating the containers. When the server is rebooted, the Docker daemon gracefully shuts down the running containers, and after boot, it starts them automatically if they’re set to do so.<\/p>\n\n\n\n

Similarly, the behavior is the same when manually restarting the Docker service using the “systemctl restart docker” command. It’s important to understand that Docker logs are only reset when the Docker container is deleted and recreated. Simply stopping and starting the container does not reset the logs.<\/strong><\/p>\n\n\n\n

Having cleared that up, let’s get to the meat of this guide and learn how to quickly check how much space Docker container logs use on our system.<\/p>\n\n\n\n

Checking Docker Log Sizes<\/h2>\n\n\n\n

Docker logs are typically saved (if you have not explicitly changed Docker\u2019s default data directory<\/a>) in the following location on the host machine:<\/p>\n\n\n

\/var\/lib\/docker\/containers\/<container-id<\/span>><\/span>\/<container-id<\/span>><\/span>-json.log<\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
Each Docker container has its directory under “\/var\/lib\/docker\/containers\/<\/em>.” Within each container’s directory, you’ll find a file ending in “-json.log<\/em>,” which contains the logs for that specific container.<\/p>\n\n\n\n
These files are structured in JSON format by default and capture the container’s standard output (stdout) and standard error (stderr) streams.<\/p>\n\n\n\n
find \/var\/lib\/docker\/containers\/ -name \"*json.log\"<\/span> | xargs du -h | sort -hr<\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
\"Find<\/a>
Find out the size of all Docker container logs.<\/figcaption><\/figure>\n\n\n\n
Great, now we have all the log file sizes from our Docker containers. But how do we match these IDs to the actual names of the containers to identify which one produced each log file? Here’s how.<\/p>\n\n\n\n
Find Docker\u2019s Container Name by Its ID<\/h2>\n\n\n\n
Let’s say we want to identify the Docker container responsible for creating the biggest log file listed earlier, which is 5.9M in size. We’ll use its ID, which is “d2e9228f92b66ac09fa35dcab36abba2eb4a7f46baa1d03b65d71ed8d42de977<\/em>.”<\/p>\n\n\n\n
\"Find<\/a><\/figure>\n\n\n\n
The command we need is:<\/p>\n\n\n
docker inspect --format='{{.Name}}'<\/span> <container_id><\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
So, we take the string containing the container ID and put it into the given command.<\/p>\n\n\n
docker inspect --format='{{.Name}}'<\/span> d2e9228f92b66ac09fa35dcab36abba2eb4a7f46baa1d03b65d71ed8d42de977<\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
And just like that, the magic happens. <\/p>\n\n\n\n
\"Find<\/a>
Find Docker\u2019s container name by Its ID.<\/figcaption><\/figure>\n\n\n\n
We’ve confirmed that the Docker container responsible for the log file is named “php-fpm-valente<\/em>” in our case.<\/p>\n\n\n\n
To double-check that this is the correct container that produced the log file, you can verify this by using the docker inspect <container_name><\/code> command to get more details about it and confirm that it’s the source of the log file. In our case, it would look like this:<\/p>\n\n\n
docker inspect php-fpm-valente<\/code><\/span><\/pre>\n\n\n
\"Get<\/a>
Get detailed information about the container.<\/figcaption><\/figure>\n\n\n\n
Or use the command below to get only the path information to the log file.<\/p>\n\n\n
docker inspect --format='{{.LogPath}}'<\/span> <container_name><\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
\"Get<\/a>
Get the full path to the log file of a specific Docker container.<\/figcaption><\/figure>\n\n\n\n
Now that we have all the data we need, let me show you how to clear the contents of the corresponding log file to free up disk space.<\/p>\n\n\n\n
Cleaning Docker Container Logs<\/h2>\n\n\n\n
You can use the truncate<\/code> command to clear all the contents of an individual log file. Just provide the full path to the log file you want to clear as a parameter. For example:<\/p>\n\n\n
truncate -s 0<\/span> \/var<\/span>\/lib\/docker\/containers\/d2e9228f92b66ac09fa35dcab36abba2eb4a7f46baa1d03b65d71ed8d42de977\/d2e9228f92b66ac09fa35dcab36abba2eb4a7f46baa1d03b65d71ed8d42de977-json.log<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\"Clearing<\/a>
Clearing all the contents of a single Docker log file.<\/figcaption><\/figure>\n\n\n\n
If you choose a more aggressive approach, you can clear all Docker log files with just one command. But be sure you understand what you’re doing before you run the command below.<\/p>\n\n\n
truncate -s 0 \/var\/lib\/docker\/containers\/*\/*-json.log<\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
Setting Up Docker Log Size Limits<\/h2>\n\n\n\n
The approach described above offers a temporary fix for managing large Docker log files and freeing up disk space. However, it requires regular use of certain commands, which might be inconvenient.<\/p>\n\n\n\n
A way better and more permanent solution would be to limit the maximum size of Docker log files. Once this size is reached, the Docker daemon will automatically rotate those log files and archive them following naming conventions such as “<container_id>-json.log.1<\/em>,” “<container_id>-json.log.2<\/em>,” etc., depending on the options shown below.<\/p>\n\n\n\n
This guarantees that the log files do not grow uncontrollably. Here’s how to do it.<\/p>\n\n\n\n
To apply log rotation settings globally to all containers run by the Docker daemon, you can edit the Docker daemon configuration file, typically located at “\/etc\/docker\/daemon.json<\/em>.” If the file does not exist, you can create it by executing a command similar to:<\/p>\n\n\n
sudo nano \/etc\/docker\/daemon.json<\/code><\/span><\/pre>\n\n\n

Then, paste the following content into the file, save it and exit:<\/p>\n\n\n
{\n  \"log-driver\"<\/span>: \"json-file\"<\/span>,\n  \"log-opts\"<\/span>: {\n    \"max-size\"<\/span>: \"10m\"<\/span>,\n    \"max-file\"<\/span>: \"3\"<\/span>\n  }\n}<\/code><\/span>Code language:<\/span> JSON \/ JSON with Comments<\/span> (<\/span>json<\/span>)<\/span><\/small><\/pre>\n\n\n
Okay, let me explain what this does. In short, it sets the log driver to “json-file<\/em>,” setting the maximum allowed size of a single Docker log file to 10 megabytes and allowing up to 3 versions of the file to be archived.<\/p>\n\n\n\n
Next, to apply the changes, simply restart the Docker service:<\/p>\n\n\n
sudo systemctl restart docker<\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
It’s important to remember that these changes will only affect newly created Docker containers, not the ones already running<\/strong>. To apply the changes to existing ones, you must first delete them and then create them again. Here’s how you can do it.<\/p>\n\n\n\n
If you started the containers using a standard Docker command, use this to stop and then remove a container in one command:<\/p>\n\n\n
docker rm -f <container_id_or_name><\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
This is a handy command to stop and remove a container immediately. However, using “-f<\/em>” might be risky as it does not allow a clean shutdown of applications running in the container. Then just run it again like you did before.<\/p>\n\n\n\n
If you’re using Docker Compose, just navigate to the folder with the “docker-compose.yml<\/em>” file and run the following command:<\/p>\n\n\n
docker compose down<\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
It stops and removes all the resources defined in the file. Then, rerun the deployment:<\/p>\n\n\n
docker compose up -d<\/code><\/span>Code language:<\/span> Bash<\/span> (<\/span>bash<\/span>)<\/span><\/small><\/pre>\n\n\n
If you look at the container details again, you should see that the data you previously entered in the Docker “daemon.json<\/em>” file has been applied to the container.<\/p>\n\n\n
docker inspect <container_name<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
\"Get<\/a>
Get detailed information about the container.<\/figcaption><\/figure>\n\n\n\n
Conclusion<\/h2>\n\n\n\n
Managing Docker log sizes is essential to maintaining an efficient and sustainable server environment.<\/p>\n\n\n\n
This guide provides a strategy for managing the size of Docker log files and ensuring that logs do not accumulate uncontrollably using Docker’s log rotation and cleanup capabilities.<\/p>\n\n\n\n
Ultimately, applying these practices allows for better resource management and operational efficiency in a Dockerized environment.<\/p>\n\n\n\n
Refer to the official documentation<\/a> for more detailed information on configuring Docker using the \u201cdaemon.json<\/em>\u201d file. We also recommend checking out our guide, especially dedicated to Docker log files<\/a>.<\/p>\n\n\n\n
Thanks for using our guide! Feel free to share your thoughts in the comments section below.<\/p>\n","protected":false},"excerpt":{"rendered":"
Struggling with big Docker logs? Our guide shows you how to find, reduce, and manage them to save disk space effectively.<\/p>\n","protected":false},"author":10,"featured_media":126336,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8,4417],"tags":[1439,4203],"class_list":["post-126333","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-tips","category-linux-knowledge","tag-docker","tag-logs"],"blocksy_meta":[],"_links":{"self":[{"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/posts\/126333","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/users\/10"}],"replies":[{"embeddable":true,"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/comments?post=126333"}],"version-history":[{"count":0,"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/posts\/126333\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/media\/126336"}],"wp:attachment":[{"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/media?parent=126333"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/categories?post=126333"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/linuxiac.com\/wp-json\/wp\/v2\/tags?post=126333"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
To find out the size of all Docker container logs sorted from largest to smallest, you can use the following find<\/code> command<\/a>:<\/p>\n\n\n