docker.report

docker.report

Generates a report containing the available Docker data. This command combines the docker.images, docker.containers, and docker.stats output. By default it will return a full report.

JSON-RPC Request

{"jsonrpc":"2.0","id":1,"method":"docker.report","params":{"includes":["value1","value2"]}}

Request Parameters

ParameterTypeDescription
includesStringThe details to include in the report. Accepted values are images, containers, stats, and all. You can specify multiple values, separated by a comma. If no value is specified, all reports are included.

JSON-RPC Response

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": [
    {
      "name": "images",
      "content": [
        {
          "Containers": "N/A",
          "CreatedAt": "2024-07-17 19:31:14 -0400 EDT",
          "CreatedSince": "10 months ago",
          "Digest": "<none>",
          "ID": "e376bb7e6bde",
          "Repository": "httpd",
          "SharedSize": "N/A",
          "Size": "148MB",
          "Tag": "latest",
          "UniqueSize": "N/A",
          "VirtualSize": "148.2MB"
        }
      ]
    },
    {
      "name": "containers",
      "content": [
        {
          "Command": "\"httpd-foreground\"",
          "CreatedAt": "2025-05-30 05:49:33 -0400 EDT",
          "ID": "a3d2a6633149",
          "Image": "httpd:latest",
          "Labels": "pcs_env_file_md5=c2e3945989ec4f558a253364acee67b3",
          "LocalVolumes": "0",
          "Mounts": "/docker/shared,/docker/httpd-",
          "Names": "docker-container-httpd-resource",
          "Networks": "customnetwork",
          "Ports": "80/tcp",
          "RunningFor": "12 days ago",
          "Size": "0B",
          "Status": "Up 12 days",
          "cluster_managed": false
        }
      ]
    },
    {
      "name": "stats",
      "content": [
        {
          "Name": "docker-container-httpd-resource",
          "Container": "a3d2a6633149",
          "ID": "a3d2a66331493d6067ca84c9c49d711bd1fc433e7a5ba1707171b14d4b6154ee",
          "CPUPerc": "0.00%",
          "MemPerc": "0.00%",
          "MemUsage": "0B / 0B",
          "BlockIO": "15.9MB / 0B",
          "NetIO": "0B / 0B",
          "PIDs": "0",
          "cluster_managed": false
        }
      ]
    }
  ]
}

CLI Example #1

This example returns the full report, including Docker images, containers, and stats.

rvc docker report

Response


Report: Images
==============
 Id           Repository                                        Tag                      Size      Virtual Size   Created Since       
--------------------------------------------------------------------------------------------------------------------------------------
 9592f5595f2b nginx                                             latest                   192MB     192.2MB        2 months ago          
Report: Containers
==================
 Id           Image                                    Names                                    Status         In Cluster  
---------------------------------------------------------------------------------------------------------------------------
 64ee8b437bc5 nginx                                    nginx                                    Up 3 days      no
Report: Stats
=============
 Id           Name                                        CPU%  Memory%  NetIO             PIDs        In Cluster  
-------------------------------------------------------------------------------------------------------------------
 64ee8b437bc5 nginx                                      0.00%    0.00%  0B / 0B           0           no

CLI Example #2

This example returns a partial report, including Docker containers and stats only.

rvc docker report --includes containers,stats

Response

Report: Containers
==================

 ID            Image                                     Names                                     Status                In Cluster
------------------------------------------------------------------------------------------------------------------------------------------
 5d90490f048d  reliantservices/dnsmasq:2.0                docker-container-dnsmasq-resource         Up 12 days (healthy)  yes
 b9d0288c2ccb  reliantservices/openssh-server:1.0.2      docker-container-openssh-server-resource  Up 12 days            yes
 65240b29dfd6  reliantservices/datasync:1.0.2            datasync                                  Up 13 days (healthy)  no

Report: Stats
=============

 Id            Name                                       CPU%  Memory%  NetIO           PIDs  In Cluster
---------------------------------------------------------------------------------------------------------
 5d90490f048d  docker-container-dnsmasq-resource         0.00%    0.01%  29.4MB / 126B      7  yes
 b9d0288c2ccb  docker-container-openssh-server-resource  0.00%    0.02%  8.01MB / 0B       13  yes
 65240b29dfd6  datasync                                  0.00%    0.20%  124MB / 62.9MB     3  no