Portainer Templates logo

Portainer Templates

Docker Container Stats Docker Container Stats

Stack

Docker

Docker Container Stats is a web interface for viewing historical and current statistics per docker container (cpu, mem, net i/o, block i/o) - in a docker container.

Image details

Pulls: 671k
Architecture: amd64, arm64
Image size: 172 MB
User: virtualzone
Created: Apr 19, 2020
Updated: 2 years ago
Status: active

Source details

Repo: virtualzone/docker-container-stats
Stars: 171
Forks: 25
Language: JavaScript
Updated: 2 years ago

Configuration

Type
Compose
Platform
linux
Image
virtualzone/docker-container-stats
Ports
8383:8080
Volumes
/var/run/docker.sock : /var/run/docker.sock/opt/docker-stats/db : /portainer/Files/AppData/Config/docker-stats/db
Env vars
STATS_UPDATE_INTERVAL=10
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Docker Container Stats

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Docker Container Stats, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  stats:
    image: virtualzone/docker-container-stats
    container_name: docker-stats
    ports:
      - 8383:8080
    environment:
      STATS_UPDATE_INTERVAL: 10
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /portainer/Files/AppData/Config/docker-stats/db:/opt/docker-stats/db

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/docker-container-stats.yml up -d

More install options in our documentation, or see virtualzone/docker-container-stats for app-specific guidance.

Docker Container Stats

A web interface for viewing historical and current statistics per docker container (cpu, mem, net i/o, block i/o) - in a docker container.
Pull and run daemonized: 
docker pull virtualzone/docker-container-stats
docker run \
        -d \
        -p 8080:8080 \
        --volume=/var/run/docker.sock:/var/run/docker.sock:ro \
        --volume=/home/docker/storage/stats/db:/opt/docker-stats/db \
        --name stats \
        -e STATS_UPDATE_INTERVAL=10 \
        virtualzone/docker-container-stats

Docker-Compose:
version: '3.6'
services:
  stats:
    image: virtualzone/docker-container-stats
    container_name: 'stats'
    ports:
      - '8080:8080'
    environment:
      STATS_UPDATE_INTERVAL: 10
    volumes:
      - '/var/run/docker.sock:/var/run/docker.sock:ro'
      - '/home/docker/storage/stats/db:/opt/docker-stats/db'

To view your stats, open a web browser and visit http://localhost:8080 (replace localhost with your docker host's hostname or ip address).
Mounting the volume /var/run/docker.sock (read-only) is required so that the docker container can retrieve the statistics for the containers.
Mounting the volume /opt/docker-stats/db is optional. You can use it if you want to persist the SQLite database.
We strongly recommend not making your stats available online. To password protect your statistics, you can use a frontend web server/proxy (Apache, nginx, ...).

Screenshots

All containers' memory usage
All containers' inbound network traffic
Selected container's latest statistics

Serve Docker Container Stats on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying docker-container-stats.example.com to http://stats:8080

Add this to your Caddyfile

docker-container-stats.example.com {
	reverse_proxy http://stats:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8383 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8383
  • Stop the other service, or pick a different host port. In 8383:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8383. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, stats can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8383

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/docker-stats/db

Can't reach the Docker socket

stats talks to Docker through /var/run/docker.sock. If the logs show "permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.

  • Check the socket exists on the host: ls -l /var/run/docker.sock
  • Run the container as root, or add the docker group's id to the container with group_add.

Image won't pull

Test the pull directly on the host: docker pull virtualzone/docker-container-stats

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Docker Container Stats is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Docker Container Stats needs bundled into one download. This template pulls virtualzone/docker-container-stats, which Docker fetches once (about 172 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Docker Container Stats's comes from Docker Hub, published by virtualzone.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8383:8080 means it's reachable on port 8383 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8383 in a browser. It opens:

  • 8383:8080, likely the web interface

Volumes

A volume is where Docker Container Stats keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/run/docker.sock from /var/run/docker.sock on the host (a socket it talks to, not storage)
  • /opt/docker-stats/db from /portainer/Files/AppData/Config/docker-stats/db on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Docker Container Stats takes 1 of them, all with defaults you can leave alone or tweak:

  • STATS_UPDATE_INTERVAL, defaults to 10

Networking

Nothing custom is set, so Docker Container Stats sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container stats. That's what you'll spot in the containers list and use in commands like docker logs stats.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Docker Container Stats up. Add the template list to Portainer once, then deploying Docker Container Stats is a click rather than a wall of config.